react-animate-height-vesna
v0.9.1-3
Published
Lightweight, no dependency React component for animating height using CSS transitions.
Downloads
3
Maintainers
Readme
Animate Height
Lightweight, no dependency React component for animating height using CSS transitions. Slide up/down the element, and to any specific height.
Demo & Examples
Live demo: stanko.github.io/react-animate-height
To build the examples locally, run:
npm install
npm start
Then open localhost:8000
in a browser.
Installation
The easiest way to use react-animate-height is to install it from NPM and include it in your own React build process (using Webpack).
You can also use the standalone build by including dist/react-animate-height.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 --save react-animate-height
Usage
EXPLAIN USAGE HERE
import AnimateHeight from 'react-animate-height';
<AnimateHeight
duration={ 500 }
height={ 'auto' }>
<h1>Your content goes here</h1>
<p>Put as many React or HTML components here.</p>
</AnimateHeight>
Properties
height: numeric or 'auto', required When changed, element height will be animated to that height. To slide up use 0, for slide down use 'auto'
duration: integer, default: 250 Duration of the animation in milliseconds
easing: string, default: 'ease' CSS easing function to be applied to the animation
className: string CSS class to be applied to the element
style: object CSS style object, it will be merged with inline styles of the component
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
).