Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 2.07 KB

README.md

File metadata and controls

44 lines (31 loc) · 2.07 KB

React Animate Children allows to add microinteractions to the mounting phase of components.

This library features IntersectionObserver so that the animation can start once the children are visible on the screen!

Features

  • Compatible with styled-components
  • Use of IntersectionObserver api

Installation

npm i react-animate-children

Usage

import AnimateChildren from 'react-animate-children'

const Test = () => {
  return (
    <AnimateChildren>
      <div>Hello World</div>
    </AnimateChildren>
  )
}

Props

Property Type Default Required Description
children React Node(s) null Yes Children components wrapped inside AnimateChildren
direction 'left', 'right', 'up', 'down' down No Specifies the direction in which the component will get mounted
behaviour 'scroll', 'auto' auto No Auto will mount the children components once the page loads, scroll will load them when the children is visible on the screen
speed number 500 No Specifies the time it will take to start the animation
offset number 50 No Specifies how many pixels it will have as offset when the animation start

Credits

PRs are welcome!