Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/relatedcode/progresshud
ProgressHUD is a lightweight and easy-to-use HUD for iOS. Over 5000+ animations. ‼️
https://github.com/relatedcode/progresshud
activity-indicator apple hud ios-swift progress progress-bar progress-circle progress-hud progress-indicator progress-indicators progress-ring progress-tracker progress-view progressbar progresshud swift-library swift5
Last synced: 29 days ago
JSON representation
ProgressHUD is a lightweight and easy-to-use HUD for iOS. Over 5000+ animations. ‼️
- Host: GitHub
- URL: https://github.com/relatedcode/progresshud
- Owner: relatedcode
- License: mit
- Created: 2013-10-09T14:25:30.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-09-30T08:25:32.000Z (about 1 month ago)
- Last Synced: 2024-10-14T21:32:06.394Z (29 days ago)
- Topics: activity-indicator, apple, hud, ios-swift, progress, progress-bar, progress-circle, progress-hud, progress-indicator, progress-indicators, progress-ring, progress-tracker, progress-view, progressbar, progresshud, swift-library, swift5
- Language: Swift
- Homepage: https://relatedcode.com
- Size: 4.72 MB
- Stars: 2,793
- Watchers: 55
- Forks: 457
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## WHAT'S NEW
For detailed changes, please refer to the [Change log](CHANGELOG.md).
## OVERVIEW
**ProgressHUD** is a convenient and intuitive HUD tool designed specifically for iOS. It enables seamless presentation of concise alerts or notifications to users of your app in a simple and non-disruptive way.
## INSTALLATION
‼️ In case you're using Xcode 14.3.1 or an earlier version, stick with [13.8.6](https://github.com/relatedcode/ProgressHUD/releases/tag/13.8.6) ‼️
### CocoaPods
[CocoaPods](https://cocoapods.org) is a dependency manager for Swift and Objective-C Cocoa projects.
To incorporate the **ProgressHUD** library into your Xcode project utilizing CocoaPods, please reference it within your `Podfile` as shown below:
```ruby
pod 'ProgressHUD'
```
### Swift Package Manager
[Swift Package Manager](https://swift.org/package-manager) is a tool for managing the distribution of Swift code.
To add **ProgressHUD** as a dependency to your project, follow these steps:
1. Open your Swift project in Xcode.
2. Navigate to `File` -> `Add Package Dependencies...`.
3. Paste `https://github.com/relatedcode/ProgressHUD.git` into the search bar.
4. Choose the version you want to use and click `Add Package`.
### Manually
If you prefer not to use any of the dependency managers above, you can integrate **ProgressHUD** into your project manually. Just copy all the `*.swift` files from the `ProgressHUD/Sources` folder into your Xcode project.
## QUICK START
```swift
ProgressHUD.banner("Banner title", "Banner message to display.")
```
```swift
ProgressHUD.banner("Banner title", "Message to display.", delay: 2.0)
```
```swift
ProgressHUD.bannerHide()
```
```swift
ProgressHUD.animate("Some text...")
```
```swift
ProgressHUD.animate("Some text...", interaction: false)
```
```swift
ProgressHUD.animate("Please wait...", .ballVerticalBounce)
```
```swift
ProgressHUD.succeed()
```
```swift
ProgressHUD.succeed("Some text...", delay: 1.5)
```
```swift
ProgressHUD.failed()
```
```swift
ProgressHUD.failed("Some text...")
```
```swift
ProgressHUD.progress(0.15)
```
```swift
ProgressHUD.progress("Loading...", 0.42)
```
```swift
ProgressHUD.symbol(name: "box.truck")
```
```swift
ProgressHUD.symbol("Some text...", name: "sun.max")
```
```swift
ProgressHUD.dismiss()
```
```swift
ProgressHUD.remove()
```
## REQUIREMENTS
- iOS 13.0+
- Xcode 15.0+
## CUSTOMIZATION
You can customize attributes like color, font, image, animation type, size, and more by using these methods:
```swift
ProgressHUD.animationType = .circleStrokeSpin
```
```swift
ProgressHUD.colorHUD = .systemGray
```
```swift
ProgressHUD.colorBackground = .lightGray
```
```swift
ProgressHUD.colorAnimation = .systemBlue
```
```swift
ProgressHUD.colorProgress = .systemBlue
```
```swift
ProgressHUD.colorStatus = .label
```
```swift
ProgressHUD.mediaSize = 100
ProgressHUD.marginSize = 50
```
```swift
ProgressHUD.fontStatus = .boldSystemFont(ofSize: 24)
```
```swift
ProgressHUD.imageSuccess = UIImage(named: "success.png")
ProgressHUD.imageError = UIImage(named: "error.png")
```
A comprehensive list of the predefined enums:
```swift
public enum AnimationType: CaseIterable {
case none
case activityIndicator
case ballVerticalBounce
case barSweepToggle
case circleArcDotSpin
case circleBarSpinFade
case circleDotSpinFade
case circlePulseMultiple
case circlePulseSingle
case circleRippleMultiple
case circleRippleSingle
case circleRotateChase
case circleStrokeSpin
case dualDotSidestep
case horizontalBarScaling
case horizontalDotScaling
case pacmanProgress
case quintupleDotDance
case semiRingRotation
case sfSymbolBounce
case squareCircuitSnake
case triangleDotShift
}
```
```swift
public enum LiveIcon {
case succeed
case failed
case added
}
```
## LICENSE
MIT License
Copyright (c) 2024 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.