mosaic-core/dev.catbit.mosaic.core.data.schemas.event.events.overlays.modal_bottom_sheet/DisplayModalBottomSheetEventSchema

DisplayModalBottomSheetEventSchema

@Immutable

@Serializable

@SerialName(value = "DisplayModalBottomSheet")

data class DisplayModalBottomSheetEventSchema(val id: String, val trigger: EventTrigger, val events: SerializableImmutableList<EventSchema>?, val modalBottomSheetId: String, val tiles: SerializableImmutableList<TileSchema>, val isCancellable: Boolean, val fill: Boolean, val allowsPartialExpansion: Boolean) : EventSchema

Shows a modal bottom sheet built from tiles, registered under modalBottomSheetId so a later DismissModalBottomSheet can close it. Unlike the plain bottom sheet, this one dims and blocks the content behind it.

isCancellable decides whether the user can dismiss it by gesture or scrim tap, fill whether it takes the full height, and allowsPartialExpansion whether it stops at a half-expanded state before reaching full height.

incomingData consumed: not used.

Triggers fired:

OnSuccessEventTrigger — when the sheet was added. No data is passed downstream.
OnFailureEventTrigger — when it could not be added, typically because modalBottomSheetId is already in use; the Throwable is passed as incomingData.
OnDisplayEventTrigger — once, when the sheet actually enters composition on screen.

Constructors

DisplayModalBottomSheetEventSchema

constructor(id: String, trigger: EventTrigger, events: SerializableImmutableList<EventSchema>?, modalBottomSheetId: String, tiles: SerializableImmutableList<TileSchema>, isCancellable: Boolean, fill: Boolean, allowsPartialExpansion: Boolean)

Properties

allowsPartialExpansion

@SerialName(value = "allowsPartialExpansion")

val allowsPartialExpansion: Boolean

events

@SerialName(value = "events")

open override val events: SerializableImmutableList<EventSchema>?

This event's own children — each declaring, via its own trigger, which of this event's outgoing triggers runs it. null when this event declares no children.

fill

@SerialName(value = "fill")

val fill: Boolean

@SerialName(value = "id")

open override val id: String

Unique identifier — how TriggerEvent/UpdateEvents address this event by id. Defaults to a random id when omitted from the DSL.

isCancellable

@SerialName(value = "isCancellable")

val isCancellable: Boolean

modalBottomSheetId

@SerialName(value = "modalBottomSheetId")

val modalBottomSheetId: String

tiles

@SerialName(value = "tiles")

val tiles: SerializableImmutableList<TileSchema>

trigger

@SerialName(value = "trigger")

open override val trigger: EventTrigger

The condition that must occur for this event to run — matched by structural equality (data class/data object equality) against whatever trigger value fired, never by any kind of subscription or listener registry.