迁移到 Indication API 和 Ripple API

为了提高使用 Modifier.clickable 的互动组件的合成性能，我们引入了新的 API。这些 API 可实现更高效的 Indication 实现，例如涟漪。

androidx.compose.foundation:foundation:1.7.0+ 和 androidx.compose.material:material-ripple:1.7.0+ 包含以下 API 变更：

已弃用

替换

Indication#rememberUpdatedInstance

IndicationNodeFactory

rememberRipple()

改为在 Material 库中提供新的 ripple() API。

注意：在此上下文中，“Material 库”是指 androidx.compose.material:material、androidx.compose.material3:material3、androidx.wear.compose:compose-material 和 androidx.wear.compose:compose-material3.

RippleTheme

请执行以下任一操作：

  • 使用 Material 库 RippleConfiguration API，或
  • 构建您自己的设计系统涟漪实现

本页介绍了行为变更的影响，以及迁移到新 API 的说明。

行为变更

以下库版本包含涟漪行为变更：

  • androidx.compose.material:material:1.7.0+
  • androidx.compose.material3:material3:1.3.0+
  • androidx.wear.compose:compose-material:1.4.0+

这些版本的 Material 库不再使用 rememberRipple()，而是使用新的涟漪 API。因此，它们不会查询 LocalRippleTheme。因此，如果您在应用中设置了 LocalRippleTheme，Material 组件将不会使用这些值。

以下部分介绍了如何迁移到新版 API。

从 rememberRipple 迁移到 ripple

使用 Material 库

如果您使用的是 Material 库，请直接将 rememberRipple() 替换为对相应库中 ripple() 的调用。此 API 使用从 Material 主题 API 派生的值创建涟漪。然后，将返回的对象传递给 Modifier.clickable 和/或其他组件。

例如，以下代码段使用了已弃用的 API：

Box(
    Modifier.clickable(
        onClick = {},
        interactionSource = remember { MutableInteractionSource() },
        indication = rememberRipple()
    )
) {
    // ...
}
UserInteractions.kt

您应将上述代码段修改为：

@Composable
private fun RippleExample() {
    Box(
        Modifier.clickable(
            onClick = {},
            interactionSource = remember { MutableInteractionSource() },
            indication = ripple()
        )
    ) {
        // ...
    }
}
UserInteractions.kt

请注意，ripple() 不再是可组合函数，因此无需记忆。它还可以像修饰符一样在多个组件中重复使用，因此请考虑将涟漪创建提取到顶级值，以节省分配。

实现自定义设计系统

如果您要实现自己的设计系统，并且之前使用 rememberRipple() 以及自定义 RippleTheme 来配置涟漪，则应改为提供自己的涟漪 API，该 API 会委托给 material-ripple 中公开的涟漪节点 API。然后，您的组件可以使用直接使用主题值的自定义涟漪。如需了解详情，请参阅从 RippleTheme 迁移。

从 RippleTheme 迁移

暂时选择停用行为变更

Material 库具有临时 CompositionLocal、LocalUseFallbackRippleImplementation，您可以使用它们将所有 Material 组件配置为回退到使用 rememberRipple。这样，rememberRipple 会继续查询 LocalRippleTheme。

以下代码段演示了如何使用 LocalUseFallbackRippleImplementation CompositionLocal API：

CompositionLocalProvider(LocalUseFallbackRippleImplementation provides true) {
    MaterialTheme {
        App()
    }
}
UserInteractions.kt

如果您使用的是基于 Material 构建的自定义应用主题，则可以安全地将组合本地变量作为应用主题的一部分提供：

@OptIn(ExperimentalMaterial3Api::class)
@Composable
fun MyAppTheme(content: @Composable () -> Unit) {
    CompositionLocalProvider(LocalUseFallbackRippleImplementation provides true) {
        MaterialTheme(content = content)
    }
}
UserInteractions.kt

如需了解详情，请参阅在不迁移的情况下升级 Material 库版本部分。

使用 RippleTheme 为指定组件停用涟漪效果

material 和 material3 库公开了 RippleConfiguration 和 LocalRippleConfiguration，可让您配置子树中涟漪的外观。请注意，RippleConfiguration 和 LocalRippleConfiguration 是实验性的，仅用于按组件进行自定义。这些 API 不支持全局/主题级自定义；如需详细了解该使用情形，请参阅使用 RippleTheme 全局更改应用中的所有涟漪。

例如，以下代码段使用了已弃用的 API：

private object DisabledRippleTheme : RippleTheme {

    @Composable
    override fun defaultColor(): Color = Color.Transparent

    @Composable
    override fun rippleAlpha(): RippleAlpha = RippleAlpha(0f, 0f, 0f, 0f)
}

// ...
    CompositionLocalProvider(LocalRippleTheme provides DisabledRippleTheme) {
        Button {
            // ...
        }
    }
UserInteractions.kt

您应将上述代码段修改为：

CompositionLocalProvider(LocalRippleConfiguration provides null) {
    Button {
        // ...
    }
}
UserInteractions.kt

使用 RippleTheme 更改给定组件的涟漪的颜色/Alpha 值

如上一部分所述，RippleConfiguration 和 LocalRippleConfiguration 是实验性 API，仅用于按组件自定义。

例如，以下代码段使用了已弃用的 API：

private object DisabledRippleThemeColorAndAlpha : RippleTheme {

    @Composable
    override fun defaultColor(): Color = Color.Red

    @Composable
    override fun rippleAlpha(): RippleAlpha = MyRippleAlpha
}

// ...
    CompositionLocalProvider(LocalRippleTheme provides DisabledRippleThemeColorAndAlpha) {
        Button {
            // ...
        }
    }
UserInteractions.kt

您应将上述代码段修改为：

@OptIn(ExperimentalMaterialApi::class)
private val MyRippleConfiguration =
    RippleConfiguration(color = Color.Red, rippleAlpha = MyRippleAlpha)

// ...
    CompositionLocalProvider(LocalRippleConfiguration provides MyRippleConfiguration) {
        Button {
            // ...
        }
    }
UserInteractions.kt

使用 RippleTheme 全局更改应用中的所有涟漪

之前，您可以使用 LocalRippleTheme 在主题级定义涟漪行为。这实际上是自定义设计系统 CompositionLocal 与涟漪之间的集成点。material-ripple 现在公开的是 createRippleModifierNode() 函数，而不是通用的主题设置原语。此函数允许设计系统库创建更高级别的 wrapper 实现，该实现会查询其主题值，然后将涟漪实现委托给此函数创建的节点。

这样一来，设计系统就可以直接查询所需内容，并在顶部公开任何所需的用户可配置主题层，而无需遵循 material-ripple 层提供的样式。此更改还更明确地说明了水波纹所遵循的主题/规范，因为定义该协定的是水波纹 API 本身，而不是从主题隐式派生出来的。

如需相关指导，请参阅 Material 库中的水波纹 API 实现，并根据您自己的设计系统替换对 Material 组合本地变量的调用。

从 Indication 迁移到 IndicationNodeFactory

传递 Indication

如果您只是创建 Indication 以便传递，例如创建要传递给 Modifier.clickable 或 Modifier.indication 的涟漪，则无需进行任何更改。IndicationNodeFactory 继承自 Indication，因此一切都会继续编译和运行。

正在创建“Indication”

如果您要创建自己的 Indication 实现，在大多数情况下，迁移应该很简单。例如，假设有一个 Indication，用于在按压时应用缩放效果：

object ScaleIndication : Indication {
    @Composable
    override fun rememberUpdatedInstance(interactionSource: InteractionSource): IndicationInstance {
        // key the remember against interactionSource, so if it changes we create a new instance
        val instance = remember(interactionSource) { ScaleIndicationInstance() }

        LaunchedEffect(interactionSource) {
            interactionSource.interactions.collectLatest { interaction ->
                when (interaction) {
                    is PressInteraction.Press -> instance.animateToPressed(interaction.pressPosition)
                    is PressInteraction.Release -> instance.animateToResting()
                    is PressInteraction.Cancel -> instance.animateToResting()
                }
            }
        }

        return instance
    }
}

private class ScaleIndicationInstance : IndicationInstance {
    var currentPressPosition: Offset = Offset.Zero
    val animatedScalePercent = Animatable(1f)

    suspend fun animateToPressed(pressPosition: Offset) {
        currentPressPosition = pressPosition
        animatedScalePercent.animateTo(0.9f, spring())
    }

    suspend fun animateToResting() {
        animatedScalePercent.animateTo(1f, spring())
    }

    override fun ContentDrawScope.drawIndication() {
        scale(
            scale = animatedScalePercent.value,
            pivot = currentPressPosition
        ) {
            this@drawIndication.drawContent()
        }
    }
}
UserInteractions.kt

您可以通过以下两个步骤迁移此数据：

  1. 将 ScaleIndicationInstance 迁移为 DrawModifierNode。DrawModifierNode 的 API 表面与 IndicationInstance 非常相似：它公开了一个在功能上等效于 IndicationInstance#drawContent() 的 ContentDrawScope#draw() 函数。您需要更改该函数，然后直接在节点内（而不是在 Indication 内）实现 collectLatest 逻辑。

    例如，以下代码段使用了已弃用的 API：

    private class ScaleIndicationInstance : IndicationInstance {
    var currentPressPosition: Offset = Offset.Zero
    val animatedScalePercent = Animatable(1f)

    suspend fun animateToPressed(pressPosition: Offset) {
        currentPressPosition = pressPosition
        animatedScalePercent.animateTo(0.9f, spring())
    }

    suspend fun animateToResting() {
        animatedScalePercent.animateTo(1f, spring())
    }

    override fun ContentDrawScope.drawIndication() {
        scale(
            scale = animatedScalePercent.value,
            pivot = currentPressPosition
        ) {
            this@drawIndication.drawContent()
        }
    }
}
    UserInteractions.kt

    您应将上述代码段修改为：

    private class ScaleIndicationNode(
    private val interactionSource: InteractionSource
) : Modifier.Node(), DrawModifierNode {
    var currentPressPosition: Offset = Offset.Zero
    val animatedScalePercent = Animatable(1f)

    private suspend fun animateToPressed(pressPosition: Offset) {
        currentPressPosition = pressPosition
        animatedScalePercent.animateTo(0.9f, spring())
    }

    private suspend fun animateToResting() {
        animatedScalePercent.animateTo(1f, spring())
    }

    override fun onAttach() {
        coroutineScope.launch {
            interactionSource.interactions.collectLatest { interaction ->
                when (interaction) {
                    is PressInteraction.Press -> animateToPressed(interaction.pressPosition)
                    is PressInteraction.Release -> animateToResting()
                    is PressInteraction.Cancel -> animateToResting()
                }
            }
        }
    }

    override fun ContentDrawScope.draw() {
        scale(
            scale = animatedScalePercent.value,
            pivot = currentPressPosition
        ) {
            this@draw.drawContent()
        }
    }
}
    UserInteractions.kt

  2. 迁移 ScaleIndication 以实现 IndicationNodeFactory。由于收集逻辑现在已移至节点中，因此这是一个非常简单的工厂对象，其唯一职责是创建节点实例。

    例如，以下代码段使用了已弃用的 API：

    object ScaleIndication : Indication {
    @Composable
    override fun rememberUpdatedInstance(interactionSource: InteractionSource): IndicationInstance {
        // key the remember against interactionSource, so if it changes we create a new instance
        val instance = remember(interactionSource) { ScaleIndicationInstance() }

        LaunchedEffect(interactionSource) {
            interactionSource.interactions.collectLatest { interaction ->
                when (interaction) {
                    is PressInteraction.Press -> instance.animateToPressed(interaction.pressPosition)
                    is PressInteraction.Release -> instance.animateToResting()
                    is PressInteraction.Cancel -> instance.animateToResting()
                }
            }
        }

        return instance
    }
}
    UserInteractions.kt

    您应将上述代码段修改为：

    object ScaleIndicationNodeFactory : IndicationNodeFactory {
    override fun create(interactionSource: InteractionSource): DelegatableNode {
        return ScaleIndicationNode(interactionSource)
    }

    override fun hashCode(): Int = -1

    override fun equals(other: Any?) = other === this
}
    UserInteractions.kt

使用 Indication 创建 IndicationInstance

在大多数情况下，您应使用 Modifier.indication 为组件显示 Indication。不过，如果您使用 rememberUpdatedInstance 手动创建 IndicationInstance（这种情况很少见），则需要更新实现，以检查 Indication 是否为 IndicationNodeFactory，以便使用更轻量级的实现。例如，如果 Modifier.indication 是 IndicationNodeFactory，则会在内部委托给创建的节点。如果不是，它将使用 Modifier.composed 来调用 rememberUpdatedInstance。