react-native-reanimated/lib/module/hook/useSharedValue.js

More powerful alternative to Animated library for React Native.

'use strict';

import { useEffect, useState } from 'react';
import { cancelAnimation } from "../animation/index.js";
import { makeMutable } from "../core.js";

/**
 * Lets you define [shared
 * values](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#shared-value)
 * in your components.
 *
 * @param initialValue - The value you want to be initially stored to a `.value`
 *   property. You can also pass a function that returns the initial value; it
 *   is called once on mount. Useful when the initial value is expensive to
 *   compute.
 *
 *   **Warning:** Don't store functions (including worklets) inside shared
 *   values.
 * @returns A shared value with a single `.value` property initially set to the
 *   `initialValue` - {@link SharedValue}.
 * @see https://docs.swmansion.com/react-native-reanimated/docs/core/useSharedValue
 */
export function useSharedValue(initialValue) {
  const [mutable] = useState(() => {
    const value = typeof initialValue === 'function' ? initialValue() : initialValue;
    return makeMutable(value);
  });
  useEffect(() => {
    return () => {
      cancelAnimation(mutable);
    };
  }, [mutable]);
  return mutable;
}
//# sourceMappingURL=useSharedValue.js.map