react-native-reanimated/lib/typescript/reanimated2/hook/useAnimatedScrollHandler.d.ts

More powerful alternative to Animated library for React Native.

import type { NativeScrollEvent, NativeSyntheticEvent } from 'react-native';
import type { __Context, NativeEvent, __WorkletFunction } from '../commonTypes';
import type { DependencyList } from './commonTypes';
export interface ScrollHandler<TContext extends __Context> extends __WorkletFunction {
    (event: NativeScrollEvent, context?: TContext): void;
}
export interface ScrollEvent extends NativeScrollEvent, NativeEvent<ScrollEvent> {
    eventName: string;
}
export interface ScrollHandlers<TContext extends __Context> {
    [key: string]: ScrollHandler<TContext> | undefined;
    onScroll?: ScrollHandler<TContext>;
    onBeginDrag?: ScrollHandler<TContext>;
    onEndDrag?: ScrollHandler<TContext>;
    onMomentumBegin?: ScrollHandler<TContext>;
    onMomentumEnd?: ScrollHandler<TContext>;
}
type OnScroll = (event: NativeSyntheticEvent<NativeScrollEvent>) => void;
export type useAnimatedScrollHandler = <TContext extends __Context = Record<string, never>>(handlers: ScrollHandlers<TContext> | ScrollHandler<TContext>, deps?: DependencyList) => OnScroll;
export declare const useAnimatedScrollHandler: useAnimatedScrollHandler;
export {};