react-native-reanimated/src/reanimated2/hook/Hooks.ts

More powerful alternative to Animated library for React Native.

import { useCallback } from 'react';
import { useAnimatedStyle } from './useAnimatedStyle';
import type { DependencyList } from './commonTypes';
import type {
  AnimatedPropsAdapterFunction,
  useAnimatedPropsType,
} from '../helperTypes';
import { shouldBeUseWeb } from '../PlatformChecker';

// TODO: we should make sure that when useAP is used we are not assigning styles
// when you need styles to animated you should always use useAS
// TODO TYPESCRIPT This is a temporary cast to get rid of .d.ts file.

export let useAnimatedProps: useAnimatedPropsType;

if (shouldBeUseWeb()) {
  useAnimatedProps = function <T extends object>(
    updater: () => Partial<T>,
    deps?: DependencyList | null,
    adapters?:
      | AnimatedPropsAdapterFunction
      | AnimatedPropsAdapterFunction[]
      | null
  ) {
    return (useAnimatedStyle as useAnimatedPropsType)(
      updater,
      deps,
      adapters,
      true
    );
  };
} else {
  useAnimatedProps = useAnimatedStyle as useAnimatedPropsType;
}

export function useWorkletCallback<A extends unknown[], R>(
  fun: (...args: A) => R,
  deps?: DependencyList
): (...args: Parameters<typeof fun>) => R {
  return useCallback(fun, deps ?? []);
}

export { useEvent, useHandler } from './utils';