mosaic-server/dev.catbit.mosaic.server.builder.event.builders.scroll.row/ScrollRow

ScrollRow

fun EventSchemaBuilderScope.ScrollRow(id: String = randomId(), trigger: EventTrigger, events: EventSchemaBuilderScope.() -> Unit = {}, tileId: String, where: ScrollRowTileEventSchema.Where, smoothly: Boolean = true)

Scrolls the Row or LazyRow tile identified by tileId to where, by broadcasting a scroll command on the screen channel. smoothly chooses between an animated and an immediate jump. Does not consume incomingData. Dispatches onSuccess (no data) always, right after the command is broadcast — the broadcast is fire-and-forget, so this fires even when no tile carries tileId.

Parameters

Unique identifier of this event. Defaults to a random id.

trigger

Trigger that fires this event, built via EventTriggers.

events

Child events chained after this one, wired to its trigger (onSuccess).

tileId

Id of the Row/LazyRow tile to scroll.

where

Scroll target — scrollRowToStart, scrollRowToEnd or scrollRowTo (pixel offset in a Row, child index in a LazyRow).

smoothly

Whether the scroll animates instead of jumping immediately. Defaults to true.