import type { ReactSetState } from "../use-safe-state/index.cjs"; import type { ElementTarget } from "../use-target-element/index.cjs"; export type UseScrollLockReturnsActions = { /** * Lock the scroll */ lock(): void; /** * Unlock the scroll */ unlock(): void; /** * Toggle the scroll lock */ toggle(): void; }; export type UseScrollLockReturns = [ /** * Whether the scroll is locked */ isLocked: boolean, /** * Set the scroll lock */ setLocked: ReactSetState, /** * Actions to lock/unlock the scroll */ UseScrollLockReturnsActions ]; /** * A React Hook that helps to lock/unlock the scroll behavior of an element. */ export declare function useScrollLock(target: ElementTarget, initialState?: boolean): UseScrollLockReturns;