mosaic-server/dev.catbit.mosaic.server.builder.event.builders.overlays.bottom_sheet/DisplayBottomSheet

DisplayBottomSheet

fun EventSchemaBuilderScope.DisplayBottomSheet(id: String = randomId(), trigger: EventTrigger, events: EventSchemaBuilderScope.() -> Unit = {}, bottomSheetId: String, isCancellable: Boolean = true, fill: Boolean = false, allowsPartialExpansion: Boolean = false, tiles: TileSchemaBuilderScope.() -> Unit)

Shows a non-modal bottom sheet built from tiles, registered under bottomSheetId so a later DismissBottomSheet can close it — unlike the modal variant, it does not dim or block the content behind it. isCancellable decides whether the user can dismiss it by gesture, fill whether it takes the full height, and allowsPartialExpansion whether it stops at a half-expanded state before reaching full height. Does not consume incomingData. Dispatches onSuccess (no data) when the sheet was added; onFailure (carrying the thrown exception) when it could not be added, typically because bottomSheetId is already in use; onDisplay once, when the sheet actually enters composition on screen.

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 triggers (onSuccess, onFailure, onDisplay).

bottomSheetId

Id the sheet is registered under, matched by a later DismissBottomSheet.

isCancellable

Whether the user can dismiss the sheet by gesture. Defaults to true.

fill

Whether the sheet takes the full available height. Defaults to false.

allowsPartialExpansion

Whether the sheet stops at a half-expanded state before reaching full height. Defaults to false.

tiles

Tile tree rendered as the sheet's content.