securityos/node_modules/framer-motion/dist/es/value/use-velocity.mjs

24 lines
641 B
JavaScript
Raw Permalink Normal View History

2024-09-06 15:32:35 +00:00
import { useMotionValueEvent } from '../utils/use-motion-value-event.mjs';
import { useMotionValue } from './use-motion-value.mjs';
/**
* Creates a `MotionValue` that updates when the velocity of the provided `MotionValue` changes.
*
* ```javascript
* const x = useMotionValue(0)
* const xVelocity = useVelocity(x)
* const xAcceleration = useVelocity(xVelocity)
* ```
*
* @public
*/
function useVelocity(value) {
const velocity = useMotionValue(value.getVelocity());
useMotionValueEvent(value, "velocityChange", (newVelocity) => {
velocity.set(newVelocity);
});
return velocity;
}
export { useVelocity };