RippleTheme API Reference in Material Ripple

Defines the appearance for Ripples.

Source set: Common

Deprecated

RippleThemeDeprecationMessage

public interface RippleTheme

Defines the appearance for Ripples. You can define a new theme and apply it using LocalRippleTheme. See defaultRippleColor and defaultRippleAlpha for default values that can be used when creating your own RippleTheme.

Functions

defaultColor

@Composable
public fun defaultColor(): Color

Returns


	the default ripple color at the call site's position in the hierarchy. This color will be used when a color is not explicitly set in the ripple itself.

rippleAlpha

@Composable
public fun rippleAlpha(): RippleAlpha

Returns


	the RippleAlpha used to calculate the alpha for the ripple depending on the Interaction for a given component. This will be set as the alpha channel for defaultColor or the color explicitly provided to the ripple.