WindowInsets.Companion

Artifact: androidx.compose.foundation:foundation-layout

Added in 1.2.0

Cmn
```
object WindowInsets.Companion
```

Summary

Extension properties
`Boolean`	`@ExperimentalLayoutApi WindowInsets.Companion.areNavigationBarsVisible` `true` when the `navigationBars` are being displayed, irrespective of whether they intersects with the Window.	android
`Boolean`	`@ExperimentalLayoutApi WindowInsets.Companion.areStatusBarsVisible` `true` when the `statusBars` are being displayed, irrespective of whether they intersects with the Window.	android
`Boolean`	`@ExperimentalLayoutApi WindowInsets.Companion.areSystemBarsVisible` `true` when the `systemBars` are being displayed, irrespective of whether they intersects with the Window.	android
`WindowInsets`	`WindowInsets.Companion.captionBar` An insets type representing the window of a caption bar.	Cmn android
`WindowInsets`	`@ExperimentalLayoutApi WindowInsets.Companion.captionBarIgnoringVisibility` The insets that the `WindowInsetsCompat.Type.captionBar` will consume if shown.	android
`WindowInsets`	`WindowInsets.Companion.displayCutout` This `WindowInsets` represents the area with the display cutout (e.g. for camera).	Cmn android
`WindowInsets`	`WindowInsets.Companion.ime` An insets type representing the window of the software keyboard.	Cmn android
`WindowInsets`	`@ExperimentalLayoutApi WindowInsets.Companion.imeAnimationSource` The `WindowInsets` for the IME before the IME started animating in.	android
`WindowInsets`	`@ExperimentalLayoutApi WindowInsets.Companion.imeAnimationTarget` The `WindowInsets` for the IME when the animation completes, if it is allowed to complete successfully.	android
`Boolean`	`@ExperimentalLayoutApi WindowInsets.Companion.isCaptionBarVisible` `true` when the `caption bar` is being displayed, irrespective of whether it intersects with the Window.	android
`Boolean`	`@ExperimentalLayoutApi WindowInsets.Companion.isImeVisible` `true` when the `soft keyboard` is being displayed, irrespective of whether it intersects with the Window.	android
`Boolean`	`@ExperimentalLayoutApi WindowInsets.Companion.isTappableElementVisible` `true` when the `tappableElement` is being displayed, irrespective of whether they intersects with the Window.	android
`WindowInsets`	`WindowInsets.Companion.mandatorySystemGestures` These insets represent the space where system gestures have priority over application gestures.	Cmn android
`WindowInsets`	`WindowInsets.Companion.navigationBars` These insets represent where system UI places navigation bars.	Cmn android
`WindowInsets`	`@ExperimentalLayoutApi WindowInsets.Companion.navigationBarsIgnoringVisibility` The insets that `WindowInsetsCompat.Type.navigationBars` will consume if shown.	android
`WindowInsets`	`WindowInsets.Companion.safeContent` The insets that include all areas that may be drawn over or have gesture confusion, including everything in `safeDrawing` and `safeGestures`.	Cmn android
`WindowInsets`	`WindowInsets.Companion.safeDrawing` The insets that include areas where content may be covered by other drawn content.	Cmn android
`WindowInsets`	`WindowInsets.Companion.safeGestures` The insets that include areas where gestures may be confused with other input, including `systemGestures`, `mandatorySystemGestures`, `waterfall`, and `tappableElement`.	Cmn android
`WindowInsets`	`WindowInsets.Companion.statusBars` These insets represent status bar.	Cmn android
`WindowInsets`	`@ExperimentalLayoutApi WindowInsets.Companion.statusBarsIgnoringVisibility` The insets that `WindowInsetsCompat.Type.statusBars` will consume if shown.	android
`WindowInsets`	`WindowInsets.Companion.systemBars` These insets represent all system bars.	Cmn android
`WindowInsets`	`@ExperimentalLayoutApi WindowInsets.Companion.systemBarsIgnoringVisibility` The insets that `WindowInsetsCompat.Type.systemBars` will consume if shown.	android
`WindowInsets`	`WindowInsets.Companion.systemGestures` The `systemGestures` insets represent the area of a window where system gestures have priority and may consume some or all touch input, e.g. due to the system bar occupying it, or it being reserved for touch-only gestures.	Cmn android
`WindowInsets`	`WindowInsets.Companion.tappableElement` Returns the tappable element insets.	Cmn android
`WindowInsets`	`@ExperimentalLayoutApi WindowInsets.Companion.tappableElementIgnoringVisibility` The insets that `WindowInsetsCompat.Type.tappableElement` will consume if active.	android
`WindowInsets`	`WindowInsets.Companion.waterfall` The insets for the curved areas in a waterfall display.	Cmn android

Extension properties

areNavigationBarsVisible

android

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalLayoutApi
val WindowInsets.Companion.areNavigationBarsVisible: Boolean

true when the navigationBars are being displayed, irrespective of whether they intersects with the Window.

areStatusBarsVisible

android

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalLayoutApi
val WindowInsets.Companion.areStatusBarsVisible: Boolean

true when the statusBars are being displayed, irrespective of whether they intersects with the Window.

areSystemBarsVisible

android

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalLayoutApi
val WindowInsets.Companion.areSystemBarsVisible: Boolean

true when the systemBars are being displayed, irrespective of whether they intersects with the Window.

captionBar

Cmn android

Artifact: androidx.compose.foundation:foundation-layout

View Source

val WindowInsets.Companion.captionBar: WindowInsets

An insets type representing the window of a caption bar.

captionBarIgnoringVisibility

android

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalLayoutApi
val WindowInsets.Companion.captionBarIgnoringVisibility: WindowInsets

The insets that the WindowInsetsCompat.Type.captionBar will consume if shown. If it cannot be shown then this will be empty.

displayCutout

Cmn android

Artifact: androidx.compose.foundation:foundation-layout

View Source

val WindowInsets.Companion.displayCutout: WindowInsets

This WindowInsets represents the area with the display cutout (e.g. for camera).

ime

Cmn android

Artifact: androidx.compose.foundation:foundation-layout

View Source

val WindowInsets.Companion.ime: WindowInsets

An insets type representing the window of the software keyboard.

imeAnimationSource

android

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalLayoutApi
val WindowInsets.Companion.imeAnimationSource: WindowInsets

The WindowInsets for the IME before the IME started animating in. The current animated value is WindowInsets.Companion.ime.

This will be the same as imeAnimationTarget when there is no IME animation in progress.

imeAnimationTarget

android

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalLayoutApi
val WindowInsets.Companion.imeAnimationTarget: WindowInsets

The WindowInsets for the IME when the animation completes, if it is allowed to complete successfully. The current animated value is WindowInsets.Companion.ime.

This will be the same as imeAnimationSource when there is no IME animation in progress.

isCaptionBarVisible

android

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalLayoutApi
val WindowInsets.Companion.isCaptionBarVisible: Boolean

true when the caption bar is being displayed, irrespective of whether it intersects with the Window.

isImeVisible

android

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalLayoutApi
val WindowInsets.Companion.isImeVisible: Boolean

true when the soft keyboard is being displayed, irrespective of whether it intersects with the Window.

isTappableElementVisible

android

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalLayoutApi
val WindowInsets.Companion.isTappableElementVisible: Boolean

true when the tappableElement is being displayed, irrespective of whether they intersects with the Window.

mandatorySystemGestures

Cmn android

Artifact: androidx.compose.foundation:foundation-layout

View Source

val WindowInsets.Companion.mandatorySystemGestures: WindowInsets

These insets represent the space where system gestures have priority over application gestures.

navigationBars

Cmn android

Artifact: androidx.compose.foundation:foundation-layout

View Source

val WindowInsets.Companion.navigationBars: WindowInsets

These insets represent where system UI places navigation bars. Interactive UI should avoid the navigation bars area.

navigationBarsIgnoringVisibility

android

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalLayoutApi
val WindowInsets.Companion.navigationBarsIgnoringVisibility: WindowInsets

The insets that WindowInsetsCompat.Type.navigationBars will consume if shown. These insets represent where system UI places navigation bars. Interactive UI should avoid the navigation bars area. If navigation bars cannot be shown, then this will be empty.

safeContent

Cmn android

Artifact: androidx.compose.foundation:foundation-layout

View Source

val WindowInsets.Companion.safeContent: WindowInsets

The insets that include all areas that may be drawn over or have gesture confusion, including everything in safeDrawing and safeGestures.

safeDrawing

Cmn android

Artifact: androidx.compose.foundation:foundation-layout

View Source

val WindowInsets.Companion.safeDrawing: WindowInsets

The insets that include areas where content may be covered by other drawn content. This includes all systemBars, displayCutout, and ime.

safeGestures

Cmn android

Artifact: androidx.compose.foundation:foundation-layout

View Source

val WindowInsets.Companion.safeGestures: WindowInsets

The insets that include areas where gestures may be confused with other input, including systemGestures, mandatorySystemGestures, waterfall, and tappableElement.

statusBars

Cmn android

Artifact: androidx.compose.foundation:foundation-layout

View Source

val WindowInsets.Companion.statusBars: WindowInsets

These insets represent status bar.

statusBarsIgnoringVisibility

android

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalLayoutApi
val WindowInsets.Companion.statusBarsIgnoringVisibility: WindowInsets

The insets that WindowInsetsCompat.Type.statusBars will consume if shown. If the status bar can never be shown, then this will be empty.

systemBars

Cmn android

Artifact: androidx.compose.foundation:foundation-layout

View Source

val WindowInsets.Companion.systemBars: WindowInsets

These insets represent all system bars. Includes statusBars, captionBar as well as navigationBars, but not ime.

systemBarsIgnoringVisibility

android

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalLayoutApi
val WindowInsets.Companion.systemBarsIgnoringVisibility: WindowInsets

The insets that WindowInsetsCompat.Type.systemBars will consume if shown.

If system bars can never be shown, then this will be empty.

systemGestures

Cmn android

Artifact: androidx.compose.foundation:foundation-layout

View Source

val WindowInsets.Companion.systemGestures: WindowInsets

The systemGestures insets represent the area of a window where system gestures have priority and may consume some or all touch input, e.g. due to the system bar occupying it, or it being reserved for touch-only gestures.

tappableElement

Cmn android

Artifact: androidx.compose.foundation:foundation-layout

View Source

val WindowInsets.Companion.tappableElement: WindowInsets

Returns the tappable element insets.

tappableElementIgnoringVisibility

android

Artifact: androidx.compose.foundation:foundation-layout

View Source

@ExperimentalLayoutApi
val WindowInsets.Companion.tappableElementIgnoringVisibility: WindowInsets

The insets that WindowInsetsCompat.Type.tappableElement will consume if active.

If there are never tappable elements then this is empty.

waterfall

Cmn android

Artifact: androidx.compose.foundation:foundation-layout

View Source

val WindowInsets.Companion.waterfall: WindowInsets

The insets for the curved areas in a waterfall display.