Skip to content

Latest commit

 

History

History
 
 

line-ripple

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.scss
index.scss
 
 
index.tsx
index.tsx
 
 
package.json
package.json
 
 

README.md

React Line Ripple

A React version of an MDC Line Ripple.

Installation

npm install @material/react-line-ripple

Usage

Styles

with Sass:

import '@material/react-line-ripple/index.scss';

with CSS:

import '@material/react-line-ripple/dist/line-ripple.css';

Javascript Instantiation

import LineRipple from '@material/react-line-ripple';

const MyComponent = () => {
  return (
    <LineRipple />
  );
}

Props

Prop Name Type Description
active boolean Activates or deactivates the line ripple state.
className string Classes to be applied to the root element.
rippleCenter number Sets the center of the ripple animation.
style object Inline styles of root element.

Sass Mixins

Sass mixins may be available to customize various aspects of the components. Please refer to the MDC Web repository for more information on what mixins are available, and how to use them.

Advanced Sass Mixins