Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jonasgessner/jgprogresshud

An elegant and simple progress HUD for iOS and tvOS, compatible with Swift and ObjC.
https://github.com/jonasgessner/jgprogresshud

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

Last synced: 29 days ago
JSON representation

An elegant and simple progress HUD for iOS and tvOS, compatible with Swift and ObjC.

Host: GitHub
URL: https://github.com/jonasgessner/jgprogresshud
Owner: JonasGessner
License: mit
Created: 2014-07-20T16:40:19.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2023-10-18T01:21:10.000Z (about 1 year ago)
Last Synced: 2024-10-14T21:20:43.761Z (29 days ago)
Topics: carthage, cocoapods, hud, ios, objective-c, progress-hud, swift, tvos
Language: Objective-C
Homepage:
Size: 18.3 MB
Stars: 3,353
Watchers: 55
Forks: 336
Open Issues: 4
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt

Awesome Lists containing this project

README

        JGProgressHUD

---------------

An elegant and simple progress HUD for iOS and tvOS. **Supports Swift and Objective-C!**








Overview

---------------

__The ultimate progress HUD for iOS and tvOS is here: JGProgressHUD!__

- Plug and play: Simple integration, easy to use, few lines of code required.

- Easily customizable (custom animations, indicator views and more).

- Uses `UIVisualEffectView` and `UIMotionEffect` for a native look.

- Uses AutoLayout to provide a fully dynamic layout.

- Detects and repositions when keyboard appears/disappears.

- Dark mode support — automatically changes appearance.

- Well documented and maintained.

- Voice Over/`UIAccessibility` support.

- Backward compatibility to iOS 8.

- Can be used with Swift and Objective-C.

- And most importantly, it looks good!

Download the source code and open the Examples project to try JGProgressHUD and see all of its features in action!

JGProgressHUD can also be used with SwiftUI. See [JGProgressHUD-SwiftUI](https://github.com/JonasGessner/JGProgressHUD-SwiftUI).

[![GitHub license](https://img.shields.io/github/license/JonasGessner/JGProgressHUD.svg)](https://github.com/JonasGessner/JGProgressHUD/blob/master/LICENSE.txt)

[![CocoaPods](https://img.shields.io/cocoapods/v/JGProgressHUD.svg)](https://cocoapods.org/pods/JGProgressHUD)

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

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

Examples

--------------





           





#### Showing indeterminate progress:

Objective-C:

```objc

JGProgressHUD *HUD = [[JGProgressHUD alloc] init];

HUD.textLabel.text = @"Loading";

[HUD showInView:self.view];

[HUD dismissAfterDelay:3.0];

```

Swift:

```swift

let hud = JGProgressHUD()

hud.textLabel.text = "Loading"

hud.show(in: self.view)

hud.dismiss(afterDelay: 3.0)

```

This displays a dark HUD with an activity indicator and the title "Loading". The HUD is presented with a fade animation and is dismissed after 3 seconds with a fade animation.

#### Showing an error message:

```objc

JGProgressHUD *HUD = [[JGProgressHUD alloc] init];

HUD.textLabel.text = @"Error";

HUD.indicatorView = [[JGProgressHUDErrorIndicatorView alloc] init]; //JGProgressHUDSuccessIndicatorView is also available

[HUD showInView:self.view];

[HUD dismissAfterDelay:3.0];

```

#### Showing determinate progress:

```objc

JGProgressHUD *HUD = [[JGProgressHUD alloc] init];

HUD.indicatorView = [[JGProgressHUDPieIndicatorView alloc] init]; //Or JGProgressHUDRingIndicatorView

HUD.progress = 0.5f;

[HUD showInView:self.view];

[HUD dismissAfterDelay:3.0];

```

__For more examples, including in Swift, see Examples.__

__Important:__ You should always show `JGProgressHUD` in a `UIViewController` view.

Customization

-----------

### Styles:

JGProgressHUD can be displayed in 3 styles:

- __Extra Light__

- __Light__

- __Dark__

The style can also be set automatically according to the current `UITraitCollection` (dark mode). Use the initializer `[[JGProgressHUD alloc] init]`/`JGProgressHUD()` to take advantage of the automatic style.

### Indicator Views:

By default a HUD will display an indeterminate progress indicator. The indicator view can be completely hidden by setting the `indicatorView` property to `nil`. These indicator views are available by default:

- __Indeterminate progress indicator__

- __Pie progress indicator__

- __Ring progress indicator__

- __Success indicator__

- __Error indicator__

- __Image indicator__

Custom indicator views can be created by subclassing `JGProgressHUDIndicatorView`.


### Animations:

By default a HUD will use a fade animation. Several parameters can be altered such as animation duration or animation curve. A HUD can be displayed without animation and different animations can be used. These animations are available by default:

- __Fade__

- __Zoom and Fade__

Custom animations can be created by subclassing `JGProgressHUDAnimation`.

To dim the content behind the HUD set your dim color as `backgroundColor` of your `JGProgressHUD` instance.

Installation

--------------

### Swift Package Manager:

In Xcode, use the menu File > Swift Packages > Add Package Dependency... and enter the package URL `https://github.com/JonasGessner/JGProgressHUD.git`.

This is the recommended way of installing JGProgressHUD.

### Carthage:

In your `Cartfile` add:

```

github "JonasGessner/JGProgressHUD"

```

### CocoaPods:

In your `Podfile` add:

```

pod 'JGProgressHUD'

```

### Manual Installation:

1. Drag the `JGProgressHUD.xcodeproj` file into your Xcode project.

2. Add `JGProgressHUD.framework` to "Embedded Binaries" in the "General" tab of your target.

-------

After installing import the module where you want to use it:

```objc

@import JGProgressHUD;

```

Swift:

```swift

import JGProgressHUD

```

See the Examples project for an example implementation of JGProgressHUD as framework.

Requirements

------------

- Base SDK of iOS/tvOS/macCatalyst 13.0 or higher.

- Deployment target of iOS 8.0, tvOS 9.0, macCatalyst 13.0, or higher.

JGProgressHUD can also be used by projects written in Swift. See Installation for details.

Documentation

----------------

Detailed documentation can be found on here.



Each class and method is well documented, making it easy to quickly get a good overview. To start, see JGProgressHUD.h.

License

---------

MIT License.


© 2014-2020, Jonas Gessner.

Credits

----------

Created and maintained by Jonas Gessner, © 2014-2020.