TouchRipple API
The API documentation of the TouchRipple React component. Learn more about the properties and the CSS customization points.
import TouchRipple from '@material-ui/core/ButtonBase/TouchRipple';Props
| Name | Type | Default | Description |
|---|---|---|---|
| center | bool | false | If true, the ripple starts at the center of the component rather than at the point of interaction. |
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. |
The ref is attached to a component class.
Any other properties supplied will be provided to the root element (native element).
CSS
You can override all the class names injected by Material-UI thanks to the classes property.
This property accepts the following keys:
| Name | Description |
|---|---|
| root | Styles applied to the root element. |
| ripple | Styles applied to the internal Ripple components ripple class. |
| rippleVisible | Styles applied to the internal Ripple components rippleVisible class. |
| ripplePulsate | Styles applied to the internal Ripple components ripplePulsate class. |
| child | Styles applied to the internal Ripple components child class. |
| childLeaving | Styles applied to the internal Ripple components childLeaving class. |
| childPulsate | Styles applied to the internal Ripple components childPulsate class. |
Have a look at the overriding styles with classes section and the implementation of the component for more detail.
If using the overrides key of the theme,
you need to use the following style sheet name: MuiTouchRipple.
Notes
The component is fully StrictMode compatible.