UNPKG

446 BTypeScriptView Raw
1import { UseScrollConfig, Handler, EventTypes } from '../types';
2/**
3 * Scroll hook.
4 *
5 * @param handler - the function fired every time the scroll gesture updates
6 * @param [config={}] - the config object including generic options and scroll options
7 */
8export declare function useScroll<K = EventTypes['scroll']>(handler: Handler<'scroll', K>, config?: UseScrollConfig | {}): (...args: any[]) => import("../types").ReactEventHandlers;