ALProgressRing

About

ALProgressRing - is a library for displaying a circular progress ring.

It's easy to customize. You can adjust the gradient for the ring, line width, shadow, and more.

Also for this library, I added about 20 functions for animation, more details in the Animation section

If you liked this library, please do not forget to put a ★ star, it will help me in its development.

Navigation

Requirements
Installation
Usage
- Quick Start
- Customization
  - Colors
  - Layout
  - Animation
License

Requirements

iOS 10.0 +
Swift 4.2 +

Installation

Swift Package Manager

The Swift Package Manager is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.

To integrate ALProgressRing click File -> Swift Package -> Add Package Dependency and insert:

https://github.com/alxrguz/ALProgressRing

CocoaPods

ALProgressRing is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'ALProgressRing'

Manually

If you prefer not to use either of the aforementioned dependency managers, you can integrate ALProgressRing into your project manually. Put Source/ALProgressRing folder in your Xcode project.

Usage

Quick Start

import ALProgressRing

class MyViewController: UIViewController {

    private lazy var progressRing = ALProgressRing()

    override func viewDidLoad() {
        super.viewDidLoad()

        view.addSubview(progressRing)
        // Setup layout
        progressRing.translatesAutoresizingMaskIntoConstraints = false
        progressRing.centerXAnchor.constraint(equalTo: view.centerXAnchor).isActive = true
        progressRing.centerYAnchor.constraint(equalTo: view.centerYAnchor).isActive = true
      	// Make sure to set the view size
        progressRing.widthAnchor.constraint(equalToConstant: 180).isActive = true
        progressRing.heightAnchor.constraint(equalToConstant: 180).isActive = true
        
        progressRing.setProgress(0.8, animated: true)
    }
}

Customization

Colors

You can customize the buttons, headers and indicators colors depending on their state.

/// Set track color
/// If you don't need a gradient, just set the same values for `startColor` and `endColor`
progressRing.startColor = .systemPink 
progressRing.endColor = .systemRed 

/// Set groove color
progressRing.endColor = .systemRed

Layout

progressRing.startAngle = -.pi / 2 // The start angle of the ring to begin drawing.
progressRing.endAngle = 1.5 * .pi // The end angle of the ring to end drawing. 
progressRing.startGradientPoint = .init(x: 0.5, y: 0) // The starting poin of the gradient
progressRing.endGradientPoint = .init(x: 0.5, y: 1) // The ending position of the gradient.
progressRing.ringWidth = 10 // Width of the progress ring.
progressRing.grooveWidth = 8 // Width of the background "groove" ring.

Animation

progressRing.duration = 2 // Duration of the ring's fill animation.
progressRing.timingFunction = .easeOutExpo // Timing function of the ring's fill animation.

/// The following use of setProgress (_ value: Int, animated: Bool) 
/// will take into account the new parameters 
progressRing.setProgress(0.8, animated: true)

Let's take a look at the timingFunction parameter, it is of type ALTimingFunction, which contains the following types of animations:

There is a good cheat sheet available here.

License

ALProgressRing is under MIT license. See the LICENSE file for more info.

grovdata/ALProgressRing