New Compose Multiplatform components arrived on Composables UICheck it out →

Modifier in Compose Foundation Layout

displayCutoutPadding

Android
Common
Desktop

Adds padding to accommodate the [display cutout][WindowInsets.Companion.displayCutout].

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

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

When used, the [WindowInsets][android.view.WindowInsets] will be consumed.

Last updated:

Installation

dependencies {
   implementation("androidx.compose.foundation:foundation-layout:1.7.0-beta04")
}

Overloads


fun Modifier.displayCutoutPadding()

fun Modifier.displayCutoutPadding()

fun Modifier.displayCutoutPadding()

Code Example

displayCutoutPaddingSample

@Sampled
fun displayCutoutPaddingSample() {
    class SampleActivity : ComponentActivity() {
        override fun onCreate(savedInstanceState: Bundle?) {
            WindowCompat.setDecorFitsSystemWindows(window, false)
            super.onCreate(savedInstanceState)
            setContent {
                Box(
                    Modifier
                        .background(Color.Blue)
                        .statusBarsPadding()) {
                    Box(
                        Modifier
                            .background(Color.Yellow)
                            .displayCutoutPadding()) {
                        // app content
                    }
                }
            }
        }
    }
}