Close Menu

TXScrollLabelView

Introduction

TXScrollLabelView is a highly customizable, lightweight, and easy-to-use scrolling label view for iOS.

Features

  • Scrolling label view that supports single and multiple lines of text
  • Customize various aspects of the label view, such as font, color, and animation duration
  • Supports vertical and horizontal scrolling directions
  • Option to automatically pause scrolling when the view is not visible
  • Supports both continuous and bounce scrolling modes
  • Flexible API for controlling the scrolling behavior programmatically

Installation

To install TXScrollLabelView, you can use CocoaPods. Add the following line to your Podfile:



pod 'TXScrollLabelView'

Usage

To use TXScrollLabelView, follow these steps:

Step 1: Import the library

Import the TXScrollLabelView header file in your view controller:



import TXScrollLabelView

Step 2: Create an instance

Create an instance of TXScrollLabelView and add it to your view hierarchy:



let scrollLabelView = TXScrollLabelView(frame: CGRect(x: 0, y: 0, width: 200, height: 50))
self.view.addSubview(scrollLabelView)

Step 3: Customize the label view

Customize various aspects of the label view, such as font, color, and animation duration:



scrollLabelView.scrollDirection = .left
scrollLabelView.font = UIFont.systemFont(ofSize: 16)
scrollLabelView.textColor = UIColor.black
scrollLabelView.scrollSpeed = .normal

Step 4: Set the text

Set the text that will be displayed in the label view:



scrollLabelView.text = "Hello, world!"

Step 5: Start scrolling

Start the scrolling animation:



scrollLabelView.beginScrolling()

Additional Options

TXScrollLabelView provides additional options for more advanced usage:

Pause When Invisible

By default, the scrolling animation continues even when the view is not visible. You can enable the pauseWhenInvisible property to automatically pause scrolling when the view is not visible:



scrollLabelView.pauseWhenInvisible = true

Continuous Scrolling Mode

By default, the label view scrolls the text once and stops at the end. However, you can enable continuous scrolling mode to make the text loop continuously:



scrollLabelView.scrollMode = .continuous

Bounce Scrolling Mode

By default, the label view scrolls the text once and reverses direction at the end. You can enable bounce scrolling mode to make the text bounce back and forth:



scrollLabelView.scrollMode = .bounce

Programmatic Scrolling Control

You can programmatically control the scrolling behavior of the label view using the following methods:



// Start scrolling animation
scrollLabelView.beginScrolling()

// Stop scrolling animation
scrollLabelView.stopScrolling()

// Scroll to a specific offset
scrollLabelView.scrollToOffset(100, animated: true)

// Scroll one step forward
scrollLabelView.scrollForward()

// Scroll one step backward
scrollLabelView.scrollBackward()

Conclusion

With TXScrollLabelView, you can easily create and customize scrolling label views for your iOS apps. Its flexible API and various options enable you to achieve the desired scrolling behavior and appearance.

For more details and usage examples, refer to the official GitHub repository of TXScrollLabelView.