Skip to content

khawajafarooq/ProgressMeter

Repository files navigation

CI Status Swift 4.0 Version Carthage compatible License Platform

Description

Displaying the progress in a meter control. ProgressMeter lets you create your custom annotations that display either on top or bottom of meter. So, it's not just an ordinary progress bar, it gives the better visual. 💯

Use Cases

Fitness App 🏃‍

Building a pedometer has never been easier. If you are looking for something other than a gauge control, you have come to the right place. Have a look 🤓

Banking App 🏦

Talking about financial apps. We all 've come across with such scenarios to show the rewards earned or a cash back. ProgressMeter is here to help with a unique user experience. 🏧

Example

Interface Builder

Guess what? You can do that all in design time without writing a single line of code. Drag & drop a UIView from the object library and follow the steps:

Step 1: Set the Class & Module Identity Inspector > Custom Class

Step 2: Under Attribute Inspector you can change the properties and check everything on the fly 🚀

  • maxValue: Maximum value of the meter
  • progress: Current progress of meter
  • numberOfDivisions: How many divisions you want to display
  • Rest are pretty much self explanatory

Code 👨‍💻

Hook your view (ProgressMeter) property on your view controller and try out the snippets inside viewDidLoad;

Snippet # 1: Looking for setting up the control with your own data 👨‍🏫

func setupWithCustomData() {
    progressControl.maxValue = 20000
    progressControl.data = [1999, 4999, 9999, 14999]
    progressControl.progress = 14999 / 20000
}

Snippet # 2: Don't have the data set? ProgressMeter can create its own data 🔢

func setupWithControlData() {
    progressControl.maxValue = 20000
    progressControl.numberOfDivisions = 4
    progressControl.progress = 0.4
}

Snippet # 3: Setup the visual aspect 💄

func visualSetup() {
    progressControl.progressTintColor = .purple
    progressControl.trackTintColor = .gray
    progressControl.borderWidth = 1
    progressControl.borderColor = .darkGray
    progressControl.annotationTextColor = .purple
    progressControl.dividerColor = .darkGray
}

Installation

CocoaPods

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

pod 'ProgressMeter'

Carthage

To integrate ProgressMeter into your Xcode project using Carthage, specify the following in your Cartfile:

github "khawajafarooq/ProgressMeter"

Run carthage update to build the framework and drag the built ProgressMeter.framework into your Xcode project.


Requirements

Support Version
iOS 9.0
Swift 4.0

Up Coming Features 🎏

  • Carthage support
  • Display Annotations either on top or bottom

Issues 🚫

  • Some tweakings required to use ProgressMeter inside a Stack View

Author 🙏🏻

Web: Khawaja Farooq

Twitter: @khfarooq

Medium: @khfarooq

License

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

About

Measuring the progress with annotations 🔱

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published