mosaic-server/dev.catbit.mosaic.server.builder.event.builders.overlays.dialog/DisplayDialog

DisplayDialog

fun EventSchemaBuilderScope.DisplayDialog(id: String = randomId(), trigger: EventTrigger, events: EventSchemaBuilderScope.() -> Unit = {}, dialogId: String, isCancellable: Boolean = true, usePlatformDefaultWidth: Boolean = false, tiles: TileSchemaBuilderScope.() -> Unit)

Shows a dialog built from tiles, registered under dialogId so a later DismissDialog can close it. isCancellable decides whether the user can dismiss it with the back gesture or a scrim tap, and usePlatformDefaultWidth whether the dialog keeps the platform's default width or sizes itself from its content. Does not consume incomingData. Dispatches onSuccess (no data) when the dialog was added; onFailure (carrying the thrown exception) when it could not be added, typically because dialogId is already in use; onDisplay once, when the dialog 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).

dialogId

Id the dialog is registered under, matched by a later DismissDialog.

isCancellable

Whether the user can dismiss the dialog with the back gesture or a scrim tap. Defaults to true.

usePlatformDefaultWidth

Whether the dialog keeps the platform's default width instead of sizing from its content. Defaults to false.

tiles

Tile tree rendered as the dialog's content.