SideboardBuilder

A helper class which is used to create a Sideboard.

You probably want to use this class via the sideboard function.

Constructors

constructor()

inline suspend fun FlowCollector<Component>.~~emitLiteralText~~(baseText: String? = null, crossinline builder: LiteralTextBuilder.() -> Unit = {})

A utility function, allowing you to emit a Text to the flow, which is built by an easy to use literalText builder.

Adds an empty line to the board.

inline fun ~~line~~(block: () -> Component)

Adds a simple and static line of text. The block parameter can be used to add some additional logic.

fun line(flow: Flow<Component>)

Shortcut for adding a SideboardLine.Changing.

fun line(text: Component)

Adds a simple and static line of text.

Adds any line implementing the SideboardLine interface.

inline fun ~~lineChanging~~(crossinline flowBuilder: suspend FlowCollector<Component>.() -> Unit)

Adds a line where the content is changing.

fun ~~lineChangingPeriodically~~(period: Long, block: suspend () -> Component)

Adds a line where the content is changing / updating periodically.

inline fun ~~literalLine~~(baseText: String? = null, crossinline builder: LiteralTextBuilder.() -> Unit = {})

Adds a simple and static line of text.

fun updatingLine(period: Duration, updater: suspend () -> Component)

Adds a line where the content is updated periodically.