framer-motion
Version:
An open source and production-ready motion library for React on the web
32 lines (31 loc) • 759 B
TypeScript
import { MotionValue } from ".";
/**
* Creates a `MotionValue` to track the state and velocity of a value.
*
* Usually, these are created automatically. For advanced use-cases, like use with `useTransform`, you can create `MotionValue`s externally and pass them into the animated component via the `style` prop.
*
* @library
*
* ```jsx
* export function MyComponent() {
* const scale = useMotionValue(1)
*
* return <Frame scale={scale} />
* }
* ```
*
* @motion
*
* ```jsx
* export const MyComponent = () => {
* const scale = useMotionValue(1)
*
* return <motion.div style={{ scale }} />
* }
* ```
*
* @param initial - The initial state.
*
* @public
*/
export declare function useMotionValue<T>(initial: T): MotionValue<T>;