mosaic-server/dev.catbit.mosaic.server.builder.event.builders.scroll.pager

Package-level declarations

Functions

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

Moves the Pager or Carousel tile identified by tileId to where, by broadcasting a scroll command on the screen channel. smoothly chooses between an animated and an immediate jump; the receiving tile clamps the result, so asking for the next page on the last one is a no-op. 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.

scrollPageToBegin

fun scrollPageToBegin(): ScrollPagerTileEventSchema.Where.Begin

Moves to the first page.

scrollPageToEnd

fun scrollPageToEnd(): ScrollPagerTileEventSchema.Where.End

Moves to the last page.

scrollPageToNextPage

fun scrollPageToNextPage(): ScrollPagerTileEventSchema.Where.NextPage

Moves to the next page — a no-op if already on the last page.

scrollPageToPreviousPage

fun scrollPageToPreviousPage(): ScrollPagerTileEventSchema.Where.PreviousPage

Moves to the previous page — a no-op if already on the first page.