- April 27, 2024
- Mins Read
MBProgressHUD
is an iOS drop-in class that displays a translucent HUD with an indicator and/or labels while work is being done in a background thread. The HUD is meant as a replacement for the undocumented, private UIKit
UIProgressHUD
with some additional features.
MBProgressHUD
works on iOS 9.0+. It depends on the following Apple frameworks, which should already be included with most Xcode templates:
You will need the latest developer tools in order to build MBProgressHUD
. Old Xcode versions might work, but compatibility will not be explicitly maintained.
CocoaPods is the recommended way to add MBProgressHUD to your project.
pod 'MBProgressHUD', '~> 1.2.0'
pod install
.#import "MBProgressHUD.h"
.github "jdg/MBProgressHUD" ~> 1.2.0
carthage update
Package.swift
.package(url: “https://github.com/jdg/MBProgressHUD.git”, .upToNextMajor(from: “1.2.0”)),
2. Next, add MBProgressHUD
to your App targets dependencies like so:
.target(name: “App”, dependencies: [“MBProgressHUD”]),
3. Then open your project in Xcode 11+ (SwiftPM) or run accio update
(Accio).
Alternatively you can directly add the MBProgressHUD.h
and MBProgressHUD.m
source files to your project.
MBProgressHUD.h
and MBProgressHUD.m
onto your project (use the “Product Navigator view”). Make sure to select Copy items when asked if you extracted the code archive outside of your project.#import "MBProgressHUD.h"
.You can also add MBProgressHUD as a static library to your project or workspace.
MBProgressHUD.xcodeproj
onto your project or workspace (use the “Product Navigator view”).libMBProgressHUD.a
. You might also need to add MBProgressHUD
to the Target Dependencies list.#import <MBProgressHUD/MBProgressHUD.h>
.The main guideline you need to follow when dealing with MBProgressHUD while running long-running tasks is keeping the main thread work-free, so the UI can be updated promptly. The recommended way of using MBProgressHUD is therefore to set it up on the main thread and then spinning the task, that you want to perform, off onto a new thread.
[MBProgressHUD showHUDAddedTo:self.view animated:YES];
dispatch_async(dispatch_get_global_queue( DISPATCH_QUEUE_PRIORITY_LOW, 0), ^{
// Do something…
dispatch_async(dispatch_get_main_queue(), ^{
[MBProgressHUD hideHUDForView:self.view animated:YES];
});
});
You can add the HUD on any view or window. It is however a good idea to avoid adding the HUD to certain UIKit
views with complex view hierarchies – like UITableView
or UICollectionView
. Those can mutate their subviews in unexpected ways and thereby break HUD display.
If you need to configure the HUD you can do this by using the MBProgressHUD reference that showHUDAddedTo:animated: returns.
MBProgressHUD *hud = [MBProgressHUD showHUDAddedTo:self.view animated:YES];
hud.mode = MBProgressHUDModeAnnularDeterminate;
hud.label.text = @”Loading”;
[self doSomethingInBackgroundWithProgressCallback:^(float progress) {
hud.progress = progress;
} completionCallback:^{
[hud hideAnimated:YES];
}];
You can also use a NSProgress
object and MBProgressHUD will update itself when there is progress reported through that object.
MBProgressHUD *hud = [MBProgressHUD showHUDAddedTo:self.view animated:YES];
hud.mode = MBProgressHUDModeAnnularDeterminate;
hud.label.text = @”Loading”;
NSProgress *progress = [self doSomethingInBackgroundCompletion:^{
[hud hideAnimated:YES];
}];
hud.progressObject = progress;
Keep in mind that UI updates, including calls to MBProgressHUD should always be done on the main thread.
If you need to run your long-running task in the main thread, you should perform it with a slight delay, so UIKit will have enough time to update the UI (i.e., draw the HUD) before you block the main thread with your task.
[MBProgressHUD showHUDAddedTo:self.view animated:YES];
dispatch_time_t popTime = dispatch_time(DISPATCH_TIME_NOW, 0.01 * NSEC_PER_SEC);
dispatch_after(popTime, dispatch_get_main_queue(), ^(void){
// Do something…
[MBProgressHUD hideHUDForView:self.view animated:YES];
});
You should be aware that any HUD updates issued inside the above block won’t be displayed until the block completes.
For more examples, including how to use MBProgressHUD with asynchronous operations such as NSURLConnection, take a look at the bundled demo project. Extensive API documentation is provided in the header file (MBProgressHUD.h).
Horizon SDK is a state of the art real-time video recording / photo shooting iOS library. Some of the features ...