marquee

fun <T> ProgressLayoutScope<T>.marquee(width: Int, fps: Int = 3, align: TextAlign = this.align, verticalAlign: VerticalAlign = this.verticalAlign, scrollWhenContentFits: Boolean = false, content: ProgressState<T>.() -> String)

Add a fixed width text cell that scrolls its contents horizontally so that long text can be displayed in a fixed width.

Parameters

width

The width of the cell in characters.

fps

The number of times per second to update the displayed text.

align

The text alignment for this cell when scrollWhenContentFits is false and the content fits in the width.

scrollWhenContentFits

If true, the text will always scroll, even if it fits in the width.

content

The text to display in this cell.


fun ProgressLayoutScope<*>.marquee(content: String, width: Int, fps: Int = 3, align: TextAlign = this.align, verticalAlign: VerticalAlign = this.verticalAlign, scrollWhenContentFits: Boolean = false)

Add a fixed width text cell that scrolls its contents horizontally so that long text can be displayed in a fixed width.

Parameters

content

The text to display in this cell.

width

The width of the cell in characters.

fps

The number of times per second to update the displayed text.

align

The text alignment for this cell when scrollWhenContentFits is false and the content fits in the width.

scrollWhenContentFits

If true, the text will always scroll, even if it fits in the width.