react-use/docs/useSpring.md
2019-07-17 08:54:01 +02:00

850 B

useSpring

React animation hook that updates a single numeric value over time according to spring dynamics.

Usage

import useSpring from 'react-use/lib/useSpring';

const Demo = () => {
  const [target, setTarget] = useState(50);
  const value = useSpring(target);

  return (
    <div>
      {value}
      <br />
      <button onClick={() => setTarget(0)}>Set 0</button>
      <button onClick={() => setTarget(100)}>Set 100</button>
    </div>
  );
};

Note: Because of dependency on rebound you have to import this hook directly like shown above.

Requirements

Install rebound peer dependency:

npm add rebound
# or
yarn add rebound

Reference

const currentValue = useSpring(targetValue);
const currentValue = useSpring(targetValue, tension, friction);