ripple-effect
v1.0.5
Published
ripple-effect
Downloads
5
Readme
ripple-effect
COMPONENT DESCRIPTION GOES HERE
Demo & Examples
Live demo: satishsathya11.github.io/ripple-effect
To build the examples locally, run:
npm install
npm start
Then open localhost:8000
in a browser.
Installation
The easiest way to use ripple-effect is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).
You can also use the standalone build by including dist/ripple-effect.js
in your page. If you use this, make sure you have already included React, and it is available as a global variable.
npm install ripple-effect --save
Usage
EXPLAIN USAGE HERE
var RippleEffect = require('ripple-effect');
handleClick(){
this.refs.ripplecon.handleClick();
}
<RippleEffect ref="ripplecon" color="#fff" during={1500}>
<div id="ripple" style={style}></div>
<button onClick={this.handleClick}>click</button>
</RippleEffect>
Properties
- DOCUMENT PROPERTIES HERE
Notes
ADDITIONAL USAGE NOTES
Development (src
, lib
and the build process)
NOTE: The source code for the component is in src
. A transpiled CommonJS version (generated with Babel) is available in lib
for use with node.js, browserify and webpack. A UMD bundle is also built to dist
, which can be included without the need for any build system.
To build, watch and serve the examples (which will also watch the component source), run npm start
. If you just want to watch changes to src
and rebuild lib
, run npm run watch
(this is useful if you are working with npm link
).
License
PUT LICENSE HERE
Copyright (c) 2016 satish.