React Touch Ripple

Create ripple effect from Material Design with React

简体中文 Simplified Chinese

Install

npm install react-touch-ripple --save

Usage

Basic Usage

importRipplesfrom'react-touch-ripple';constDemo=()=>(<Ripples><button>CLICK</button></Ripples>);ReactDOM.render(<Demos/>,tree);

Custom Styles

A quick note here: <Ripples> is a box wrapping around its child component (in this case, <button>) and if you are adding styles such as box-shadow or margin, make sure you apply them directly to the wrapper component instead of the child component.

constStyledWrapperDemo=()=>(<RipplesclassName="deep-shadow"style={{margin: '10px 0',}}><button>CLICK</button></Ripples>);

Changing Color

The background-color of the ripples are default to currentColor. If you are to change it, pass it as a prop to <Ripples>.

constColoredDemo=()=>(<Ripplescolor="#00a1e9"><button>CLICK</button></Ripples>);

An important note: opacity: 0.3 is already set on the ripples. So you just need to pass in the color without an alpha.

<Ripplescolor="rgba(0, 109, 37, 0.5)">

This is UNNESSARY and will behave out of your expectation.

Center Ripples

Provide center property on the <Ripples> will center every ripple it created. This is usually useful when you are applying ripples on a switch or checkbox component. See demos for more information.

constRippleSwitch=()=>(<Ripplescenter><Switch/></Ripples>);

Design Guidelines

See Choreography

License

React Touch Ripple is licensed as MIT