Giter Site home page Giter Site logo

motion's Introduction

rc-motion

NPM version npm download build status Codecov Dependencies DevDependencies bundle size

React lifecycle controlled motion library.

Live Demo

https://react-component.github.io/motion/

Install

rc-motion

Example

import CSSMotion from 'rc-motion';

export default ({ visible }) => (
  <CSSMotion visible={visible} motionName="my-motion">
    {({ className, style }) => <div className={className} style={style} />}
  </CSSMotion>
);

API

CSSMotion

Property Type Default Description
motionName string - Config motion name, will dynamic update when status changed
visible boolean true Trigger motion events
motionAppear boolean true Use motion when appear
motionEnter boolean true Use motion when enter
motionLeave boolean true Use motion when leave
motionLeaveImmediately boolean - Will trigger leave even on mount
motionDeadline number - Trigger motion status change even when motion event not fire
removeOnLeave boolean true Remove element when motion leave end
leavedClassName string - Set leaved element className
onAppearStart (HTMLElement, Event) => CSSProperties | void; - Trigger when appear start, return style will patch to element
onEnterStart (HTMLElement, Event) => CSSProperties | void; - Trigger when enter start, return style will patch to element
onLeaveStart (HTMLElement, Event) => CSSProperties | void; - Trigger when leave start, return style will patch to element
onAppearActive (HTMLElement, Event) => CSSProperties | void; - Trigger when appear active, return style will patch to element
onEnterActive (HTMLElement, Event) => CSSProperties | void; - Trigger when enter active, return style will patch to element
onLeaveActive (HTMLElement, Event) => CSSProperties | void; - Trigger when leave active, return style will patch to element
onAppearEnd (HTMLElement, Event) => boolean | void; - Trigger when appear end, will not finish when return false
onEnterEnd (HTMLElement, Event) => boolean | void; - Trigger when enter end, will not finish when return false
onLeaveEnd (HTMLElement, Event) => boolean | void; - Trigger when leave end, will not finish when return false

CSSMotionList

extends all the props from CSSMotion

Property Type Default Description
keys React.Key[] - Motion list keys
component string | React.ComponentType div wrapper component

Development

npm install
npm start

License

rc-motion is released under the MIT license.

motion's People

Contributors

07akioni avatar adaladam avatar afc163 avatar ayase-252 avatar buhichan avatar hengkx avatar lukerspringtree avatar zombiej avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.