RippleTheme

data class RippleTheme
kotlin.Any
   ↳ androidx.ui.material.ripple.RippleTheme

Defines the appearance and the behavior for Ripples.

To change some parameter and apply it to descendants modify the CurrentRippleTheme ambient.

To apply the default values based on the Material Design guidelines use MaterialTheme.

Summary

Public constructors

<init>(factory: RippleEffectFactory, defaultColor: Effect<Color>, opacity: Effect<Float>)

Defines the appearance and the behavior for Ripples.

Properties

Effect<Color>

The effect that will be used to calculate the Ripple color when it is not explicitly set in a Ripple.

RippleEffectFactory

Defines the current RippleEffect implementation.

Effect<Float>

The effect that will be used to calculate the opacity applied to the Ripple color.

Public constructors

<init>

RippleTheme(
    factory: RippleEffectFactory,
    defaultColor: Effect<Color>,
    opacity: Effect<Float>)

Defines the appearance and the behavior for Ripples.

To change some parameter and apply it to descendants modify the CurrentRippleTheme ambient.

To apply the default values based on the Material Design guidelines use MaterialTheme.

Properties

defaultColor

val defaultColor: Effect<Color>

The effect that will be used to calculate the Ripple color when it is not explicitly set in a Ripple.

factory

val factory: RippleEffectFactory

Defines the current RippleEffect implementation.

opacity

val opacity: Effect<Float>

The effect that will be used to calculate the opacity applied to the Ripple color. For example, it can be different in dark and light modes.