mosaic-server/dev.catbit.mosaic.server.builder.tile.builders.image/Image

Image

fun TileSchemaBuilderScope.Image(id: String = randomId(), events: EventSchemaBuilderScope.() -> Unit = {}, style: StyleSchemaBuilderScope.() -> Unit = {}, visibility: TileSchema.Visibility = visible(), searchableTerms: List<String>? = null, resourceName: String, contentDescription: String? = null, contentScale: ImageTileSchema.ContentScale = imageFitContentScale(), alpha: Float = 1.0f, alignment: AlignmentSchema.TwoDimensional = alignToCenter())

Renders a Compose Image from a drawable bundled with the client application. resourceName is looked up in the app's DrawableResourcesHolder; when no resource is registered under that name nothing is rendered at all — there is no fallback and no error trigger. Dispatches no triggers and is not clickable. Use AsyncImage for images that come from the network or from raw bytes — this tile can only show assets that ship with the client.

Parameters

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

events

Events owned by this tile. Never fired, since the tile dispatches no triggers.

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.

resourceName

Name of the drawable resource looked up in the client's DrawableResourcesHolder.

contentDescription

Accessibility description of the image. Defaults to none.

contentScale

How the image is scaled to fit its bounds — imageCropContentScale, imageFitContentScale, imageFillHeightContentScale, imageFillWidthContentScale, imageInsideContentScale or imageFillBoundsContentScale. Defaults to fit.

alpha

Opacity applied to the image, from 0f to 1f. Defaults to 1f.

alignment

Alignment of the image within its bounds. Defaults to center.