WHAT'S NEW
Version: 13.7.2
- The
showFailed
andshowError
methods can now handleError?
parameters as well. - SF Symbols can be displayed by defining it's name
ProgressHUD.show(symbol: "car.fill")
- Fix the
setupDelayTimer
method. Now[weak self]
is used within the timer's closure to prevent potential retain cycles and avoid memory leaks.
Version: 13.7.1
- The
mediaSize
andmarginSize
options are now available to adjust the HUD dimensions.
Version: 13.7.0
- New
AnimationType.none
has been implemented. So you can display some text without animation.
Version: 13.6.2
- We have the optional
delay:
parameter to set the timeout. - We have the
.remove()
function to dismiss the HUD immediately.
Version: 13.5 and 13.6
- Bugfix related to iPad split screen.
- Bugfix related to showProgress.
OVERVIEW
ProgressHUD is a lightweight and easy-to-use HUD for iOS.
INSTALLATION
CocoaPods
CocoaPods is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate the ProgressHUD
into your Xcode project using CocoaPods, specify it in your Podfile
:
pod 'ProgressHUD'
Manually
If you prefer not to use any of the dependency managers, you can integrate ProgressHUD
into your project manually. Just copy the ProgressHUD.swift
file in your Xcode project.
QUICK START
ProgressHUD.show("Some text...")
ProgressHUD.show("Some text...", interaction: false)
ProgressHUD.showSucceed()
ProgressHUD.showSucceed("Some text...", delay: 1.5)
ProgressHUD.showFailed()
ProgressHUD.showFailed("Some text...")
ProgressHUD.showProgress(0.15)
ProgressHUD.showProgress("Loading...", 0.42)
ProgressHUD.show(icon: .heart)
ProgressHUD.show("Some text...", icon: .privacy, delay: 2.0)
ProgressHUD.show(symbol: "box.truck")
ProgressHUD.show("Some text...", symbol: "figure.2.arms.open")
ProgressHUD.dismiss()
ProgressHUD.remove()
REQUIREMENTS
- iOS 13.0+
CUSTOMIZATION
You can customize attributes like color, font, image, animation type, size, and more by using these methods:
ProgressHUD.animationType = .circleStrokeSpin
ProgressHUD.colorHUD = .systemGray
ProgressHUD.colorBackground = .lightGray
ProgressHUD.colorAnimation = .systemBlue
ProgressHUD.colorProgress = .systemBlue
ProgressHUD.colorStatus = .label
ProgressHUD.mediaSize = 100
ProgressHUD.marginSize = 50
ProgressHUD.fontStatus = .boldSystemFont(ofSize: 24)
ProgressHUD.imageSuccess = UIImage(named: "success.png")
ProgressHUD.imageError = UIImage(named: "error.png")
A comprehensive list of the predefined animation and icon types:
public enum AnimationType {
case none
case systemActivityIndicator
case horizontalCirclesPulse
case lineScaling
case singleCirclePulse
case multipleCirclePulse
case singleCircleScaleRipple
case multipleCircleScaleRipple
case circleSpinFade
case lineSpinFade
case circleRotateChase
case circleStrokeSpin
}
public enum AnimatedIcon {
case succeed
case failed
case added
}
public enum AlertIcon {
case heart
case doc
case bookmark
case moon
case star
case exclamation
case flag
case message
case question
case bolt
case shuffle
case eject
case card
case rotate
case like
case dislike
case privacy
case cart
case search
}
LICENSE
MIT License
Copyright (c) 2023 Related Code
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.