packages/mdc-line-ripple/README.md
The line ripple is used to highlight user-specified input above it. When a line ripple is active, the line’s color and thickness changes.
npm install @material/line-ripple
<span class="mdc-line-ripple"></span>
@use "@material/line-ripple/mdc-line-ripple";
import {MDCLineRipple} from '@material/line-ripple';
const lineRipple = new MDCLineRipple(document.querySelector('.mdc-line-ripple'));
| CSS Class | Description |
|---|---|
mdc-line-ripple | Mandatory. |
mdc-line-ripple--active | Styles the line ripple as an active line ripple. |
mdc-line-ripple--deactivating | Styles the line ripple as a deactivating line ripple. |
| Mixin | Description |
|---|---|
active-color($color) | Customizes the color of the line ripple when active. |
inactive-color($color) | Customizes the color of the line ripple when inactive. |
MDCLineRipple Properties and Methods| Method Signature | Description |
|---|---|
activate() => void | Proxies to the foundation's activate() method. |
deactivate() => void | Proxies to the foundation's deactivate() method. |
setRippleCenter(xCoordinate: number) => void | Proxies to the foundation's setRippleCenter(xCoordinate: number) method. |
If you are using a JavaScript framework, such as React or Angular, you can create a Line Ripple for your framework. Depending on your needs, you can use the Simple Approach: Wrapping MDC Web Vanilla Components, or the Advanced Approach: Using Foundations and Adapters. Please follow the instructions here.
MDCLineRippleAdapter| Method Signature | Description |
|---|---|
addClass(className: string) => void | Adds a class to the root element. |
removeClass(className: string) => void | Removes a class from the root element. |
hasClass(className: string) => boolean | Determines whether the root element has the given CSS class name. |
setStyle(propertyName: string, value: string) => void | Sets the style property with propertyName to value on the root element. |
registerEventHandler(eventType: EventType, handler: EventListener) => void | Registers an event listener on the root element for a given event. |
deregisterEventHandler(eventType: EventType, handler: EventListener) => void | Deregisters an event listener on the root element for a given event. |
MDCLineRippleFoundation| Method Signature | Description |
|---|---|
activate() => void | Activates the line ripple. |
deactivate() => void | Deactivates the line ripple. |
setRippleCenter(xCoordinate: number) => void | Sets the center of the ripple to the xCoordinate given. |
handleTransitionEnd(event: Event) => void | Handles a transitionend event. |