JZRollableLabel

JZRollableLabel is a label control that can roll while displaying infomation.

⚠️ To use with Swift 4.x please ensure you are using >= 4.0.0 ⚠️

⚠️ To use with Swift 5.x please ensure you are using >= 5.0.0 ⚠️

Contents

• Update
  • New Feature
  • Bug Fixed
• Example
• Requirements
• Installation
  • CocoaPods
  • Manually
• Usage
• Property and Function
• Author
• License

Update

New Feature

• The property 'numberOfLines' is currently supported.
• The rolling core is seperated from the outside shell, so now there is no exposed function that should not be called.
• Due to the same reason as above, the limitation of implementing CAAnimationDelegate for a subclass of JZRollableLabel no longer exists.

Bug Fixed

• The logic of intrinsticContentSize is now fixed.
• The layout problem while no height is specified is now fixed.

Example

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

Requirements

• Minimum iOS Target: 9.0.
• Swift Version: 4.0+.

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate JZRollableLabel using CocoaPods, specify it in your Podfile:

/* For project that is using Swift 4.x */
pod 'JZRollableLabel', '~> 4.0.0'

/* For project that is using Swift 5.x */
pod 'JZRollableLabel', '~> 5.0.0'

Then, run the following command:

$ pod install

Manually

Of course you can always integrate SnapKit into your project manually if you like! 😊

Usage

JZRollableLabel can be easily created and used with the following code:

import JZRollableLabel_Swift

let label = JZRollableLabel(/*frame: <any CGRect>*/)
view.addSubview(label)
/* Any additional operations to layout the label.
	 The layout feature of this label is designed to the same as UILabel. */

The rolling animation can be started by calling the function 'beginRolling()':

label.beginRolling()
/* This function can be called anytime,
	 but calling it too early will case unexpected changes of its status due to layouting. */

The rolling animation can be stopped by calling the function 'stopRolling(immediately: Bool)':

/* Passing different values will cause the different in wyas to terminate the animation. */

label.stopRolling(immediately: true)
/* This will stop the animation immediately. */

label.stopRolling(immediately: true)
/* This will stop the animation after the current round of animation completes. */

Properties if JZRollableLabel is mutable anytime but changing them will restart the animation the beginning, so if you want to change it more smoothly, or after the current round if animation, the delegate can be used and the function 'rollingDidStop(finished flag: Bool)' is what you are looking for. It can be used in the following ways:

extension /* The class of any object you want to use as the delegate */: JZRollableLabelDelegate {
    
  	/* This is called when the animation has stopped. */
    func rollingDidStop(finished flag: Bool) {
        if flag {
						/* This is the situation while the animation goes to the end. */
        } else {
						/* This is the situation while the animation being interrupted by any other operation. */
        }
    }
    
  	/* This is called when the animation has began. */
    func rollingDidStart() {
      	
    }
    
}

Property and Function

The properties unique to JZRollableLabel are listed below:

The supported UILabel properties are listed below:

The special functions implemented for JZRollableLabel are listed below:

Author

朱嘉皓, [email protected]

License

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