mosaic-server/dev.catbit.mosaic.server.builder.tile.builders.grouping/Shimmer

Shimmer

fun TileSchemaBuilderScope.Shimmer(id: String = randomId(), events: EventSchemaBuilderScope.() -> Unit = {}, style: StyleSchemaBuilderScope.() -> Unit = {}, visibility: TileSchema.Visibility = visible(), searchableTerms: List<String>? = null, tiles: TileSchemaBuilderScope.() -> Unit)

Renders a Box hosting tiles with a continuously animated shimmer applied over the whole subtree — the usual way to build a skeleton/loading placeholder out of plain tiles. The shimmer is purely visual: children stay interactive, so build the placeholder out of non-clickable tiles. The tile itself is never clickable, and children are laid out with Box semantics (stacked, no scope CompositionLocal). Dispatches onDisplay once when composed.

Parameters

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

events

Events owned by this tile, wired to its triggers (e.g. onDisplay).

style

Layout/appearance modifiers (size, padding, background, etc).

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.

tiles

Child tiles over which the shimmer animation is drawn.