迁移到 Indication 和 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 库版本而不迁移

为了解除升级库版本的障碍，您可以使用临时 LocalUseFallbackRippleImplementation CompositionLocal API 来配置 Material 组件以回退到旧行为

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

确保在 MaterialTheme 之外提供此项，以便旧的涟漪可以通过 LocalIndication 提供。

以下部分描述了如何迁移到新的 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 构建的自定义应用主题，则可以安全地将 composition local 作为应用主题的一部分提供

@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 更改给定组件的涟漪颜色/透明度

如上一节所述，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 在主题级别定义涟漪行为。这实质上是自定义设计系统 composition locals 和涟漪之间的集成点。现在，material-ripple 不再公开通用的主题原语，而是公开了一个 createRippleModifierNode() 函数。此函数允许设计系统库创建更高级别的 wrapper 实现，这些实现查询其主题值，然后将涟漪实现委托给此函数创建的节点。

这使得设计系统可以直接查询它们所需的内容，并在其上公开任何所需的用户可配置主题层，而无需符合 material-ripple 层提供的内容。此更改还更明确地说明了涟漪遵循的主题/规范，因为涟漪 API 本身定义了该契约，而不是隐式地从主题派生。

如需指导，请参阅 Material 库中的涟漪 API 实现，并根据您自己的设计系统需要替换对 Material composition locals 的调用。

从 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 非常相似：它公开了一个 ContentDrawScope#draw() 函数，该函数在功能上等同于 IndicationInstance#drawContent()。您需要更改该函数，然后直接在节点内部实现 collectLatest 逻辑，而不是在 Indication 中。

    例如，以下代码段使用了已废弃的 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，以便您可以使用更轻量级的实现。例如，如果 Indication 是 IndicationNodeFactory，则 Modifier.indication 将在内部委托给创建的节点。否则，它将使用 Modifier.composed 调用 rememberUpdatedInstance。