innerShadow

Common

Modifier in Compose Ui

Draws an inner shadow on top of the rest of the content with the geometry specified by the given shape and the shadow properties defined by the [Shadow]. This is different than [Modifier.shadow] as this does not introduce a graphicsLayer to render elevation based shadows. Additionally this shadow will render only within the geometry and can be used to provide a recessed like visual effect. This shadow is rendered without a single light source and will render consistently regardless of the on screen position of the content.

Last updated:

Installation

dependencies {
   implementation("androidx.compose.ui:ui:1.9.0-beta02")
}

Overloads

@Stable
fun Modifier.innerShadow(shape: Shape, shadow: Shadow): Modifier

Parameters

namedescription
shapeGeometry of the shadow
shadowProperties of the shadow like radius, spread, offset, and fill properties like the color or brush
@Stable
fun Modifier.innerShadow(shape: Shape, block: InnerShadowScope.() -> Unit): Modifier

Parameters

namedescription
shapeGeometry of the shadow
block[InnerShadowScope] block where shadow properties are defined

Code Example

InnerShadowSample

@Composable
fun InnerShadowSample() {
    Box(Modifier.size(100.dp, 100.dp).innerShadow(RectangleShape, Shadow(12.dp)))
}