Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/SVProgressHUD/SVProgressHUD

A clean and lightweight progress HUD for your iOS and tvOS app.
https://github.com/SVProgressHUD/SVProgressHUD

apple carthage cocoapods hud ios objective-c progress svprogresshud swift tvos

Last synced: about 2 months ago
JSON representation

A clean and lightweight progress HUD for your iOS and tvOS app.

Lists

README 

        
# SVProgressHUD



![Pod Version](https://img.shields.io/cocoapods/v/SVProgressHUD.svg?style=flat)

![Pod Platform](https://img.shields.io/cocoapods/p/SVProgressHUD.svg?style=flat)

![Pod License](https://img.shields.io/cocoapods/l/SVProgressHUD.svg?style=flat)

[![SwiftPM compatible](https://img.shields.io/badge/SwiftPM-compatible-brightgreen.svg)](https://swift.org/package-manager/)

[![CocoaPods compatible](https://img.shields.io/badge/CocoaPods-compatible-green.svg?style=flat)](https://cocoapods.org)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-green.svg?style=flat)](https://github.com/Carthage/Carthage)



`SVProgressHUD` is a clean and easy-to-use HUD meant to display the progress of an ongoing task on iOS and tvOS.



![SVProgressHUD](https://raw.githubusercontent.com/SVProgressHUD/SVProgressHUD/master/Images/SVProgressHUD.png)



## Installation



### Swift Package Manager



[Swift Package Manager](https://swift.org/package-manager/) (SwiftPM) is a tool for managing the distribution of Swift code. It simplifies the process of managing Swift package dependencies.



To integrate `SVProgressHUD` into your project using SwiftPM:



1. In Xcode, select **File > Add Package Dependency**.

2. Enter the following package repository URL: https://github.com/SVProgressHUD/SVProgressHUD.git

3. Choose the appropriate version (e.g. a specific version, branch, or commit).

4. Add `SVProgressHUD` to your target dependencies.



`SVProgressHUD` requires at least Swift tools version 5.3.



### From CocoaPods



[CocoaPods](http://cocoapods.org) 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](http://guides.cocoapods.org/using/using-cocoapods.html):



```ruby

pod 'SVProgressHUD'

```



If you want to use the latest features of `SVProgressHUD` use normal external source dependencies.



```ruby

pod 'SVProgressHUD', :git => 'https://github.com/SVProgressHUD/SVProgressHUD.git'

```



This pulls from the `master` branch directly.



Second, install `SVProgressHUD` into your project:



```ruby

pod install

```



### Carthage



[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate `SVProgressHUD` into your Xcode project using Carthage, specify it in your `Cartfile`:



```ogdl

github "SVProgressHUD/SVProgressHUD"

```



Run `carthage bootstrap` to build the framework in your repository's Carthage directory. You can then include it in your target's `carthage copy-frameworks` build phase. For more information on this, please see [Carthage's documentation](https://github.com/carthage/carthage#if-youre-building-for-ios-tvos-or-watchos).



### Manually



* Drag the `SVProgressHUD/SVProgressHUD` folder into your project.

* Take care that `SVProgressHUD.bundle` is added to `Targets->Build Phases->Copy Bundle Resources`.

* Add the **QuartzCore** framework to your project.



## Swift



Even though `SVProgressHUD` is written in Objective-C, it can be used in Swift with no hassle.



If you use [CocoaPods](http://cocoapods.org) add the following line to your [Podfile](http://guides.cocoapods.org/using/using-cocoapods.html):



```ruby

use_frameworks!

```



If you added `SVProgressHUD` manually, just add a [bridging header](https://developer.apple.com/library/content/documentation/Swift/Conceptual/BuildingCocoaApps/MixandMatch.html) file to your project with the `SVProgressHUD` header included.



## Usage



(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]` / `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.



**Objective-C:**



```objective-c

[SVProgressHUD show];

dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{

    // time-consuming task

    dispatch_async(dispatch_get_main_queue(), ^{

        [SVProgressHUD dismiss];

    });

});

```



**Swift:**



```swift

SVProgressHUD.show()

DispatchQueue.global(qos: .default).async {

    // time-consuming task

    DispatchQueue.main.async {

        SVProgressHUD.dismiss()

    }

}

```



### Showing the HUD



You can show the status of indeterminate tasks using one of the following:



```objective-c

+ (void)show;

+ (void)showWithStatus:(NSString*)string;

```



If you'd like the HUD to reflect the progress of a task, use one of these:



```objective-c

+ (void)showProgress:(CGFloat)progress;

+ (void)showProgress:(CGFloat)progress status:(NSString*)status;

```



### Dismissing the HUD



The HUD can be dismissed using:



```objective-c

+ (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 an image with status before getting dismissed a little bit later. The display time depends on `minimumDismissTimeInterval` and the length of the given string.



```objective-c

+ (void)showInfoWithStatus:(NSString*)string;

+ (void)showSuccessWithStatus:(NSString*)string;

+ (void)showErrorWithStatus:(NSString*)string;

+ (void)showImage:(UIImage*)image status:(NSString*)string;

```



## Customization



`SVProgressHUD` is designed with flexibility in mind, providing a myriad of customization options to fit the look and feel of your application seamlessly.



* Appearance: Make use of the `UI_APPEARANCE_SELECTOR` to adjust styles, colors, fonts, size, and images app-wide.

* Behavior: Control visibility durations, display delays, and animation speeds.

* Feedback: Enhance the user experience with options for haptic feedback and motion effects.



For a comprehensive list of properties and detailed explanations, refer to the `SVProgressHUD.h` file in the API documentation.



### Hint



As standard `SVProgressHUD` offers three preconfigured styles:



* `SVProgressHUDStyleAutomatic`: Automatically switch between the light and dark style

* `SVProgressHUDStyleLight`: White background with black spinner and text

* `SVProgressHUDStyleDark`: Black background with white spinner and text



If you want to use custom colors use `setForegroundColor:` and/or `setBackgroundColor:`. These implicitly set the HUD's style to `SVProgressHUDStyleCustom`.



## Haptic Feedback



Available on iPhone 7 and newer, `SVProgressHUD` can automatically trigger haptic feedback depending on which HUD is being displayed. The feedback maps as follows:



* `showSuccessWithStatus:` <-> `UINotificationFeedbackTypeSuccess`

* `showInfoWithStatus:` <-> `UINotificationFeedbackTypeWarning`

* `showErrorWithStatus:` <-> `UINotificationFeedbackTypeError`



To enable this functionality, use `setHapticsEnabled:`.



## Notifications



`SVProgressHUD` posts four notifications via `NSNotificationCenter` in response to being shown/dismissed:



* `SVProgressHUDWillAppearNotification` when the show animation starts

* `SVProgressHUDDidAppearNotification` when the show animation completes

* `SVProgressHUDWillDisappearNotification` when the dismiss animation starts

* `SVProgressHUDDidDisappearNotification` 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 these notifications `userInfo` is not passed but the object parameter contains the `UIEvent` that related to the touch.



## App Extensions



When using `SVProgressHUD` in an App Extension, `#define SV_APP_EXTENSIONS` to avoid using unavailable APIs. This will be done automatically when using the `AppExtension` CocoaPods subspec. Additionally, call `setViewForExtension:` from your extensions view controller with `self.view`.



## Contributing to this project



If you have feature requests or bug reports, feel free to help out by sending pull requests or by [creating new issues](https://github.com/SVProgressHUD/SVProgressHUD/issues/new). Please take a moment to

review the guidelines written by [Nicolas Gallagher](https://github.com/necolas):



* [Bug reports](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md#bugs)

* [Feature requests](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md#features)

* [Pull requests](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md#pull-requests)



## License



`SVProgressHUD` is distributed under the terms and conditions of the [MIT license](https://github.com/SVProgressHUD/SVProgressHUD/blob/master/LICENSE). The success, error and info icons used on iOS 12 are made by [Freepik](http://www.freepik.com) from [Flaticon](https://www.flaticon.com) and are licensed under [Creative Commons BY 3.0](https://creativecommons.org/licenses/by/3.0/).



## Privacy



`SVProgressHUD` does not collect any data. A [privacy manifest file](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files) is [provided](SVProgressHUD/PrivacyInfo.xcprivacy).



## Credits



`SVProgressHUD` is brought to you by Sam Vermette, [Tobias Totzek](https://totzek.me) and [contributors to the project](https://github.com/SVProgressHUD/SVProgressHUD/contributors). If you're using `SVProgressHUD` in your project, attribution would be very appreciated.