Skip to content

babbawg/BTProgressHUD

 
 

Repository files navigation

BTProgressHUD

Port to MonoTouch of the SVProgressHUD.

SVProgressHUD (and BTProgressHUD) is a clean and easy-to-use HUD meant to display the progress of an ongoing task.

SVProgressHUD

(Image from SVProgressHUD)

This is also available in the Xamarin Component Store.

##Installation

  • Grab BTProgressHUD.cs, add it to your project.
  • Use it :)

##TODO

  • The progress HUD is not Accessability-aware, which would be very good to add. The ObjC code for this is still in the project, just commented out.

##Usage

Have a look at the BTProgressHUDDemo project.

There are a few main static methods, however:

BTProgressHUD.Show(); //shows the spinner
BTProgressHUD.Show(status: "Oh hai"); //show spinner + text
BTProgressHUD.ShowSuccessWithStatus("Wow, that worked"); //A big TICK with text
BTProgressHUD.ShowErrorWithStatus("Fail!"); //A big CROSS with text
BTProgressHUD.ShowToast("Hello from Toast"); //show an Android-style toast

All of these can be dismissed with

BTProgressHUD.Dismiss();

BTProgressHUD is aware of the thread you are calling from, and ensures that HUDs are always manipulated from the UI thread.

###Other Show options

You can call Show with the following parameters

  • status: - show status text
  • progress: - show a progress circle with 0.0 - 1.0 of progress. Call again to change the progress.
  • maskType: <BTProgressHUD.MaskType> - show with the background (the whole window) clear, black or gradient. Default is none, which allows interaction with the underlying elements.
public enum MaskType
{
	None = 1, // allow user interactions, don't dim background UI (default)
	Clear, // disable user interactions, don't dim background UI
	Black, // disable user interactions, dim background UI with 50% translucent black
	Gradient // disable user interactions, dim background UI with translucent radial gradient (a-la-alertView)
}

###ShowToast The toast can be centered or at the bottom of the screen, like Android. This is controlled by the second parameter.

BTProgressHUD.ShowToast("foo", showToastCentered: false);

###ShowSuccess/Error/ShowImage This method dismisses the activity after 1 second. You can provide your own images if needed - make them 28x28 white PNGs.

BTProgressHUD.ShowSuccessWithStatus("Wow, that worked"); //A big TICK with text
BTProgressHUD.ShowErrorWithStatus("Fail!"); //A big CROSS with text
BTProgressHUD.ShowImage(UIImage.FromFile(), "Nice one Stu!");

You can use the timeout parameter of ShowImage to control the time before it's dismissed.

Credits

SVProgressHUD is brought to you by Sam Vermette and contributors to the project. The success and error icons are from Glyphish. If you have feature suggestions or bug reports, feel free to help out by sending pull requests or by creating new issues. If you're using SVProgressHUD in your project, attribution would be nice.

BTProgressHUD is brought to you by Nic Wise. I'm also happy to take bug reports and pull requests for the MonoTouch version. If you use BTProgressHUD in your project, attribution would also be nice - or tweet me a link to your project when it's live.

Thanks to mloenow and Ramesh Sringeri for the updates / fixes.

About

Port to MonoTouch of the SVProgressHUD

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published