WindowInsetsControllerCompat

const val BEHAVIOR_DEFAULT = 1: Int

The default option for setSystemBarsBehavior: Window would like to remain interactive when hiding navigation bars by calling hide or setInsetsAndAlpha.

When system bars are hidden in this mode, they can be revealed with system gestures, such as swiping from the edge of the screen where the bar is hidden from.

When the gesture navigation is enabled, the system gestures can be triggered regardless the visibility of system bars.

const val BEHAVIOR_SHOW_BARS_BY_SWIPE = 1: Int

Option for setSystemBarsBehavior: Window would like to remain interactive when hiding navigation bars by calling hide or setInsetsAndAlpha.

When system bars are hidden in this mode, they can be revealed with system gestures, such as swiping from the edge of the screen where the bar is hidden from.

const val BEHAVIOR_SHOW_BARS_BY_TOUCH = 0: Int

Option for setSystemBarsBehavior. System bars will be forcibly shown on any user interaction on the corresponding display if navigation bars are hidden by hide or setInsetsAndAlpha.

const val BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE = 2: Int

Option for setSystemBarsBehavior: Window would like to remain interactive when hiding navigation bars by calling hide or setInsetsAndAlpha.

When system bars are hidden in this mode, they can be revealed temporarily with system gestures, such as swiping from the edge of the screen where the bar is hidden from. These transient system bars will overlay app’s content, may have some degree of transparency, and will automatically hide after a short timeout.

fun addOnControllableInsetsChangedListener(
    listener: WindowInsetsControllerCompat.OnControllableInsetsChangedListener
): Unit

Adds a WindowInsetsController.OnControllableInsetsChangedListener to the window insets controller.

fun controlWindowInsetsAnimation(
    types: Int,
    durationMillis: Long,
    interpolator: Interpolator?,
    cancellationSignal: CancellationSignal?,
    listener: WindowInsetsAnimationControlListenerCompat
): Unit

Lets the application control window inset animations in a frame-by-frame manner by modifying the position of the windows in the system causing insets directly using setInsetsAndAlpha in the controller provided by the given listener.

This method only works on API >= 30 since there is no way to control the window in the system on prior APIs.

fun getSystemBarsBehavior(): Int

Retrieves the requested behavior of system bars.

fun hide(types: Int): Unit

Makes a set of windows causing insets disappear.

Note that if the window currently doesn't have control over a certain type, it will apply the change as soon as the window gains control. The app can listen to the event by observing onApplyWindowInsets and checking visibility with isVisible.

fun isAppearanceLightNavigationBars(): Boolean

Checks if the foreground of the navigation bar is set to light.

This method always returns false on API <26.

If this value is being set in the theme (via windowLightNavigationBar), then the correct value will only be returned once attached to the window.

Once this method is called, modifying `systemUiVisibility` directly to change the appearance is undefined behavior.

fun isAppearanceLightStatusBars(): Boolean

Checks if the foreground of the status bar is set to light.

If this value is being set in the theme (via windowLightStatusBar), then the correct value will only be returned once attached to the window.

Once this method is called, modifying `systemUiVisibility` directly to change the appearance is undefined behavior.

fun removeOnControllableInsetsChangedListener(
    listener: WindowInsetsControllerCompat.OnControllableInsetsChangedListener
): Unit

Removes a WindowInsetsController.OnControllableInsetsChangedListener from the window insets controller.

fun setAppearanceLightNavigationBars(isLight: Boolean): Unit

If true, changes the foreground color of the navigation bars to light so that the items on the bar can be read clearly. If false, reverts to the default appearance.

This method has no effect on API <26.

Once this method is called, modifying `systemUiVisibility` directly to change the appearance is undefined behavior.

fun setAppearanceLightStatusBars(isLight: Boolean): Unit

If true, changes the foreground color of the status bars to light so that the items on the bar can be read clearly. If false, reverts to the default appearance.

Once this method is called, modifying `systemUiVisibility` directly to change the appearance is undefined behavior.

fun setSystemBarsBehavior(behavior: Int): Unit

Controls the behavior of system bars.

fun show(types: Int): Unit

Makes a set of windows that cause insets appear on screen.

Note that if the window currently doesn't have control over a certain type, it will apply the change as soon as the window gains control. The app can listen to the event by observing onApplyWindowInsets and checking visibility with isVisible.

@RequiresApi(value = 30)
java-static fun toWindowInsetsControllerCompat(
    insetsController: WindowInsetsController
): WindowInsetsControllerCompat

Wrap a WindowInsetsController into a WindowInsetsControllerCompat for compatibility purpose.