Skip to content

README.md

Latest commit

 

History

History
108 lines (81 loc) · 3.3 KB

README.md

File metadata and controls

108 lines (81 loc) · 3.3 KB

iStatusView

Example

To run the example app, open Example/iStatusView.xcodeproj in Xcode. The example target links the local iStatusView Swift package directly, so there is no CocoaPods setup step.

Requirements

iOS 14.0+

Installation

iStatusView is available through Swift Package Manager. Add the repository URL to your project:

https://github.com/NextFaze/iStatusView.git

Or declare it in Package.swift:

dependencies: [
    .package(url: "https://github.com/NextFaze/iStatusView.git", from: "0.4.0")
]

targets: [
    .target(
        name: "YourTarget",
        dependencies: ["iStatusView"]
    )
]

Loading Screen Shot Error Screen Shot

Integration

Step 1: Style the StatusView, using appearance proxy

StatusView.appearance().titleLabelTextColor = UIColor.black
StatusView.appearance().titleLabelFont = UIFont.boldSystemFont(ofSize: 18)

StatusView.appearance().messageLabelTextColor = UIColor(white: 0.2, alpha: 1.0)
StatusView.appearance().messageLabelFont = UIFont.systemFont(ofSize: 16)
StatusView.appearance().backgroundColor = UIColor.white

Step 2: Construct a loading view to display

Feel free to add in any loading indicator you fancy

An example using the UIActivityIndicator

let loadingView = UIActivityIndicatorView(style: .large)
loadingView.color = .black
loadingView.startAnimating()
loadingView.bounds = CGRect(x: 0, y: 0, width: 80, height: 80)

Step 3: Create the StatusView

Use the convenient create function, you must pass a loading view (even if its just a blank UIView, else nothing will work)

self.statusView = StatusView.create(with: loadingView, addTo: self.view)

Set the size using Auto Layout constraints to fill the whole view.

self.statusView.translatesAutoresizingMaskIntoConstraints = false
NSLayoutConstraint.activate([
    self.statusView.leadingAnchor.constraint(equalTo: self.view.leadingAnchor),
    self.statusView.trailingAnchor.constraint(equalTo: self.view.trailingAnchor),
    self.statusView.topAnchor.constraint(equalTo: self.view.topAnchor),
    self.statusView.bottomAnchor.constraint(equalTo: self.view.bottomAnchor),
])

Step 4 (Optional): Listen to button presses.

A button appears when a button image is set when setting the state Useful for a retry button, or cancel loading button

self.statusView.button.addTarget(self, action: #selector(statusViewButtonPressed), for: .touchUpInside)

Step 5: Show a state

state: what state the status view is in. loading will show the loading indicator, message will hide the loading indicator, hidden will hide the whole status view. title: optional; is the main title of the status. message: optional; is the more detailed message to be displayed. statusImage: optional; shows an image to be displayed buttonImage: optional; when an image is set, it will show as a pressable button

try? self.statusView.changeTo(
        state: .loading,
        title: "Title of status",
        message: "More info on the status",
        statusImage: nil,
        buttonImage: nil,
        animate: false)

From here set the state to .hidden or to .message depending on the state of loading the content

License

iStatusView is available under the Apache 2.0 license. See the LICENSE file for more info.