RippleConfiguration

public class RippleConfiguration internal constructor(public val color: Color, public 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:

including whether the focus indication is drawn by inset focus rings.

• LocalRippleThemeConfiguration provides the highest-level theming configuration for ripples,

including disabling ripples and their indications. This takes next highest priority.

• LocalRippleConfiguration provides hierarchical per-ripple configuration for ripple,

components.

• ripple parameters allow specifying configuration for individual indication callsites in

Properties

rippleAlpha

public val rippleAlpha: RippleAlpha? = rippleAlpha

Functions

equals

override fun equals(other: Any?): Boolean

hashCode

override fun hashCode(): Int

toString

override fun toString(): String

Members

Focus

public sealed class Focus private constructor()

The configuration options for the focus indication for RippleConfiguration.

Members

Opacity

public object Opacity : Focus()

An opacity-based focus indication.

InsetRing

public class InsetRing(
            public val outerStrokeColor: Color,
            public val innerStrokeColor: Color,
        ) : Focus()

An inset ring focus indication. This is drawn using two strokes, an outer stroke and an inner stroke. The inner stroke is drawn first, followed by the outer stroke.

As this describes a use-site specific override, the inset ring dimensions are controlled with RippleThemeConfiguration.Focus.InsetRing instead.

Parameters

Functions

equals

override fun equals(other: Any?): Boolean

hashCode

override fun hashCode(): Int