Merge pull request #135 from tunjid/feature/insets-compat

Update to latest WindowInsetCompat APIs

Author: tunjid

app/src/main/java/com/tunjid/androidx/tabmisc/UiStatePlaygroundFragment.kt

@@ -111,6 +111,14 @@ private var BindingViewHolder<ViewholderUiStateSliceBinding>.slice by viewHolder
 
 private val Context.slices
  get() = listOf<Slice<*>>(
+ Slice(
+ name = "Status bar color",
+ nameTransformer = Int::stringHex,
+ options = listOf(Color.TRANSPARENT, Color.parseColor("#80000000"), Color.BLACK, Color.WHITE, Color.RED, Color.GREEN, Color.BLUE),
+ getter = UiState::statusBarColor
+ ) {
+ copy(statusBarColor = it)
+ },
  Slice(
  name = "Has light status bar icons",
  options = listOf(true, false),

app/src/main/java/com/tunjid/androidx/uidrivers/GlobalUiDriver.kt

@@ -2,6 +2,7 @@ package com.tunjid.androidx.uidrivers
 
 import android.animation.ArgbEvaluator
 import android.animation.ValueAnimator
+import android.annotation.SuppressLint
 import android.graphics.Color
 import android.graphics.drawable.GradientDrawable
 import android.os.Build
@@ -14,6 +15,9 @@ import android.widget.EditText
 import androidx.annotation.ColorInt
 import androidx.annotation.DrawableRes
 import androidx.core.graphics.ColorUtils
+import androidx.core.view.WindowCompat
+import androidx.core.view.WindowInsetsCompat
+import androidx.core.view.WindowInsetsControllerCompat
 import androidx.core.view.doOnLayout
 import androidx.core.view.isVisible
 import androidx.core.view.updateLayoutParams
@@ -38,6 +42,7 @@ import com.tunjid.androidx.view.animator.ViewHider
 import com.tunjid.androidx.view.util.PaddingProperty
 import com.tunjid.androidx.view.util.innermostFocusedChild
 import com.tunjid.androidx.view.util.spring
+import com.tunjid.androidx.view.util.viewDelegate
 import com.tunjid.androidx.view.util.withOneShotEndListener
 import kotlin.math.max
 
@@ -92,9 +97,10 @@ class GlobalUiDriver(
  private val uiSizes = UISizes(host)
  private val fabExtensionAnimator = FabExtensionAnimator(binding.fab)
  private val toolbarHider = ViewHider.of(binding.toolbar).setDirection(ViewHider.TOP).build()
+ private val insetsController = WindowInsetsControllerCompat(host.window, binding.root)
  private val noOpInsetsListener = View.OnApplyWindowInsetsListener { _, insets -> insets }
  private val rootInsetsListener = View.OnApplyWindowInsetsListener { _, insets ->
- liveUiState.value = uiState.reduceSystemInsets(insets, uiSizes.navBarHeightThreshold)
+ liveUiState.value = uiState.reduceSystemInsets(WindowInsetsCompat.toWindowInsetsCompat(insets), uiSizes.navBarHeightThreshold)
  // Consume insets so other views will not see them.
  insets.consumeSystemWindowInsets()
  }
@@ -144,6 +150,7 @@ class GlobalUiDriver(
 
  UiState::snackbarText.distinct onChanged this::showSnackBar
  UiState::navBarColor.distinct onChanged this::setNavBarColor
+ UiState::statusBarColor.distinct onChanged host.window::setStatusBarColor
  UiState::lightStatusBar.distinct onChanged this::setLightStatusBar
  UiState::fragmentContainerState.distinct onChanged this::updateFragmentContainer
  UiState::backgroundColor.distinct onChanged binding.contentRoot::animateBackground
@@ -221,39 +228,20 @@ class GlobalUiDriver(
  GradientDrawable.Orientation.BOTTOM_TOP,
  intArrayOf(color, Color.TRANSPARENT))
 
- if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) uiFlagTweak {
- if (color.isBrightColor) it or View.SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR
- else it and View.SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR.inv()
- }
+ insetsController.isAppearanceLightNavigationBars = color.isBrightColor
  }
 
- private fun updateImmersivity(isImmersive: Boolean) = uiFlagTweak { systemUiFlags ->
- when (isImmersive) {
- true -> (systemUiFlags
- or View.SYSTEM_UI_FLAG_FULLSCREEN
- or View.SYSTEM_UI_FLAG_HIDE_NAVIGATION
- or View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY
- )
- false -> (systemUiFlags
- and View.SYSTEM_UI_FLAG_FULLSCREEN.inv()
- and View.SYSTEM_UI_FLAG_HIDE_NAVIGATION.inv()
- and View.SYSTEM_UI_FLAG_IMMERSIVE_STICKY.inv()
- )
- }
+ private fun updateImmersivity(isImmersive: Boolean) {
+ val systemBarsSetter = if (isImmersive) insetsController::hide else insetsController::show
+ systemBarsSetter.invoke(WindowInsetsCompat.Type.statusBars() or WindowInsetsCompat.Type.navigationBars())
+ insetsController.systemBarsBehavior = WindowInsetsControllerCompat.BEHAVIOR_SHOW_TRANSIENT_BARS_BY_SWIPE
  }
 
  private fun setLightStatusBar(lightStatusBar: Boolean) = when {
- Build.VERSION.SDK_INT >= Build.VERSION_CODES.M -> uiFlagTweak { flags ->
- if (lightStatusBar) flags or View.SYSTEM_UI_FLAG_LIGHT_STATUS_BAR
- else flags and View.SYSTEM_UI_FLAG_LIGHT_STATUS_BAR.inv()
- }
+ Build.VERSION.SDK_INT >= Build.VERSION_CODES.M -> insetsController.isAppearanceLightStatusBars = lightStatusBar
  else -> host.window.statusBarColor = host.colorAt(if (lightStatusBar) R.color.transparent else R.color.black_50)
  }
 
- private fun uiFlagTweak(tweaker: (Int) -> Int) = host.window.decorView.run {
- systemUiVisibility = tweaker(systemUiVisibility)
- }
-
  private fun setFabGlyphs(fabGlyphState: Pair<Int, CharSequence>) = host.runOnUiThread {
  val (@DrawableRes icon: Int, title: CharSequence) = fabGlyphState
  fabExtensionAnimator.updateGlyphs(title, if (icon != 0) host.drawableAt(icon) else null)
@@ -285,14 +273,17 @@ class GlobalUiDriver(
  private val <T : Any?> ((UiState) -> T).distinct get() = liveUiState.map(this).distinctUntilChanged()
 }
 
+private var View.backgroundAnimator by viewDelegate<ValueAnimator?>()
+
+@SuppressLint("Recycle")
 private fun View.animateBackground(@ColorInt to: Int) {
- val animator = getTag(R.id.doggo_image) as? ValueAnimator
- ?: ValueAnimator().apply {
-  setTag(R.id.doggo_image, this)
-  setIntValues(Color.TRANSPARENT)
-  setEvaluator(ArgbEvaluator())
-  addUpdateListener { setBackgroundColor(it.animatedValue as Int) }
-  }
+ val animator = backgroundAnimator ?: ValueAnimator().apply {
+ setTag(R.id.doggo_image, this)
+ setIntValues(Color.TRANSPARENT)
+ setEvaluator(ArgbEvaluator())
+ addUpdateListener { setBackgroundColor(it.animatedValue as Int) }
+ backgroundAnimator = this
+ }
 
  if (animator.isRunning) animator.cancel()
  animator.setIntValues(animator.animatedValue as Int, to)
@@ -324,12 +315,7 @@ private fun Window.assumeControl() {
  windowAttributes.layoutInDisplayCutoutMode = WindowManager.LayoutParams.LAYOUT_IN_DISPLAY_CUTOUT_MODE_SHORT_EDGES
  attributes = windowAttributes
  }
- decorView.systemUiVisibility = FULL_CONTROL_SYSTEM_UI_FLAGS
+ WindowCompat.setDecorFitsSystemWindows(this, false)
  navigationBarColor = context.colorAt(R.color.transparent)
  statusBarColor = context.colorAt(R.color.transparent)
 }
-
-private const val FULL_CONTROL_SYSTEM_UI_FLAGS =
- View.SYSTEM_UI_FLAG_LAYOUT_STABLE or
- View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION or
- View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN

app/src/main/java/com/tunjid/androidx/uidrivers/SystemManagedUI.kt

@@ -1,6 +1,7 @@
 package com.tunjid.androidx.uidrivers
 
-import android.view.WindowInsets
+import androidx.core.graphics.Insets
+import androidx.core.view.WindowInsetsCompat
 
 /**
  * Interface for system managed bits of global ui that we react to, but do not explicitly request
@@ -20,10 +21,11 @@ interface StaticSystemUI {
 }
 
 interface DynamicSystemUI {
- val leftInset: Int
- val topInset: Int
- val rightInset: Int
- val bottomInset: Int
+ val statusBars: Insets
+ val navBars: Insets
+ val cutouts: Insets
+ val captions: Insets
+ val ime: Insets
  val snackbarHeight: Int
 }
 
@@ -38,10 +40,11 @@ data class DelegateStaticSystemUI(
 ) : StaticSystemUI
 
 data class DelegateDynamicSystemUI internal constructor(
- override val leftInset: Int,
- override val topInset: Int,
- override val rightInset: Int,
- override val bottomInset: Int,
+ override val statusBars: Insets,
+ override val navBars: Insets,
+ override val cutouts: Insets,
+ override val captions: Insets,
+ override val ime: Insets,
  override val snackbarHeight: Int
 ) : DynamicSystemUI
 
@@ -56,28 +59,35 @@ fun SystemUI.updateSnackbarHeight(snackbarHeight: Int) = when (this) {
  else -> this
 }
 
-fun UiState.reduceSystemInsets(windowInsets: WindowInsets, navBarHeightThreshold: Int): UiState {
+fun UiState.reduceSystemInsets(windowInsets: WindowInsetsCompat, navBarHeightThreshold: Int): UiState {
  // Do this once, first call is the size
  val currentSystemUI = systemUI
  val currentStaticSystemUI = currentSystemUI.static
 
+ val statusBars = windowInsets.getInsets(WindowInsetsCompat.Type.statusBars())
+ val navBars = windowInsets.getInsets(WindowInsetsCompat.Type.navigationBars())
+ val cutouts = windowInsets.getInsets(WindowInsetsCompat.Type.displayCutout())
+ val captions = windowInsets.getInsets(WindowInsetsCompat.Type.captionBar())
+ val ime = windowInsets.getInsets(WindowInsetsCompat.Type.ime())
+
  val updatedStaticUI = when {
  currentStaticSystemUI !is DelegateStaticSystemUI -> DelegateStaticSystemUI(
- statusBarSize = windowInsets.systemWindowInsetTop,
- navBarSize = windowInsets.systemWindowInsetBottom
+ statusBarSize = statusBars.top,
+ navBarSize = navBars.bottom
  )
- windowInsets.systemWindowInsetBottom < navBarHeightThreshold -> DelegateStaticSystemUI(
+ navBars.bottom < navBarHeightThreshold -> DelegateStaticSystemUI(
  statusBarSize = currentStaticSystemUI.statusBarSize,
- navBarSize = windowInsets.systemWindowInsetBottom
+ navBarSize = navBars.bottom
  )
  else -> currentStaticSystemUI
  }
 
  val updatedDynamicUI = DelegateDynamicSystemUI(
- leftInset = windowInsets.systemWindowInsetLeft,
- topInset = windowInsets.systemWindowInsetTop,
- rightInset = windowInsets.systemWindowInsetRight,
- bottomInset = windowInsets.systemWindowInsetBottom,
+ statusBars = statusBars,
+ navBars = navBars,
+ cutouts = cutouts,
+ captions = captions,
+ ime = ime,
  snackbarHeight = currentSystemUI.dynamic.snackbarHeight
  )
 
@@ -102,14 +112,18 @@ private object NoOpStaticSystemUI : StaticSystemUI {
 }
 
 private object NoOpDynamicSystemUI : DynamicSystemUI {
- override val leftInset: Int
- get() = 0
- override val topInset: Int
- get() = 0
- override val bottomInset: Int
- get() = 0
- override val rightInset: Int
- get() = 0
+ override val statusBars: Insets
+ get() = emptyInsets
+ override val navBars: Insets
+ get() = emptyInsets
+ override val cutouts: Insets
+ get() = emptyInsets
+ override val captions: Insets
+ get() = emptyInsets
+ override val ime: Insets
+ get() = emptyInsets
  override val snackbarHeight: Int
  get() = 0
 }
+
+private val emptyInsets = Insets.of(0, 0, 0, 0)

app/src/main/java/com/tunjid/androidx/uidrivers/UiState.kt

@@ -7,6 +7,7 @@ import android.view.View
 import androidx.annotation.ColorInt
 import androidx.annotation.DrawableRes
 import androidx.annotation.MenuRes
+import androidx.core.graphics.Insets
 import androidx.dynamicanimation.animation.SpringAnimation
 import androidx.lifecycle.Lifecycle
 import androidx.lifecycle.LifecycleOwner
@@ -16,6 +17,7 @@ import kotlin.reflect.KMutableProperty0
 fun KMutableProperty0<UiState>.updatePartial(updater: UiState.() -> UiState) = set(updater.invoke(get()))
 
 data class UiState(
+ val statusBarColor: Int = Color.TRANSPARENT,
  @param:MenuRes
  @field:MenuRes
  @get:MenuRes
@@ -69,7 +71,7 @@ internal data class ToolbarState(
 
 internal data class SnackbarPositionalState(
  val bottomNavVisible: Boolean,
- override val bottomInset: Int,
+ override val ime: Insets,
  override val navBarSize: Int,
  override val insetDescriptor: InsetDescriptor
 ) : KeyboardAware
@@ -78,7 +80,7 @@ internal data class FabPositionalState(
  val fabVisible: Boolean,
  val bottomNavVisible: Boolean,
  val snackbarHeight: Int,
- override val bottomInset: Int,
+ override val ime: Insets,
  override val navBarSize: Int,
  override val insetDescriptor: InsetDescriptor
 ) : KeyboardAware
@@ -87,7 +89,7 @@ internal data class FragmentContainerPositionalState(
  val statusBarSize: Int,
  val toolbarOverlaps: Boolean,
  val bottomNavVisible: Boolean,
- override val bottomInset: Int,
+ override val ime: Insets,
  override val navBarSize: Int,
  override val insetDescriptor: InsetDescriptor
 ) : KeyboardAware
@@ -109,15 +111,15 @@ internal val UiState.fabState
  fabVisible = fabShows,
  snackbarHeight = systemUI.dynamic.snackbarHeight,
  bottomNavVisible = showsBottomNav == true,
- bottomInset = systemUI.dynamic.bottomInset,
+ ime = systemUI.dynamic.ime,
  navBarSize = systemUI.static.navBarSize,
  insetDescriptor = insetFlags
  )
 
 internal val UiState.snackbarPositionalState
  get() = SnackbarPositionalState(
  bottomNavVisible = showsBottomNav == true,
- bottomInset = systemUI.dynamic.bottomInset,
+ ime = systemUI.dynamic.ime,
  navBarSize = systemUI.static.navBarSize,
  insetDescriptor = insetFlags
  )
@@ -137,11 +139,11 @@ internal val UiState.bottomNavPositionalState
 
 internal val UiState.fragmentContainerState
  get() = FragmentContainerPositionalState(
- statusBarSize = systemUI.dynamic.topInset,
+ statusBarSize = systemUI.static.statusBarSize,
  insetDescriptor = insetFlags,
  toolbarOverlaps = toolbarOverlaps,
  bottomNavVisible = showsBottomNav == true,
- bottomInset = systemUI.dynamic.bottomInset,
+ ime = systemUI.dynamic.ime,
  navBarSize = systemUI.static.navBarSize
  )
 
@@ -150,9 +152,9 @@ internal val UiState.fragmentContainerState
  * keyboard visibility changes for bottom aligned views like Floating Action Buttons and Snack Bars
  */
 interface KeyboardAware {
- val bottomInset: Int
+ val ime: Insets
  val navBarSize: Int
  val insetDescriptor: InsetDescriptor
 }
 
-internal val KeyboardAware.keyboardSize get() = bottomInset - navBarSize
+internal val KeyboardAware.keyboardSize get() = ime.bottom - navBarSize

build.gradle

@@ -16,9 +16,9 @@ buildscript {
  classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
  }
  project.ext {
- buildToolsVersion = "29.0.2"
- compileSdkVersion = 29
- targetSdkVersion = 29
+ buildToolsVersion = "29.0.3"
+ compileSdkVersion = 30
+ targetSdkVersion = 30
  minSdkVersion = 21
 
  appCompat = 'androidx.appcompat:appcompat:1.3.0'