react-use/docs/useTween.md
streamich 61700675cd chore: 🤖 don't install only large dependencies
This change removes useCallbag hook, it also reverts back changes for
hooks that only have tiny dependencies or dependencies that could have
been part of the hook itself. Effectivly only KeyboardJS and Rebound are
large packages that only partially are used by react-use, hence require
user to install them separately.

BREAKING CHANGE: 🧨 useCallbag hook is removed, some hooks KeyboardJS and Rebound installed
separately
2019-03-25 13:19:37 +01:00

831 B

useTween

React animation hook that tweens a number between 0 and 1.

Usage

import {useTween} from 'react-use';

const Demo = () => {
  const t = useTween();

  return (
    <div>
      Tween: {t}
    </div>
  );
};

Reference

useTween(easing?: string, ms?: number, delay?: number): number

Returns a number that begins with 0 and ends with 1 when animation ends.

  • easing — one of the valid easing names, defaults to inCirc.
  • ms — milliseconds for how long to keep re-rendering component, defaults to 200.
  • delay — delay in milliseconds after which to start re-rendering component, defaults to 0.