https://github.com/tbaranes/IncrementableLabel

Incrementable UILabel for iOS and tvOS
https://github.com/tbaranes/IncrementableLabel

Last synced: 4 months ago
JSON representation

Incrementable UILabel for iOS and tvOS

• Host: GitHub
• URL: https://github.com/tbaranes/IncrementableLabel
• Owner: tbaranes
• License: mit
• Created: 2016-01-20T15:41:09.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2020-02-21T08:56:49.000Z (about 5 years ago)
• Last Synced: 2024-05-19T08:20:55.274Z (11 months ago)
• Language: Swift
• Size: 219 KB
• Stars: 80
• Watchers: 4
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ios - IncrementableLabel - Incrementable label for iOS, macOS, and tvOS. (UI / Label)
• awesome-swift - IncrementableLabel - An UILabel subclass to (de)increment numbers in an UILabel. (Libs / UI)
• awesome-swift - IncrementableLabel - An UILabel subclass to (de)increment numbers in an UILabel. (Libs / UI)
• awesome-ios-star - IncrementableLabel - Incrementable label for iOS, macOS, and tvOS. (UI / Label)
• fucking-awesome-swift - IncrementableLabel - An UILabel subclass to (de)increment numbers in an UILabel. (Libs / UI)
• awesome-swift - IncrementableLabel - Incrementable UILabel for iOS and tvOS ` 📝 a year ago` (UI [🔝](#readme))

README

        
# IncrementableLabel

[![Travis](https://img.shields.io/travis/recisio/IncrementableLabel.svg)](https://travis-ci.org/recisio/IncrementableLabel)

![Language](https://img.shields.io/badge/language-Swift%205.0-orange.svg)

[![CocoaPods](https://img.shields.io/cocoapods/v/IncrementableLabel.svg?style=flat)](https://github.com/recisio/IncrementableLabel)

[![Platform](https://img.shields.io/cocoapods/p/IncrementableLabel.svg?style=flat)](http://cocoadocs.org/docsets/IncrementableLabel)

![License](https://img.shields.io/github/license/recisio/IncrementableLabel?style=flat)

IncrementableLabel is the easiest way to have incrementable numbers in an UILabel!

![](./assets/demo.gif)

## Usage

```swift

let myIncrementableLabel = IncrementableLabel(frame: CGRect(x: 0, y: 0, width: 100, height: 50))

myIncrementableLabel.incrementFromValue(0, toValue: 100, duration: 1)

```

Check the sample project for advanced usage

## Installation

- iOS 8.0+

- tvOS 9.0+

### CocoaPods Installation

IncrementableLabel is available on CocoaPods. Just add the following to your Podfile:

```

pod 'IncrementableLabel'

```

### Swift Package Manager

IncrementableLabel is available on SPM. Just add the following to your Package file:

```swift

import PackageDescription

let package = Package(

    dependencies: [

        .Package(url: "https://github.com/recisio/IncrementableLabel.git", majorVersion: 1)

    ]

)

```

### Manual Installation

Just drag the `Source/*.swift` files into your project.

## IncrementableLabel properties

```swift

var option: IncrementableLabelOptions = .linear

```

An options indicating how you want to perform the incrementation:

- linear

- easeIn

- easeOut

- easeInOut

```swift

typealias StringFormatter = (Float) -> String

var stringFormatter: StringFormatter?

typealias AttributedTextFormatter = (Float) -> NSAttributedString

var attributedTextFormatter: AttributedTextFormatter?

```

A callback closure which permits a greater control on how the text (attributed or not) is formatted between each incrementation.

```swift

var easingRate: Float = 3.0

```

The rate used when an `option` is used.

```swift

var format: String = "%d"

```

The format is used to set the text in the label. You can set the format to `%f` in order to display decimals.

```swift

public var currentValue: Double

```

The label's value during the incrementation 

## IncrementableLabel methods

```swift

func increment(fromValue: Float, toValue: Float, duration: Float = 0.3, fromColor: UIColor? = nil, toColor: UIColor? = nil, completion: IncrementableLabelCompletion? = nil)

```

Starts the incrementation `fromValue` to `toValue`, and the text color changes from `fromColor` to `toColor`. The duration by default will be 0.3

```swift

func incrementFromCurrentValue(toValue: Float, duration: Float = 0.3, fromColor: UIColor? = nil, toColor: UIColor? = nil, completion: IncrementableLabelCompletion? = nil)

```

Starts the incrementation from the current value to `toValue`. The duration by default will be 0.3

```swift

func incrementFromZero(toValue: Float, duration: Float = 0.3, fromColor: UIColor? = nil, toColor: UIColor? = nil, completion: IncrementableLabelCompletion? = nil)

```

Starts the incrementation from zero to `toValue`. The duration by default will be 0.3

## What's next

- Any suggestions?

## Contribution

- If you found a **bug**, open an **issue**

- If you have a **feature request**, open an **issue**

- If you want to **contribute**, submit a **pull request**

## Licence

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