RippleTheme

Artifact: androidx.compose.material:material-ripple

View Source

Added in 1.0.0

Deprecated in 1.7.0

Common/All

• Cmn

  interface RippleTheme

---

This interface is deprecated.
RippleTheme and LocalRippleTheme have been deprecated - they are not compatible with the new ripple implementation using the new Indication APIs that provide notable performance improvements. For a migration guide and background information, please visit developer.android.com

Defines the appearance for Ripples. You can define a new theme and apply it using LocalRippleTheme. See defaultRippleColor and defaultRippleAlpha for default values that can be used when creating your own RippleTheme.

See also
rememberRipple

Summary

Public companion functions
RippleAlpha	defaultRippleAlpha(contentColor: Color, lightTheme: Boolean) This function is deprecated. The default ripple alpha varies between design system versions: this function technically implements the default used by the material library, but is not used by the material3 library.	Cmn
Color	defaultRippleColor(contentColor: Color, lightTheme: Boolean) This function is deprecated. The default ripple color varies between design system versions: this function technically implements the default used by the material library, but is not used by the material3 library.	Cmn

Public functions
Color	@Composable defaultColor() This function is deprecated. RippleTheme and LocalRippleTheme have been deprecated - they are not compatible with the new ripple implementation using the new Indication APIs that provide notable performance improvements.	Cmn
RippleAlpha	@Composable rippleAlpha() This function is deprecated. RippleTheme and LocalRippleTheme have been deprecated - they are not compatible with the new ripple implementation using the new Indication APIs that provide notable performance improvements.	Cmn

Public companion functions

defaultRippleAlpha

Cmn

fun defaultRippleAlpha(contentColor: Color, lightTheme: Boolean): RippleAlpha

This function is deprecated.
The default ripple alpha varies between design system versions: this function technically implements the default used by the material library, but is not used by the material3 library. To remove confusion and link the defaults more strongly to the design system library, these default values have been moved to the material and material3 libraries. For material, use RippleDefaults#rippleAlpha. For material3, use RippleDefaults#RippleAlpha.

Represents the default RippleAlpha that will be used for a ripple to indicate different states.

Parameters
contentColor: Color	the color of content (text or iconography) in the component that contains the ripple.
lightTheme: Boolean	whether the theme is light or not

defaultRippleColor

Cmn

fun defaultRippleColor(contentColor: Color, lightTheme: Boolean): Color

This function is deprecated.
The default ripple color varies between design system versions: this function technically implements the default used by the material library, but is not used by the material3 library. To remove confusion and link the defaults more strongly to the design system library, these default values have been moved to the material and material3 libraries. For material, use RippleDefaults#rippleColor. For material3, use content color directly.

Represents the default color that will be used for a ripple if a color has not been explicitly set on the ripple instance.

Parameters
contentColor: Color	the color of content (text or iconography) in the component that contains the ripple.
lightTheme: Boolean	whether the theme is light or not

Public functions

defaultColor

Cmn

Added in 1.0.0

Deprecated in 1.7.0

@Composable
fun defaultColor(): Color

This function is deprecated.
RippleTheme and LocalRippleTheme have been deprecated - they are not compatible with the new ripple implementation using the new Indication APIs that provide notable performance improvements. For a migration guide and background information, please visit developer.android.com

Returns
Color	the default ripple color at the call site's position in the hierarchy. This color will be used when a color is not explicitly set in the ripple itself.

See also
defaultRippleColor

rippleAlpha

Cmn

Added in 1.0.0

Deprecated in 1.7.0

@Composable
fun rippleAlpha(): RippleAlpha

This function is deprecated.
RippleTheme and LocalRippleTheme have been deprecated - they are not compatible with the new ripple implementation using the new Indication APIs that provide notable performance improvements. For a migration guide and background information, please visit developer.android.com

Returns
RippleAlpha	the RippleAlpha used to calculate the alpha for the ripple depending on the Interaction for a given component. This will be set as the alpha channel for defaultColor or the color explicitly provided to the ripple.

See also
defaultRippleAlpha