react-native-ui-lib/src/hooks/useScrollToHide/index.d.ts

[](https://stand-with-ukraine.pp.ua)

import { NativeSyntheticEvent, NativeScrollEvent } from 'react-native';
export type ScrollToHideProps = {
    /**
     * The threshold (in pixels) to ignore small scroll movements before updating visibility.
     * Defaults to 0 (immediate reaction).
     */
    scrollingThreshold?: number;
};
export type ScrollToHideResult = {
    /**
     * onScroll callback (should be passed to your ScrollView/FlatList onScroll prop).
     */
    onScroll: (event: NativeSyntheticEvent<NativeScrollEvent>) => void;
    /**
     * Whether the footer should be visible based on scroll direction.
     */
    visible: boolean;
};
/**
 * @description: A hook that tracks scroll direction to toggle visibility (e.g., for hiding a footer on scroll).
 * @example: const {onScroll, visible} = useScrollToHide();
 */
declare const useScrollToHide: (props?: ScrollToHideProps) => ScrollToHideResult;
export default useScrollToHide;