androidx.ui.material.ripple

Classes

RippleTheme

Defines the appearance and the behavior for ripples.

Top-level properties summary

ProvidableAmbient<RippleTheme>

Ambient used for providing RippleTheme down the tree.

Extension functions summary

For Modifier
Modifier
Modifier.ripple(bounded: Boolean = true, radius: Dp? = null, color: Color? = null, enabled: Boolean = true, clock: AnimationClockObservable = AnimationClockAmbient.current)

Ripple is a Modifier which draws the visual indicator for a pressed state.

Top-level properties

RippleThemeAmbient

val RippleThemeAmbient: ProvidableAmbient<RippleTheme>

Ambient used for providing RippleTheme down the tree.

Extension functions

ripple

@Composable fun Modifier.ripple(
    bounded: Boolean = true,
    radius: Dp? = null,
    color: Color? = null,
    enabled: Boolean = true,
    clock: AnimationClockObservable = AnimationClockAmbient.current
): Modifier

Ripple is a Modifier which draws the visual indicator for a pressed state.

Ripple responds to a tap by starting a new RippleEffect animation. For creating an effect it uses the RippleTheme.factory.


//Unresolved: androidx.ui.material.samples.RippleSample
Parameters
bounded: Boolean = true If true, ripples are clipped by the bounds of the target layout. Unbounded ripples always animate from the target layout center, bounded ripples animate from the touch position.
radius: Dp? = null Effects grow up to this size. If null is provided the size would be calculated based on the target layout size.
color: Color? = null The Ripple color is usually the same color used by the text or iconography in the component. If null is provided the color will be calculated by RippleTheme.defaultColor.
clock: AnimationClockObservable = AnimationClockAmbient.current The animation clock observable that will drive this ripple effect
enabled: Boolean = true The ripple effect will not start if false is provided.