Skip to content

Commit d07b624

Browse files
committed
Add forcedScrolling documentation
1 parent 8d038ad commit d07b624

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

Sources/MarqueeLabel.swift

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,21 @@ open class MarqueeLabel: UILabel, CAAnimationDelegate {
154154
}
155155

156156
@IBInspectable public var forceScrolling: Bool = false
157+
/**
158+
A boolean property that sets whether the `MarqueeLabel` should scroll, even if the specificed test string
159+
can be fully contained within the label frame.
160+
161+
If this property is set to `true`, the `MarqueeLabel` will automatically scroll regardless of text string
162+
length, although this can still be overridden by the `tapToScroll` and `holdScrolling` properties.
163+
164+
Defaults to `false`.
165+
166+
- Warning: Forced scrolling may have unexpected edge cases or have unusual characteristics compared to the
167+
'normal' scrolling feature.
168+
169+
- SeeAlso: holdScrolling
170+
- SeeAlso: tapToScroll
171+
*/
157172

158173
/**
159174
A boolean property that sets whether the `MarqueeLabel` should only begin a scroll when tapped.

0 commit comments

Comments
 (0)