RippleConfiguration

class RippleConfiguration

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.

Summary

Public constructors
RippleConfiguration(color: Color, rippleAlpha: RippleAlpha?)

Public functions
open operator Boolean
equals(other: Any?)
open Int
open String

Public properties
Color

the color override for the ripple.
RippleAlpha?

the RippleAlpha override for this ripple.

Public constructors

RippleConfiguration

Added in 1.6.0-alpha06
RippleConfiguration(
    color: Color = Color.Unspecified,
    rippleAlpha: RippleAlpha? = null
)
Parameters
color: Color = Color.Unspecified

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: RippleAlpha? = null

the RippleAlpha override for this ripple. If null, then the default alpha will be used instead.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

color

val color: 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

Added in 1.6.0-alpha06
val rippleAlpha: RippleAlpha?

the RippleAlpha override for this ripple. If null, then the default alpha will be used instead.