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

ScrollPager

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.

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 Pager/Carousel tile to move.

where

Page target — scrollPageToBegin, scrollPageToPreviousPage, scrollPageToNextPage or scrollPageToEnd.

smoothly

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