captionBarPadding

Modifier in Compose Foundation Layout

Adds padding to accommodate the [caption bar][WindowInsets.Companion.captionBar] insets.

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

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

When used, the [WindowInsets] will be consumed.

Last updated: 2024-10-22 13:47

Installation

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

Overloads

fun Modifier.captionBarPadding(): Modifier

fun Modifier.captionBarPadding()

Code Example

captionBarPaddingSample

fun captionBarPaddingSample() {
    class SampleActivity : ComponentActivity() {
        override fun onCreate(savedInstanceState: Bundle?) {
            WindowCompat.setDecorFitsSystemWindows(window, false)
            super.onCreate(savedInstanceState)
            setContent {
                Box(Modifier.captionBarPadding()) {
                    // app content
                }
            }
        }
    }
}