use-reveal v1.0.0

use-reveal

Scroll-reveal react hook for creating beautifuly timed animations

Install

npm install --save use-reveal

Usage

import React from 'react'

import useReveal from 'use-reveal'

const Example = () => {
  const {ref, isRevealed, delay} = useReveal()
  return (
    <div
      ref={ref}
      className={isRevealed ? 'revealed' : 'hidden'}
      data-delay={delay}
    />
  )
}

The useReveal() hook returns an object with these properties:

ref let's you choose the element to be detected by passing it to the ref prop.

isRevealed returns false by default. Once the element enters the view, isRevealed changes to true.

delay makes it easy to beautifully timed animations. Elements visible on load have delay from 0 to 1. Elements entering on scroll have delay of .2, because it simply looks good.