The second Android 11 Developer Preview is now available, test it out and share your feedback.


interface RippleEffectFactory

An encapsulation of an RippleEffect constructor used by ripple and RippleTheme.

Will be used as a theme parameter in RippleTheme.factory


Public methods

abstract RippleEffect
create(size: IntPxSize, startPosition: PxPosition, density: Density, radius: Dp?, clipped: Boolean, clock: AnimationClockObservable, requestRedraw: () -> Unit, onAnimationFinished: (RippleEffect) -> Unit)

The factory method.

Public methods


abstract fun create(
    size: IntPxSize,
    startPosition: PxPosition,
    density: Density,
    radius: Dp?,
    clipped: Boolean,
    clock: AnimationClockObservable,
    requestRedraw: () -> Unit,
    onAnimationFinished: (RippleEffect) -> Unit
): RippleEffect

The factory method.

Subclasses should override this method to return a new instance of an RippleEffect.

size: IntPxSize The size of the target layout.
startPosition: PxPosition The position the animation will start from.
density: Density The Density object to convert the dimensions.
radius: Dp? Effects grow up to this size.
clipped: Boolean If true the effect should be clipped by the target layout bounds.
clock: AnimationClockObservable The animation clock observable that will drive this ripple effect
requestRedraw: () -> Unit Call when the ripple should be redrawn to display the next frame.
onAnimationFinished: (RippleEffect) -> Unit Call when the effect animation has been finished.