Compose Multiplatform Material3/androidx.compose.material3/RippleConfiguration

RippleConfiguration

@Immutable
class RippleConfiguration(val color: Color = Color.Unspecified, val rippleAlpha: RippleAlpha? = null)

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, 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.

Constructors

Link copied to clipboard
constructor(color: Color = Color.Unspecified, rippleAlpha: RippleAlpha? = null)

Properties

Link copied to clipboard
val color: Color
Link copied to clipboard
val rippleAlpha: RippleAlpha? = null

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String