class RippleConfiguration
internal constructor(val color: Color, val focus: Focus?, rippleAlpha: RippleAlpha?)Local per-ripple configuration for the ripple appearance, provided using LocalRippleConfiguration. In most cases the default values should be used, for custom design system use cases you should instead build your own custom ripple using createRippleModifierNode. To disable the ripple completely, provide null using LocalRippleConfiguration.
The ripple configuration is resolved as follows:
- LocalRippleThemeConfiguration provides the highest-level theming configuration for ripples, including whether the focus indication is drawn by inset focus rings.
- LocalRippleConfiguration provides hierarchical per-ripple configuration for ripple, including disabling ripples and their indications. This takes next highest priority.
- ripple parameters allow specifying configuration for individual indication callsites in components.
Secondary Constructors
constructor(color: Color = Color.Unspecified) : this(color, null, null)Local per-ripple configuration for ripple appearance, provided using LocalRippleConfiguration. In most cases the default values should be used, for custom design system use cases you should instead build your own custom ripple using createRippleModifierNode. To disable the ripple completely, provide null using LocalRippleConfiguration.
Parameters
| color | the color override for the ripple. If Color.Unspecified, then the default color from the theme will be used instead. Note that if the ripple has a color explicitly set with the parameter on ripple, that will always be used instead of this value. |
constructor(
focus: Focus?,
color: Color = Color.Unspecified,
) : this(color = color, focus = focus, rippleAlpha = null)Local per-ripple configuration for ripple appearance, provided using LocalRippleConfiguration. In most cases the default values should be used, for custom design system use cases you should instead build your own custom ripple using createRippleModifierNode. To disable the ripple completely, provide null using LocalRippleConfiguration.
Parameters
| focus | the focus indication override for this ripple. If null, then the default indication style will be used instead. This will only be applied if the style of focus indication matches the one set by LocalRippleThemeConfiguration (opacity vs inset focus ring) |
| color | the color override for the ripple. If Color.Unspecified, then the default color from the theme will be used instead. Note that if the ripple has a color explicitly set with the parameter on ripple, that will always be used instead of this value. |
constructor(
color: Color = Color.Unspecified,
rippleAlpha: RippleAlpha? = null,
) : this(color = color, focus = null, rippleAlpha = rippleAlpha)Configuration for ripple appearance, provided using LocalRippleConfiguration. In most cases the default values should be used, for custom design system use cases you should instead build your own custom ripple using createRippleModifierNode. To disable the ripple completely, provide null using LocalRippleConfiguration.
Parameters
| color | the color override for the ripple. If Color.Unspecified, then the default color from the theme will be used instead. Note that if the ripple has a color explicitly set with the parameter on ripple, that will always be used instead of this value. |
| rippleAlpha | the RippleAlpha override for this ripple. If null, then the default alpha will be used instead. |
Properties
rippleAlpha
val : RippleAlpha?