File size: 585 Bytes
645859a
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
import { UserScrollConfig, Handler, EventTypes } from '@use-gesture/core/types';
/**
 * Scroll hook.
 *
 * @param {Handler<'scroll'>} handler - the function fired every time the scroll gesture updates
 * @param {UserScrollConfig} config - the config object including generic options and scroll options
 */
export declare function useScroll<EventType = EventTypes['scroll'], Config extends UserScrollConfig = UserScrollConfig>(handler: Handler<'scroll', EventType>, config?: Config): Config["target"] extends object ? void : (...args: any[]) => import("./types.js").ReactDOMAttributes;