# captionBarPadding

Common/AllAndroid/JVM

## Functions summary

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier.https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/captionBarPadding.modifier#(androidx.compose.ui.Modifier).captionBarPadding()()` Adds padding to accommodate the `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/package-summary#(androidx.compose.foundation.layout.WindowInsets.Companion).captionBar()` insets. | Cmn android |

## Functions

### Modifier.captionBarPadding

Cmn android Artifact: [androidx.compose.foundation:foundation-layout](https://developer.android.com/jetpack/androidx/releases/compose-foundation) [View Source](https://cs.android.com/search?q=file:androidx/compose/foundation/layout/WindowInsetsPadding.+function:captionBarPadding)

```
fun Modifier.captionBarPadding(): Modifier
```

Adds padding to accommodate the `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/package-summary#(androidx.compose.foundation.layout.WindowInsets.Companion).captionBar()` insets.

Any insets consumed by other insets padding modifiers or `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/consumeWindowInsets.modifier#(androidx.compose.ui.Modifier).consumeWindowInsets(androidx.compose.foundation.layout.WindowInsets)` on a parent layout will be excluded from the padding. `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/package-summary#(androidx.compose.foundation.layout.WindowInsets.Companion).captionBar()` will be `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/consumeWindowInsets.modifier#(androidx.compose.ui.Modifier).consumeWindowInsets(androidx.compose.foundation.layout.WindowInsets)` for child layouts as well.

For example, if a parent layout uses `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/displayCutoutPadding.modifier#(androidx.compose.ui.Modifier).displayCutoutPadding()`, the area that the parent layout pads for the status bars will not be padded again by this `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/captionBarPadding.modifier#(androidx.compose.ui.Modifier).captionBarPadding()` modifier.

When used, the `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/WindowInsets` will be consumed.

```kotlin
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.captionBarPadding
import androidx.compose.ui.Modifier
import androidx.core.view.WindowCompat

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