rememberRipple

Composable Function

Common

Deprecated rememberRipple has been deprecated - it returns an old Indication implementation that is not compatible with the new Indication APIs that provide notable performance improvements. Instead, use the new ripple APIs provided by design system libraries, such as material and material3. If you are implementing your own design system library, use createRippleNode to create your own custom ripple implementation that queries your own theme values. For a migration guide and background information, please visit developer.android.com

@Composable
public fun rememberRipple(
    bounded: Boolean = true,
    radius: Dp = Dp.Unspecified,
    color: Color = Color.Unspecified,
): Indication

Creates and remembers a Ripple using values provided by RippleTheme.

A Ripple is a Material implementation of Indication that expresses different Interactions by drawing ripple animations and state layers.

A Ripple responds to PressInteraction.Press by starting a new RippleAnimation, and responds to other Interactions by showing a fixed StateLayer with varying alpha values depending on the Interaction.

If you are using MaterialTheme in your hierarchy, a Ripple will be used as the default Indication inside components such as androidx.compose.foundation.clickable and androidx.compose.foundation.indication. You can also manually provide Ripples through androidx.compose.foundation.LocalIndication for the same effect if you are not using MaterialTheme.

You can also explicitly create a Ripple and provide it to components in order to change the parameters from the default, such as to create an unbounded ripple with a fixed size.

Parameters


bounded	If true, ripples are clipped by the bounds of the target layout. Unbounded ripples always animate from the target layout center, bounded ripples animate from the touch position.
radius	the radius for the ripple. If `Dp.Unspecified` is provided then the size will be calculated based on the target layout size.
color	the color of the ripple. This color is usually the same color used by the text or iconography in the component. This color will then have `RippleTheme.rippleAlpha` applied to calculate the final color used to draw the ripple. If `Color.Unspecified` is provided the color used will be `RippleTheme.defaultColor` instead.