windowInsetsPadding

Modifier in Compose Foundation Layout

Adds padding so that the content doesn't enter [insets] space.

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

For example, if an ancestor uses [statusBarsPadding] and this modifier uses [WindowInsets.Companion.systemBars], the portion of the system bars that the status bars uses will not be padded again by this modifier.

Last updated: 2024-09-07 14:23

Installation

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

Overloads

@Stable
fun Modifier.windowInsetsPadding(insets: WindowInsets): Modifier

Code Example

insetsPaddingSample

fun insetsPaddingSample() {
    class SampleActivity : ComponentActivity() {
        override fun onCreate(savedInstanceState: Bundle?) {
            WindowCompat.setDecorFitsSystemWindows(window, false)
            super.onCreate(savedInstanceState)
            setContent {
                val insets = WindowInsets.systemBars.union(WindowInsets.ime)
                Box(Modifier.background(Color.White).fillMaxSize().windowInsetsPadding(insets)) {
                    // app content
                }
            }
        }
    }
}