Update accompanist to v0.33.2-alpha (#909)

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [com.google.accompanist:accompanist-systemuicontroller](https://togithub.com/google/accompanist) | `0.33.0-alpha` -> `0.33.2-alpha` | [![age](https://developer.mend.io/api/mc/badges/age/maven/com.google.accompanist:accompanist-systemuicontroller/0.33.2-alpha?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/com.google.accompanist:accompanist-systemuicontroller/0.33.2-alpha?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/com.google.accompanist:accompanist-systemuicontroller/0.33.0-alpha/0.33.2-alpha?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/com.google.accompanist:accompanist-systemuicontroller/0.33.0-alpha/0.33.2-alpha?slim=true)](https://docs.renovatebot.com/merge-confidence/) | | [com.google.accompanist:accompanist-adaptive](https://togithub.com/google/accompanist) | `0.33.0-alpha` -> `0.33.2-alpha` | [![age](https://developer.mend.io/api/mc/badges/age/maven/com.google.accompanist:accompanist-adaptive/0.33.2-alpha?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/com.google.accompanist:accompanist-adaptive/0.33.2-alpha?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/com.google.accompanist:accompanist-adaptive/0.33.0-alpha/0.33.2-alpha?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/com.google.accompanist:accompanist-adaptive/0.33.0-alpha/0.33.2-alpha?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>google/accompanist (com.google.accompanist:accompanist-systemuicontroller)</summary> ### [`v0.33.2-alpha`](https://togithub.com/google/accompanist/releases/tag/v0.33.2-alpha): 🌈 #### What’s Changed - Upgrade Compose to 1.6.0-alpha06 ([#1715](https://togithub.com/google/accompanist/issues/1715)) [@bentrengrove](https://togithub.com/bentrengrove) - Update README.md ([#1711](https://togithub.com/google/accompanist/issues/1711)) [@bentrengrove](https://togithub.com/bentrengrove) - \[Docs] Replace corp URLs with publicly accessible ones ([#1709](https://togithub.com/google/accompanist/issues/1709)) [@msfjarvis](https://togithub.com/msfjarvis) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/ZacSweers/CatchUp).  --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Zac Sweers <[email protected]>
ZacSweers · Oct 19, 2023 · 9da25bc · 9da25bc
1 parent 9c20b2c
commit 9da25bc
Show file tree

Hide file tree

Showing 4 changed files with 235 additions and 14 deletions.
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,5 +1,5 @@
 [versions]
-accompanist = "0.33.0-alpha"
+accompanist = "0.33.2-alpha"
 agp = "8.3.0-alpha07"
 androidx-activity = "1.8.0"
 androidx-core = "1.12.0"

diff --git a/libraries/base-ui/src/main/kotlin/catchup/base/ui/SystemBarColorController.kt b/libraries/base-ui/src/main/kotlin/catchup/base/ui/SystemBarColorController.kt
@@ -0,0 +1,221 @@
+package catchup.base.ui
+
+import android.app.Activity
+import android.content.Context
+import android.content.ContextWrapper
+import android.view.View
+import android.view.Window
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.Stable
+import androidx.compose.runtime.remember
+import androidx.compose.ui.graphics.Color
+import androidx.compose.ui.graphics.compositeOver
+import androidx.compose.ui.graphics.luminance
+import androidx.compose.ui.graphics.toArgb
+import androidx.compose.ui.platform.LocalView
+import androidx.compose.ui.window.DialogWindowProvider
+import androidx.core.view.WindowCompat
+
+/*
+ * This file is a slimmed down implementation of the original deprecated Accompanist
+ * SystemUiController focused just on coloring system bars.
+ */
+
+private const val MIN_DARK_ICONS_LUMINANCE = 0.5f
+
+/**
+ * A class which provides easy-to-use utilities for coloring the System UI bar colors within Jetpack
+ * Compose.
+ */
+@Stable
+interface SystemBarColorController {
+
+  /**
+   * Set the status bar color.
+   *
+   * @param color The **desired** [Color] to set. This may require modification if running on an API
+   *   level that only supports white status bar icons.
+   * @param darkIcons Whether dark status bar icons would be preferable.
+   * @param transformColorForLightContent A lambda which will be invoked to transform [color] if
+   *   dark icons were requested but are not available. Defaults to applying a black scrim.
+   * @see statusBarDarkContentEnabled
+   */
+  fun setStatusBarColor(
+    color: Color,
+    darkIcons: Boolean = color.luminance() > MIN_DARK_ICONS_LUMINANCE,
+    transformColorForLightContent: (Color) -> Color = BlackScrimmed
+  )
+
+  /**
+   * Set the navigation bar color.
+   *
+   * @param color The **desired** [Color] to set. This may require modification if running on an API
+   *   level that only supports white navigation bar icons. Additionally this will be ignored and
+   *   [Color.Transparent] will be used on API 29+ where gesture navigation is preferred or the
+   *   system UI automatically applies background protection in other navigation modes.
+   * @param darkIcons Whether dark navigation bar icons would be preferable.
+   * @param navigationBarContrastEnforced Whether the system should ensure that the navigation bar
+   *   has enough contrast when a fully transparent background is requested. Only supported on API
+   *   29+.
+   * @param transformColorForLightContent A lambda which will be invoked to transform [color] if
+   *   dark icons were requested but are not available. Defaults to applying a black scrim.
+   * @see navigationBarDarkContentEnabled
+   * @see navigationBarContrastEnforced
+   */
+  fun setNavigationBarColor(
+    color: Color,
+    darkIcons: Boolean = color.luminance() > MIN_DARK_ICONS_LUMINANCE,
+    navigationBarContrastEnforced: Boolean = true,
+    transformColorForLightContent: (Color) -> Color = BlackScrimmed
+  )
+
+  /**
+   * Set the status and navigation bars to [color].
+   *
+   * @see setStatusBarColor
+   * @see setNavigationBarColor
+   */
+  fun setSystemBarsColor(
+    color: Color,
+    darkIcons: Boolean = color.luminance() > MIN_DARK_ICONS_LUMINANCE,
+    isNavigationBarContrastEnforced: Boolean = true,
+    transformColorForLightContent: (Color) -> Color = BlackScrimmed
+  ) {
+    setStatusBarColor(color, darkIcons, transformColorForLightContent)
+    setNavigationBarColor(
+      color,
+      darkIcons,
+      isNavigationBarContrastEnforced,
+      transformColorForLightContent
+    )
+  }
+
+  /** Property which holds whether the status bar icons + content are 'dark' or not. */
+  var statusBarDarkContentEnabled: Boolean
+
+  /** Property which holds whether the navigation bar icons + content are 'dark' or not. */
+  var navigationBarDarkContentEnabled: Boolean
+
+  /** Property which holds whether the status & navigation bar icons + content are 'dark' or not. */
+  var systemBarsDarkContentEnabled: Boolean
+    get() = statusBarDarkContentEnabled && navigationBarDarkContentEnabled
+    set(value) {
+      statusBarDarkContentEnabled = value
+      navigationBarDarkContentEnabled = value
+    }
+
+  /**
+   * Property which holds whether the system is ensuring that the navigation bar has enough contrast
+   * when a fully transparent background is requested. Only has an affect when running on Android
+   * API 29+ devices.
+   */
+  var isNavigationBarContrastEnforced: Boolean
+}
+
+/**
+ * Remembers a [SystemBarColorController] for the given [window].
+ *
+ * If no [window] is provided, an attempt to find the correct [Window] is made.
+ *
+ * First, if the [LocalView]'s parent is a [DialogWindowProvider], then that dialog's [Window] will
+ * be used.
+ *
+ * Second, we attempt to find [Window] for the [Activity] containing the [LocalView].
+ *
+ * If none of these are found (such as may happen in a preview), then the functionality of the
+ * returned [SystemBarColorController] will be degraded, but won't throw an exception.
+ */
+@Composable
+fun rememberSystemBarColorController(
+  window: Window? = findWindow(),
+): SystemBarColorController {
+  val view = LocalView.current
+  return remember(view, window) { AndroidSystemBarColorController(view, window) }
+}
+
+@Composable
+private fun findWindow(): Window? =
+  (LocalView.current.parent as? DialogWindowProvider)?.window
+    ?: LocalView.current.context.findWindow()
+
+private tailrec fun Context.findWindow(): Window? =
+  when (this) {
+    is Activity -> window
+    is ContextWrapper -> baseContext.findWindow()
+    else -> null
+  }
+
+/**
+ * A helper class for setting the navigation and status bar colors for a [View], gracefully
+ * degrading behavior based upon API level.
+ *
+ * Typically you would use [rememberSystemBarColorController] to remember an instance of this.
+ */
+internal class AndroidSystemBarColorController(
+  private val view: View,
+  private val window: Window?
+) : SystemBarColorController {
+  private val windowInsetsController = window?.let { WindowCompat.getInsetsController(it, view) }
+
+  override fun setStatusBarColor(
+    color: Color,
+    darkIcons: Boolean,
+    transformColorForLightContent: (Color) -> Color
+  ) {
+    statusBarDarkContentEnabled = darkIcons
+
+    window?.statusBarColor =
+      when {
+        darkIcons && windowInsetsController?.isAppearanceLightStatusBars != true -> {
+          // If we're set to use dark icons, but our windowInsetsController call didn't
+          // succeed (usually due to API level), we instead transform the color to maintain
+          // contrast
+          transformColorForLightContent(color)
+        }
+        else -> color
+      }.toArgb()
+  }
+
+  override fun setNavigationBarColor(
+    color: Color,
+    darkIcons: Boolean,
+    navigationBarContrastEnforced: Boolean,
+    transformColorForLightContent: (Color) -> Color
+  ) {
+    navigationBarDarkContentEnabled = darkIcons
+    isNavigationBarContrastEnforced = navigationBarContrastEnforced
+
+    window?.navigationBarColor =
+      when {
+        darkIcons && windowInsetsController?.isAppearanceLightNavigationBars != true -> {
+          // If we're set to use dark icons, but our windowInsetsController call didn't
+          // succeed (usually due to API level), we instead transform the color to maintain
+          // contrast
+          transformColorForLightContent(color)
+        }
+        else -> color
+      }.toArgb()
+  }
+
+  override var statusBarDarkContentEnabled: Boolean
+    get() = windowInsetsController?.isAppearanceLightStatusBars == true
+    set(value) {
+      windowInsetsController?.isAppearanceLightStatusBars = value
+    }
+
+  override var navigationBarDarkContentEnabled: Boolean
+    get() = windowInsetsController?.isAppearanceLightNavigationBars == true
+    set(value) {
+      windowInsetsController?.isAppearanceLightNavigationBars = value
+    }
+
+  override var isNavigationBarContrastEnforced: Boolean
+    get() = window?.isNavigationBarContrastEnforced == true
+    set(value) {
+      window?.isNavigationBarContrastEnforced = value
+    }
+}
+
+@Suppress("MagicNumber") // This is a constant, detekt doesn't realize it
+private val BlackScrim = Color(0f, 0f, 0f, 0.3f) // 30% opaque black
+private val BlackScrimmed: (Color) -> Color = { original -> BlackScrim.compositeOver(original) }
diff --git a/libraries/compose-extensions/src/main/kotlin/catchup/compose/ConditionalSystemUiColors.kt b/libraries/compose-extensions/src/main/kotlin/catchup/compose/ConditionalSystemUiColors.kt
@@ -4,36 +4,36 @@ import androidx.compose.runtime.Composable
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.setValue
-import com.google.accompanist.systemuicontroller.SystemUiController
-import com.google.accompanist.systemuicontroller.rememberSystemUiController
+import catchup.base.ui.SystemBarColorController
+import catchup.base.ui.rememberSystemBarColorController
 
 class ConditionalSystemUiColors(
-  private val systemUiController: SystemUiController,
+  private val systemBarColorController: SystemBarColorController,
   initialStatusBarDarkContent: Boolean,
   initialNavBarDarkContent: Boolean,
 ) {
   private var storedStatusBarDarkContent by mutableStateOf(initialStatusBarDarkContent)
   private var storedNavBarDarkContent by mutableStateOf(initialNavBarDarkContent)
 
   fun save() {
-    storedStatusBarDarkContent = systemUiController.statusBarDarkContentEnabled
-    storedNavBarDarkContent = systemUiController.navigationBarDarkContentEnabled
+    storedStatusBarDarkContent = systemBarColorController.statusBarDarkContentEnabled
+    storedNavBarDarkContent = systemBarColorController.navigationBarDarkContentEnabled
   }
 
   fun restore() {
-    systemUiController.statusBarDarkContentEnabled = storedStatusBarDarkContent
-    systemUiController.navigationBarDarkContentEnabled = storedNavBarDarkContent
+    systemBarColorController.statusBarDarkContentEnabled = storedStatusBarDarkContent
+    systemBarColorController.navigationBarDarkContentEnabled = storedNavBarDarkContent
   }
 }
 
 // TODO if dark mode changes during this, it will restore the wrong colors. What do we do?
 @Composable
 fun rememberConditionalSystemUiColors(
-  systemUiController: SystemUiController = rememberSystemUiController()
+  systemBarColorController: SystemBarColorController = rememberSystemBarColorController()
 ): ConditionalSystemUiColors {
   return ConditionalSystemUiColors(
-    systemUiController,
-    systemUiController.statusBarDarkContentEnabled,
-    systemUiController.navigationBarDarkContentEnabled
+    systemBarColorController,
+    systemBarColorController.statusBarDarkContentEnabled,
+    systemBarColorController.navigationBarDarkContentEnabled
   )
 }
diff --git a/libraries/summarizer/src/main/kotlin/catchup/summarizer/SummarizerScreen.kt b/libraries/summarizer/src/main/kotlin/catchup/summarizer/SummarizerScreen.kt
@@ -26,13 +26,13 @@ import androidx.compose.ui.text.style.TextAlign
 import androidx.compose.ui.unit.dp
 import catchup.base.ui.BackPressNavButton
 import catchup.base.ui.NavButtonType.CLOSE
+import catchup.base.ui.rememberSystemBarColorController
 import catchup.di.AppScope
 import catchup.summarizer.SummarizerResult.Error
 import catchup.summarizer.SummarizerResult.NotFound
 import catchup.summarizer.SummarizerResult.Success
 import catchup.summarizer.SummarizerScreen.State
 import catchup.summarizer.SummarizerScreen.State.Loading
-import com.google.accompanist.systemuicontroller.rememberSystemUiController
 import com.slack.circuit.codegen.annotations.CircuitInject
 import com.slack.circuit.runtime.CircuitUiState
 import com.slack.circuit.runtime.presenter.Presenter
@@ -94,7 +94,7 @@ constructor(
 @CircuitInject(SummarizerScreen::class, AppScope::class)
 @Composable
 fun Summarizer(state: State, modifier: Modifier = Modifier) {
-  val sysUi = rememberSystemUiController()
+  val sysUi = rememberSystemBarColorController()
   sysUi.setSystemBarsColor(MaterialTheme.colorScheme.surface)
   Surface(modifier.fillMaxSize()) {
     Box(Modifier.systemBarsPadding()) {