SachK13 / SKActivityIndicatorView

A lightweight And Easy-To-Use ActivityIndicator For Your iOS App.
MIT License
66 stars 21 forks source link

SKActivityIndicatorView

SKActivityIndicatorView is a lightweight and easy-to-use ActivityIndicator for your iOS app written in swift.

SKActivityIndicatorView

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Features

Requirements

Installation

CocoaPods

To integrate SKActivityIndicatorView into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '13.0'
use_frameworks!

target '<Your Target Name>' do
pod 'SKActivityIndicatorView', '~> 1.0.0'
end

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate SKActivityIndicatorView into your Xcode project using Carthage, specify it in your Cartfile:

github "SachK13/SKActivityIndicatorView" ~> 1.0.0

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler. It is in early development, but SKActivityIndicatorView does support its use on supported platforms.

Once you have your Swift package set up, adding SKActivityIndicatorView as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/SachK13/SKActivityIndicatorView.git", .upToNextMajor(from: “1.2.1”))
]
Or Add with Branch -> master instead of version

Manual

You can directly add the SKActivityIndicatorView.swift and SKActivityIndicatorViewStyle.swift source files into your Xcode project.

Include SKActivityIndicatorView wherever you need it with import SKActivityIndicatorView.

Usage

(see sample Xcode project in /Example) To run the example project, clone the repo, and run pod install from the Example directory first.

Import the module.

import SKActivityIndicatorView

Now, you can show only ActivityIndicatorView without status message:

SKActivityIndicator.show()

Display ActivityIndicatorView with status message:

SKActivityIndicator.show("Loading...")

Display ActivityIndicatorView with status message and user interaction status:

SKActivityIndicator.show("Loading...", userInteractionStatus: true)

Hide ActivityIndicatorView:

SKActivityIndicator.dismiss()

Customization

// default is darkGray
SKActivityIndicator.spinnerColor(UIColor.darkGray)

// default is black
SKActivityIndicator.statusTextColor(UIColor.black)

// default is System Font
let myFont = UIFont(name: "AvenirNext-DemiBold", size: 18)
SKActivityIndicator.statusLabelFont(myFont!)

// ActivityIndicator Styles: choose and set one of four.
SKActivityIndicator.spinnerStyle(.defaultSpinner)
SKActivityIndicator.spinnerStyle(.spinningFadeCircle)
SKActivityIndicator.spinnerStyle(.spinningCircle)
SKActivityIndicator.spinnerStyle(.spinningHalfCircles)

License

SKActivityIndicatorView is released under the MIT license. See LICENSE for details.