safeGesturesPadding

Modifier in Compose Foundation Layout

Adds padding to accommodate the [safe gestures][WindowInsets.Companion.safeGestures] insets.

Any insets consumed by other insets padding modifiers or [consumeWindowInsets] on a parent layout will be excluded from the padding. [WindowInsets.Companion.safeGestures] will be [consumed][consumeWindowInsets] for child layouts as well.

For example, if a parent layout uses [navigationBarsPadding], the area that the parent layout pads for the status bars will not be padded again by this [safeGesturesPadding] modifier.

When used, the [WindowInsets] will be consumed.

Last updated: 2024-09-07 14:23

Installation

dependencies {
   implementation("androidx.compose.foundation:foundation-layout:1.8.0-alpha01")
}

Overloads

fun Modifier.safeGesturesPadding(): Modifier

fun Modifier.safeGesturesPadding()

Code Example

safeGesturesPaddingSample

fun safeGesturesPaddingSample() {
    class SampleActivity : ComponentActivity() {
        override fun onCreate(savedInstanceState: Bundle?) {
            WindowCompat.setDecorFitsSystemWindows(window, false)
            super.onCreate(savedInstanceState)
            setContent {
                Box(Modifier.background(Color.Black).systemBarsPadding()) {
                    // The app content will only be drawn where there is no possible
                    // gesture confusion. The rest will be plain white
                    Box(Modifier.background(Color.White).safeGesturesPadding()) {
                        // app content
                    }
                }
            }
        }
    }
}