1.1.0 • Published 1 year ago

ray-animate v1.1.0

Weekly downloads
2
License
MIT
Repository
-
Last release
1 year ago

ray-animate

animate

install

npm install --save ray-animate

Usage

import Animate from 'ray-animate';

ReactDOM.render(
  <Animate animation={{ ... }}>
    <p key="1">1</p>
    <p key="2">2</p>
  </Animate>
, mountNode);

API

props

nametypedefaultdescription
componentReact.Element|stringspanwrap dom node or component for children. set to '' if you do not wrap for only one child
componentPropsobject{}extra props that will be passed to component
showPropstring--using prop for show and hide
exclusiveboolean--whether allow only one set of animations(enter and leave) at the same time.
transitionNamestring|object--specify corresponding css, see ReactCSSTransitionGroup
transitionAppearbooleanfalsewhether support transition appear anim
transitionEnterbooleantruewhether support transition enter anim
transitionLeavebooleantruewhether support transition leave anim
onEndfunction(key:String, exists:Boolean)trueanimation end callback
animationobject{}to animate with js. see animation format below.

animation format

with appear, enter and leave as keys. for example:

{
  appear: function(node, done){
    node.style.display='none';
    $(node).slideUp(done);
    return {
      stop:function(){
        // jq will call done on finish
        $(node).stop(true);
      }
    };
  },
  enter: function(){
    this.appear.apply(this,arguments);
  },
  leave: function(node, done){
    node.style.display='';
    $(node).slideDown(done);
    return {
      stop:function(){
        // jq will call done on finish
        $(node).stop(true);
      }
    };
  }
}

Test Case

npm test
npm run chrome-test

Coverage

npm run coverage

License

MIT

author

ilex.h