react-use/docs/useRaf.md
2018-10-27 21:52:09 +02:00

582 B

useRaf

React animation hook that forces component to re-render on each reaquestAnimationFrame, returns percentage of time elapsed.

Usage

import {useRaf} from 'react-use';

const Demo = () => {
  const frames = useRaf(5000, 1000);

  return (
    <div>
      Elapsed: {frames}
    </div>
  );
};

Reference

useRaf(ms?: number, delay?: number): number;

ms — milliseconds for how long to keep re-rendering component, defaults to 1e12. delay — delay in milliseconds after which to start re-rendering component, defaults to 0.