JSPM

  • Created
  • Published
  • Downloads 486375
  • Score
    100M100P100Q241423F
  • License Apache-2.0

react simple animate

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

React Simple Animate

npm version npm downloads npm npm

Make web animation simple 👏

Features:

  • Simple animation from inline style A to style B
  • Make animation toggle easy
  • In-built delay animation mechanism
  • Tiny size 3,878 bytes (before Gzip)

Install

$ yarn add react-simple-animate
or
$ npm install react-simple-animate -S

Example

Check out the interactive demo. 😍

Navigate into example folder and install

$ yarn && yarn start
or
$ npm install && npm run start

Screenshot of the example app below

Screenshots

Quick start

import react from 'react';
import Animate from 'react-simple-animate';

export default function SexyComponent() {
    return <Animate durationSeconds={0.2}
         startAnimation
         delaySeconds={1.2}
         startStyle={{
           opacity: 0,
         }}
         endStyle={{
           opacity: 1,
         }}
       >
       <YourComponent> // your component here
    </Animate>;
}

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.
tag string Default tag is div, this allow custom tag to be wrap around.
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.
onComplete function Call back function after animation complete.
easeType string Easing type refer to http://easings.net/
className string To specify a CSS class.
forceUpdate boolean Force component to re-render.