Skip to content

Modifier API reference

These shared operations work on native Compose and HTML; Wasm uses Compose UI. See modifier recipes and support boundaries for custom CSS, native drawing and app-owned decoration.

align

fun DomposableModifier.align(axis: DomposableLayoutAxis, alignment: DomposableAlignment): DomposableModifier

alpha

fun DomposableModifier.alpha(value: Float): DomposableModifier

aspectRatio

fun DomposableModifier.aspectRatio(ratio: Float): DomposableModifier

background

fun DomposableModifier.background(value: DomposableColor): DomposableModifier
fun DomposableModifier.background(value: DomposableColor, shape: DomposableShape): DomposableModifier
fun DomposableModifier.background(gradient: DomposableLinearGradient, shape: DomposableShape = DomposableShape.Rectangle): DomposableModifier

border

fun DomposableModifier.border(width: DomposableLength, color: DomposableColor, shape: DomposableShape = DomposableShape.Rectangle): DomposableModifier
fun DomposableModifier.border(width: DomposableLength, color: DomposableColor, edge: DomposableBorderEdge): DomposableModifier

boxAlignment

fun DomposableModifier.boxAlignment(horizontal: DomposableAlignment = DomposableAlignment.Center, vertical: DomposableAlignment = DomposableAlignment.Center): DomposableModifier

clickable

fun DomposableModifier.clickable(label: String, onClick: () -> Unit): DomposableModifier
fun DomposableModifier.clickable(onClick: () -> Unit, role: DomposableClickRole = DomposableClickRole.Button, enabled: Boolean = true, onClickLabel: String? = null): DomposableModifier

clip

fun DomposableModifier.clip(radius: DomposableLength): DomposableModifier
fun DomposableModifier.clip(shape: DomposableShape): DomposableModifier

constrainContentWidth

fun DomposableModifier.constrainContentWidth(value: DomposableLength): DomposableModifier

contentDescription

fun DomposableModifier.contentDescription(value: String): DomposableModifier

fillMaxHeight

fun DomposableModifier.fillMaxHeight(): DomposableModifier

fillMaxSize

fun DomposableModifier.fillMaxSize(): DomposableModifier

fillMaxWidth

fun DomposableModifier.fillMaxWidth(fraction: Float, min: DomposableLength? = null, max: DomposableLength? = null): DomposableModifier
fun DomposableModifier.fillMaxWidth(): DomposableModifier

height

fun DomposableModifier.height(value: DomposableLength): DomposableModifier

heightIn

fun DomposableModifier.heightIn(min: DomposableLength? = null, max: DomposableLength? = null): DomposableModifier

horizontalScroll

fun DomposableModifier.horizontalScroll(): DomposableModifier
fun DomposableModifier.horizontalScroll(state: DomposableScrollState): DomposableModifier

maxHeight

fun DomposableModifier.maxHeight(value: DomposableLength): DomposableModifier

maxViewportHeight

fun DomposableModifier.maxViewportHeight(fraction: Float = 1.0f, subtract: DomposableLength = 0.dp, unit: DomposableViewportUnit = DomposableViewportUnit.Dynamic): DomposableModifier

maxWidth

fun DomposableModifier.maxWidth(value: DomposableLength): DomposableModifier

minHeight

fun DomposableModifier.minHeight(value: DomposableLength): DomposableModifier

minViewportHeight

fun DomposableModifier.minViewportHeight(fraction: Float = 1.0f, subtract: DomposableLength = 0.dp, unit: DomposableViewportUnit = DomposableViewportUnit.Dynamic): DomposableModifier

minWidth

fun DomposableModifier.minWidth(value: DomposableLength): DomposableModifier

offset

fun DomposableModifier.offset(x: Float, y: Float): DomposableModifier

padding

fun DomposableModifier.padding(all: DomposableLength): DomposableModifier
fun DomposableModifier.padding(insets: DomposableInsets): DomposableModifier
fun DomposableModifier.padding(horizontal: DomposableLength, vertical: DomposableLength): DomposableModifier

pointerPassthrough

fun DomposableModifier.pointerPassthrough(): DomposableModifier

region

fun DomposableModifier.region(label: String): DomposableModifier

rotate

fun DomposableModifier.rotate(degrees: Float): DomposableModifier

scale

fun DomposableModifier.scale(x: Float, y: Float = x): DomposableModifier

shadow

fun DomposableModifier.shadow(elevation: DomposableLength, shape: DomposableShape = DomposableShape.Rectangle): DomposableModifier

size

fun DomposableModifier.size(value: DomposableLength): DomposableModifier
fun DomposableModifier.size(width: DomposableLength, height: DomposableLength): DomposableModifier

testId

fun DomposableModifier.testId(value: String): DomposableModifier

verticalScroll

fun DomposableModifier.verticalScroll(): DomposableModifier
fun DomposableModifier.verticalScroll(state: DomposableScrollState): DomposableModifier

viewportHeight

fun DomposableModifier.viewportHeight(fraction: Float = 1.0f, subtract: DomposableLength = 0.dp, unit: DomposableViewportUnit = DomposableViewportUnit.Dynamic): DomposableModifier

weight

fun DomposableModifier.weight(weight: Float, fill: Boolean = true): DomposableModifier

width

fun DomposableModifier.width(value: DomposableLength): DomposableModifier

widthIn

fun DomposableModifier.widthIn(min: DomposableLength? = null, max: DomposableLength? = null): DomposableModifier

wrapContentSize

fun DomposableModifier.wrapContentSize(horizontal: DomposableAlignment = DomposableAlignment.Center, vertical: DomposableAlignment = DomposableAlignment.Center): DomposableModifier

zIndex

fun DomposableModifier.zIndex(value: Float): DomposableModifier