关于 WindowInsetsRulers

WindowInsets 是 Jetpack Compose 中的标准 API,用于处理被系统界面部分或完全遮挡的屏幕区域。这些区域包括状态栏、导航栏和屏幕键盘。您也可以将预定义的 WindowInsetsRulers(例如 SafeDrawing)传递给 Modifier.fitInside 或 Modifier.fitOutside,以使内容与系统栏和刘海屏对齐,或创建自定义 WindowInsetsRulers。

WindowInsetsRulers 的优势

  • 避免使用复杂性:它在布局的放置阶段运行。这意味着它会完全绕过边衬区使用链,并且无论父布局执行了什么操作,它始终可以提供系统栏和刘海屏的正确绝对位置。当祖先级可组合项错误地使用边衬区时,使用 Modifier.fitInside 或 Modifier.fitOutside 方法有助于解决问题。
  • 轻松避开系统栏:它有助于应用内容避开系统栏和刘海屏,并且比直接使用 WindowInsets 更简单。
  • 高度可定制:开发者可以将内容与自定义标尺对齐,并通过自定义布局精确控制布局。

WindowInsetsRulers 的缺点

  • 无法用于测量:由于它在放置阶段运行,因此它提供的位置信息在较早的测量阶段不可用。

使用修饰符方法对齐内容

Modifier.fitInside 允许应用将内容与系统栏和刘海屏对齐。可用于代替 WindowInsets。 Modifier.fitOutside 通常是 Modifier.fitInside 的逆矩阵。

例如,如需验证应用内容是否避开了系统栏和刘海屏,您可以使用 fitInside(WindowInsetsRulers.safeDrawing.current)。

@Composable
fun FitInsideDemo(modifier: Modifier) {
    Box(
        modifier = modifier
            .fillMaxSize()
            // Or DisplayCutout, Ime, NavigationBars, StatusBar, etc...
            .fitInside(WindowInsetsRulers.SafeDrawing.current)
    )
}

下表显示了使用 Modifier.fitInside 或 Modifier.fitOutside 的预定义标尺时,应用内容的外观。

预定义标尺类型

Modifier.fitInside

Modifier.fitOutside

DisplayCutout

Ime

不适用

NavigationBars

SafeDrawing

不适用(请改用 StatusBar、CaptionBar、NavigationBar)

StatusBar

使用 Modifier.fitInside 和 Modifier.fitOutside 时,可组合项必须受到约束。这意味着您必须定义 Modifier.size 或 Modifier.fillMaxSize 等修饰符。

SafeDrawing 和 SystemBars 上的 Modifier.fitOutside 等一些统治者会返回多个统治者。在这种情况下,Android 会使用左侧、顶部、右侧、底部的一条标尺来放置可组合项。

使用 Modifier.fitInside 避开 IME

如需使用 Modifier.fitInside 处理具有 IME 的底部元素,请传入一个 RectRuler,该 采用 NavigationBar 和 Ime 的最内层值。

@Composable
fun FitInsideWithImeDemo(modifier: Modifier) {
    Box(
        modifier = modifier
            .fillMaxSize()
            .fitInside(
                RectRulers.innermostOf(
                    WindowInsetsRulers.NavigationBars.current,
                    WindowInsetsRulers.Ime.current
                )
            )
    ) {
        TextField(
            value = "Demo IME Insets",
            onValueChange = {},
            modifier = modifier.align(Alignment.BottomStart).fillMaxWidth()
        )
    }
}

使用 Modifier.fitInside 避开状态栏和标题栏

同样,如需验证顶部元素是否与 Modifier.fitInside 一起避开状态栏和标题栏,请传递一个 RectRuler,该 采用 StatusBars 和 CaptionBar 的最内层值。

@Composable
fun FitInsideWithStatusAndCaptionBarDemo(modifier: Modifier) {
    Box(
        modifier = modifier
            .fillMaxSize()
            .fitInside(
                RectRulers.innermostOf(
                    WindowInsetsRulers.StatusBars.current,
                    WindowInsetsRulers.CaptionBar.current
                )
            )
    )
}

创建自定义 WindowInsetsRulers

您可以将内容与自定义标尺对齐。例如,假设父级可组合项不当处理了边衬区,导致下游子级出现内边距问题。虽然此问题可以通过其他方式解决,包括使用 Modifier.fitInside,但您也可以创建自定义标尺来精确对齐子级可组合项,而无需在上游父级中解决此问题,如以下示例和视频所示:

@Composable
fun WindowInsetsRulersDemo(modifier: Modifier) {
    Box(
        contentAlignment = BottomCenter,
        modifier = modifier
            .fillMaxSize()
            // The mistake that causes issues downstream, as .padding doesn't consume insets.
            // While it's correct to instead use .windowInsetsPadding(WindowInsets.navigationBars),
            // assume it's difficult to identify this issue to see how WindowInsetsRulers can help.
            .padding(WindowInsets.navigationBars.asPaddingValues())
    ) {
        TextField(
            value = "Demo IME Insets",
            onValueChange = {},
            modifier = modifier
                // Use alignToSafeDrawing() instead of .imePadding() to precisely place this child
                // Composable without having to fix the parent upstream.
                .alignToSafeDrawing()

            // .imePadding()
            // .fillMaxWidth()
        )
    }
}

fun Modifier.alignToSafeDrawing(): Modifier {
    return layout { measurable, constraints ->
        if (constraints.hasBoundedWidth && constraints.hasBoundedHeight) {
            val placeable = measurable.measure(constraints)
            val width = placeable.width
            val height = placeable.height
            layout(width, height) {
                val bottom = WindowInsetsRulers.SafeDrawing.current.bottom
                    .current(0f).roundToInt() - height
                val right = WindowInsetsRulers.SafeDrawing.current.right
                    .current(0f).roundToInt()
                val left = WindowInsetsRulers.SafeDrawing.current.left
                    .current(0f).roundToInt()
                measurable.measure(Constraints.fixed(right - left, height))
                    .place(left, bottom)
            }
        } else {
            val placeable = measurable.measure(constraints)
            layout(placeable.width, placeable.height) {
                placeable.place(0, 0)
            }
        }
    }
}

以下视频展示了一个示例:左侧图片中,上游父级导致了 IME 边衬区使用问题;右侧图片中,使用自定义标尺解决了该问题。由于父级未消耗导航栏内边距,因此 TextField 可组合项下方会显示额外的内边距。如前面的代码示例所示,使用自定义标尺将子项放置在右侧图片的正确位置。

验证父级是否受到限制

为了安全地使用 WindowInsetsRulers,请确保父级提供有效的限制条件。父级必须具有定义的尺寸,并且不能依赖于使用 WindowInsetsRulers 的子级的尺寸。在父级可组合项上使用 fillMaxSize 或其他尺寸修饰符。

同样,将使用 WindowInsetsRulers 的可组合项放置在滚动容器(如 verticalScroll)中可能会导致异常行为,因为滚动容器会提供无边界的高度限制,这与标尺的逻辑不兼容。