Skip to content

Latest commit

 

History

History
68 lines (54 loc) · 1.25 KB

README.md

File metadata and controls

68 lines (54 loc) · 1.25 KB
Raw

Chakra UI Animations

Chakra UI Animations is a dependancy which offers you pre-built animations for your Chakra UI components.

Installation

yarn add @codechem/chakra-ui-animations

# or

npm i @codechem/chakra-ui-animations

Usage

import { useAnimation } from '@codechem/chakra-ui-animations';
function App() {
    const animation = useAnimation('flip', { duration: 2000, iterationCount: 'infinite' });

    return (
        <Box bg="red.500" h="500px" w="500px" animation={animation}>
            <Heading>
                Open source rocks!
            </Heading>
        </Box>
    )
}

Options:

  • duration - is the length of the animation (in miliseconds)
  • iterationCount - is the amount of times the you want the animation to repeat (number or 'infinite')

Animation List

The first parameter in the useAnimation hook is the animation name, this is the list for all animations:

Main animations:

  • bounce-in
  • bounce
  • flash
  • flip
  • head-shake
  • heart-beat
  • jello
  • pulse
  • rotate-9
  • rotate-scale
  • rubber-band
  • shake-x
  • shake-y
  • shake
  • swing
  • tada
  • wobble

Shadow animations:

  • shadow-drop-2
  • shadow-drop
  • shadow-inset

Extra animations:

  • hinge
  • jack-in-the-box
  • roll-in
  • roll-out