SVProgressHUD
is a clean and easy-to-use HUD meant to display the progress of an ongoing task on iOS and tvOS.
Try SVProgressHUD
on Appetize.io.
CocoaPods is a dependency manager for Objective-C, which automates and simplifies the process of using 3rd-party libraries like SVProgressHUD
in your projects. First, add the following line to your Podfile:
pod 'SVProgressHUD'
If you want to use the latest features of SVProgressHUD
use normal external source dependencies.
pod 'SVProgressHUD', :git => 'https://github.com/SVProgressHUD/SVProgressHUD.git'
This pulls from the master
branch directly. We are usually careful about what we push there and this is the version we use ourselves in all of our projects.
Second, install SVProgressHUD
into your project:
pod install
Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
You can install Carthage with Homebrew using the following command:
$ brew update
$ brew install carthage
To integrate SVProgressHUD
into your Xcode project using Carthage, specify it in your Cartfile
:
github "SVProgressHUD/SVProgressHUD"
Run carthage update
to build the framework and drag the built SVProgressHUD.framework
(in Carthage/Build/iOS folder) into your Xcode project (Linked Frameworks and Libraries in Targets
).
- Drag the
SVProgressHUD/SVProgressHUD
folder into your project. - Take care that
SVProgressHUD.bundle
is added toTargets->Build Phases->Copy Bundle Resources
. - Add the QuartzCore framework to your project.
(see sample Xcode project in /Demo
)
SVProgressHUD
is created as a singleton (i.e. it doesn't need to be explicitly allocated and instantiated; you directly call [SVProgressHUD method]
).
Use SVProgressHUD
wisely! Only use it if you absolutely need to perform a task before taking the user forward. Bad use case examples: pull to refresh, infinite scrolling, sending message.
Using SVProgressHUD
in your app will usually look as simple as this (using Grand Central Dispatch):
[SVProgressHUD show];
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
// time-consuming task
dispatch_async(dispatch_get_main_queue(), ^{
[SVProgressHUD dismiss];
});
});
You can show the status of indeterminate tasks using one of the following:
+ (void)show;
+ (void)showWithStatus:(NSString*)string;
If you'd like the HUD to reflect the progress of a task, use one of these:
+ (void)showProgress:(CGFloat)progress;
+ (void)showProgress:(CGFloat)progress status:(NSString*)status;
The HUD can be dismissed using:
+ (void)dismiss;
+ (void)dismissWithDelay:(NSTimeInterval)delay;
If you'd like to stack HUDs, you can balance out every show call using:
+ (void)popActivity;
The HUD will get dismissed once the popActivity
calls will match the number of show calls.
Or show a confirmation glyph before before getting dismissed a little bit later. The display time depends on the length of the given string (between 0.5 and 5 seconds).
+ (void)showInfoWithStatus:(NSString *)string;
+ (void)showSuccessWithStatus:(NSString*)string;
+ (void)showErrorWithStatus:(NSString *)string;
+ (void)showImage:(UIImage*)image status:(NSString*)string;
SVProgressHUD
can be customized via the following methods:
+ (void)setDefaultStyle:(SVProgressHUDStyle)style; // default is SVProgressHUDStyleLight
+ (void)setDefaultMaskType:(SVProgressHUDMaskType)maskType; // default is SVProgressHUDMaskTypeNone
+ (void)setDefaultAnimationType:(SVProgressHUDAnimationType)type; // default is SVProgressHUDAnimationTypeFlat
+ (void)setMinimumSize:(CGSize)minimumSize; // default is CGSizeZero, can be used to avoid resizing for a larger message
+ (void)setRingThickness:(CGFloat)width; // default is 2 pt
+ (void)setRingRadius:(CGFloat)radius; // default is 18 pt
+ (void)setRingNoTextRadius:(CGFloat)radius; // default is 24 pt
+ (void)setCornerRadius:(CGFloat)cornerRadius; // default is 14 pt
+ (void)setFont:(UIFont*)font; // default is [UIFont preferredFontForTextStyle:UIFontTextStyleSubheadline]
+ (void)setForegroundColor:(UIColor*)color; // default is [UIColor blackColor], only used for SVProgressHUDStyleCustom
+ (void)setBackgroundColor:(UIColor*)color; // default is [UIColor whiteColor], only used for SVProgressHUDStyleCustom
+ (void)setInfoImage:(UIImage*)image; // default is the bundled info image provided by Freepik
+ (void)setSuccessImage:(UIImage*)image; // default is bundled success image from Freepik
+ (void)setErrorImage:(UIImage*)image; // default is bundled error image from Freepik
+ (void)setViewForExtension:(UIView*)view; // default is nil, only used if #define SV_APP_EXTENSIONS is set
+ (void)setMinimumDismissTimeInterval:(NSTimeInterval)interval; // default is 5.0 seconds
Additionally SVProgressHUD
supports the UIAppearance
protocol for most of the above methods.
As standard SVProgressHUD
offers two preconfigured styles:
SVProgressHUDStyleLight
: White background with black spinner and textSVProgressHUDStyleDark
: Black background with white spinner and text
If you want to use custom colors with setForegroundColor
and setBackgroundColor:
don't forget to set SVProgressHUDStyleCustom
via setDefaultStyle:
.
SVProgressHUD
posts four notifications via NSNotificationCenter
in response to being shown/dismissed:
SVProgressHUDWillAppearNotification
when the show animation startsSVProgressHUDDidAppearNotification
when the show animation completesSVProgressHUDWillDisappearNotification
when the dismiss animation startsSVProgressHUDDidDisappearNotification
when the dismiss animation completes
Each notification passes a userInfo
dictionary holding the HUD's status string (if any), retrievable via SVProgressHUDStatusUserInfoKey
.
SVProgressHUD
also posts SVProgressHUDDidReceiveTouchEventNotification
when users touch on the overall screen or SVProgressHUDDidTouchDownInsideNotification
when a user touches on the HUD directly. For this notifications userInfo
is not passed but the object parameter contains the UIEvent
that related to the touch.
When using SVProgressHUD
in an App Extension, #define SV_APP_EXTENSIONS
to avoid using unavailable APIs. Additionally call setViewForExtension:
from your extensions view controller with self.view
.
If you have feature requests or bug reports, feel free to help out by sending pull requests or by creating new issues. Please take a moment to review the guidelines written by Nicolas Gallagher:
SVProgressHUD
is distributed under the terms and conditions of the MIT license. The success, error and info icons are made by Freepik from Flaticon and are licensed under Creative Commons BY 3.0.
SVProgressHUD
is brought to you by Sam Vermette, Tobias Tiemerding and contributors to the project. If you're using SVProgressHUD
in your project, attribution would be very appreciated.