Package Exports
- react-simple-animate
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-simple-animate) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Make web animation simple 👏
Features:
- Simple animation from inline style A to style B
- Support add and remove child (New)
- Make animation toggle easy
- In-built delay animation mechanism
- Tiny size without other dependency
Install
$ yarn add react-simple-animate
or
$ npm install react-simple-animate -SExample
Check out the interactive demo. 😍
Navigate into example folder and install
$ yarn && yarn start
or
$ npm install && npm run startScreenshot of the example app below
Quick start
The following example demonstrate animate individual or array of components. React simple animate will take cares component will mount and unmount.
import react from 'react';
import Animate from 'react-simple-animate';
import YourComponent from './YourComponent';
const props = {
durationSeconds: 0.2,
startAnimation: true,
startStyle: { opacity: 0 }
endStyle={ opacity: 1 }
};
export default function SexyComponent(props) {
return <div>
// Animate individual component or components
<Animate {...props}>
<h1>React simple animate</h1>
<YourComponent>
</Animate>
// Animate components with add/remove, style will inherit from parent Animate props
<Animate {...props} animateOnAddRemove>
{props.componentsArray.map((key) => <YourComponent key={key}>}
</Animate>
// Animate components with customise style for add or remove
<Animate {...props} animateOnAddRemove>
{props.componentsArray.map((key) =>
<Animate startStyle={{ background: 'none' }} endStyle={{ background: 'red' }>
<YourComponent key={key}>
</Animatee>}
</Animate>
</div>;
}API
| Prop | Type | Required | Description |
|---|---|---|---|
startAnimation |
boolean | ✓ | Defaults to false. Set to true to start the animation. |
children |
node | ✓ | Child component to be animated. |
startStyle |
string | Component initial inline style. | |
endStyle |
string | ✓ | Component transition to inline style. |
animateOnAddRemove |
boolean | Enable animation on component add and remove. | |
onCompleteStyle |
string | Style to be applied after the animation is completed. | |
durationSeconds |
number | How long the animation takes in seconds. | |
delaySeconds |
number | How much delay should apply before animation starts. | |
reverseDelaySeconds |
number | How much delay should apply when reverse/toggle animation. | |
onComplete |
function | Call back function after animation complete. | |
easeType |
string | Easing type refer to http://easings.net/ | |
className |
string | To specify a CSS class. |