androidx.compose.material3.ripple

fun createRippleModifierNode(
    interactionSource: InteractionSource,
    rippleNodeConfiguration: () -> RippleNodeConfiguration
): DelegatableNode

Creates a Ripple node using the values provided.

A Ripple is a Material 3 node that expresses different Interactions by drawing ripple animations, and state layers, and other graphical effects.

A Ripple responds to PressInteraction.Press by starting a new RippleAnimation, and responds to other Interactions by showing a fixed state layer with varying alpha values depending on the Interaction, or an inset ring for FocusInteraction, depending on the supplied RippleNodeConfiguration.

This Ripple node is a low level building block for building IndicationNodeFactory implementations that use a Ripple - higher level design system libraries such as material3 provide ripple implementations using this node internally. In most cases you should use those factories directly: this node exists for design system libraries to delegate their Ripple implementation to, after querying any required theme values for customizing the Ripple.

NOTE: when using this factory with DelegatingNode.delegate, ensure that the node is created once or DelegatingNode.undelegate is called in Modifier.Node.onDetach. Repeatedly delegating to a new node returned by this method in Modifier.Node.onAttach without removing the old one will result in multiple ripple nodes being attached to the node.