react-native-reanimated/lib/typescript/hook/useScrollOffset.native.d.ts

More powerful alternative to Animated library for React Native.

import type { Maybe } from '../common';
import type { InstanceOrElement, SharedValue } from '../commonTypes';
import type { AnimatedRef } from './commonTypes';
/**
 * Lets you synchronously get the current offset of a scrollable component.
 *
 * @param animatedRef - An [animated
 *   ref](https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedRef)
 *   attached to a scrollable component.
 * @returns A shared value which holds the current scroll offset of the
 *   scrollable component.
 * @see https://docs.swmansion.com/react-native-reanimated/docs/scroll/useScrollOffset
 */
export declare function useScrollOffset<TRef extends InstanceOrElement>(animatedRef: Maybe<AnimatedRef<TRef>>, providedOffset?: SharedValue<number>): SharedValue<number>;
//# sourceMappingURL=useScrollOffset.native.d.ts.map