mosaic-server/dev.catbit.mosaic.server.builder.tile.builders.inputs/Switch

Switch

fun TileSchemaBuilderScope.Switch(id: String = randomId(), events: EventSchemaBuilderScope.() -> Unit = {}, style: StyleSchemaBuilderScope.() -> Unit = {}, visibility: TileSchema.Visibility = visible(), searchableTerms: List<String>? = null, checked: Boolean = false, enabled: Boolean = true)

Renders a bare Material 3 switch reflecting checked. Draws only the switch — no label or thumb icon — so pair it with a SimpleText inside a Row when a caption is needed. Toggling flips checked locally on the client (no round trip needed for the new value to take effect), then dispatches onCheck (when it turns on) or onUncheck (when it turns off), always followed by onCheckChanged. The current checked value can be read from this tile by its id via GetData.

Parameters

Unique identifier of the tile. Defaults to a random id.

events

Events owned by this tile, wired to its triggers (onCheck, onUncheck, onCheckChanged).

style

Layout/appearance modifiers (size, padding, background, etc). Defaults to wrapping its content.

visibility

Whether the tile is shown, hidden but occupies space, or removed from layout. Defaults to visible.

searchableTerms

Terms used by an ancestor's search/filter to decide whether this tile matches. Defaults to none.

checked

Whether the switch starts on. Defaults to false.

enabled

Whether the switch is interactive. Defaults to true.