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.

Summary

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

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

Public properties
Color

the color override for the ripple.
Cmn
Boolean

whether the ripple is enabled.
Cmn
RippleAlpha?

the RippleAlpha override for this ripple.
Cmn

Public constructors

RippleConfiguration

Cmn 
RippleConfiguration(
    isEnabled: Boolean = true,
    color: Color = Color.Unspecified,
    rippleAlpha: RippleAlpha? = null
)
Parameters
isEnabled: Boolean = true

whether the ripple is enabled. If false, no ripple will be rendered
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

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

hashCode

Cmn 
open fun hashCode(): Int

toString

Cmn 
open fun toString(): String

Public properties

color

Cmn
Added in 1.7.0-alpha07
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.

isEnabled

Cmn
Added in 1.7.0-alpha07
val isEnabled: Boolean

whether the ripple is enabled. If false, no ripple will be rendered

rippleAlpha

Cmn
Added in 1.7.0-alpha07
val rippleAlpha: RippleAlpha?

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