# RippleConfiguration

# RippleConfiguration

Artifact:[androidx.compose.material:material](https://developer.android.com/jetpack/androidx/releases/compose-material)  
[View Source](https://cs.android.com/search?q=file:androidx/compose/material/Ripple.kt+class:androidx.compose.material.RippleConfiguration)  
Added in[1.7.0](https://developer.android.com/jetpack/androidx/releases/compose-material#1.7.0)
Common/AllAndroid/JVM
  - Cmn  

  ```
  class RippleConfiguration
  ```

*** ** * ** ***

Configuration for[ripple](https://developer.android.com/reference/kotlin/androidx/compose/material/package-summary#ripple(kotlin.Boolean,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Color))appearance, provided using[LocalRippleConfiguration](https://developer.android.com/reference/kotlin/androidx/compose/material/package-summary#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](https://developer.android.com/reference/kotlin/androidx/compose/material/ripple/package-summary#createRippleModifierNode(androidx.compose.foundation.interaction.InteractionSource,kotlin.Boolean,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.ColorProducer,kotlin.Function0)). To disable the ripple, provide`null`using[LocalRippleConfiguration](https://developer.android.com/reference/kotlin/androidx/compose/material/package-summary#LocalRippleConfiguration()).

## Summary

|                                                                                                                                                                                                                   ### Public constructors                                                                                                                                                                                                                   |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|
| [RippleConfiguration](https://developer.android.com/reference/kotlin/androidx/compose/material/RippleConfiguration#RippleConfiguration(androidx.compose.ui.graphics.Color,androidx.compose.material.ripple.RippleAlpha))`(color: `[Color](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color)`, rippleAlpha: `[RippleAlpha](https://developer.android.com/reference/kotlin/androidx/compose/material/ripple/RippleAlpha)`?)` | Cmn |

|                                        ### Public functions                                         |
|-----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|
| `open operator `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [equals](https://developer.android.com/reference/kotlin/androidx/compose/material/RippleConfiguration#equals(kotlin.Any))`(other: `[Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)`?)` | Cmn |
| `open `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)                  | [hashCode](https://developer.android.com/reference/kotlin/androidx/compose/material/RippleConfiguration#hashCode())`()`                                                                                            | Cmn |
| `open `[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)            | [toString](https://developer.android.com/reference/kotlin/androidx/compose/material/RippleConfiguration#toString())`()`                                                                                            | Cmn |

|                                             ### Public properties                                             |
|---------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|
| [Color](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color)                    | [color](https://developer.android.com/reference/kotlin/androidx/compose/material/RippleConfiguration#color()) the color override for the ripple.                                                                                                                 | Cmn |
| [RippleAlpha](https://developer.android.com/reference/kotlin/androidx/compose/material/ripple/RippleAlpha)`?` | [rippleAlpha](https://developer.android.com/reference/kotlin/androidx/compose/material/RippleConfiguration#rippleAlpha()) the[RippleAlpha](https://developer.android.com/reference/kotlin/androidx/compose/material/ripple/RippleAlpha)override for this ripple. | Cmn |

## Public constructors

### RippleConfiguration

Cmn  
Added in[1.9.0](https://developer.android.com/jetpack/androidx/releases/compose-material#1.9.0)  

```
RippleConfiguration(
    color: Color = Color.Unspecified,
    rippleAlpha: RippleAlpha? = null
)
```  

|                                                             Parameters                                                              |
|-------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `color: `[Color](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Color)` = Color.Unspecified`           | the color override for the ripple. If[Color.Unspecified](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/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](https://developer.android.com/reference/kotlin/androidx/compose/material/package-summary#ripple(kotlin.Boolean,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Color)), that will always be used instead of this value. |
| `rippleAlpha: `[RippleAlpha](https://developer.android.com/reference/kotlin/androidx/compose/material/ripple/RippleAlpha)`? = null` | the[RippleAlpha](https://developer.android.com/reference/kotlin/androidx/compose/material/ripple/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](https://developer.android.com/jetpack/androidx/releases/compose-material#1.7.0)  

```
val color: Color
```

the color override for the ripple. If[Color.Unspecified](https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/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](https://developer.android.com/reference/kotlin/androidx/compose/material/package-summary#ripple(kotlin.Boolean,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Color)), that will always be used instead of this value.  

### rippleAlpha

Cmn  
Added in[1.7.0](https://developer.android.com/jetpack/androidx/releases/compose-material#1.7.0)  

```
val rippleAlpha: RippleAlpha?
```

the[RippleAlpha](https://developer.android.com/reference/kotlin/androidx/compose/material/ripple/RippleAlpha)override for this ripple. If null, then the default alpha will be used instead.