useScrollLock

useScrollLock is a hook that pauses scrolling on a page or container, such as keeping background content still behind an overlay.

Import

import { useScrollLock } from '@vortexlabs/vortex';

Other links

useScrollLock parameters
Prop	Type	Default
`options.containerRef`	`ref`	No default value
`options.originRef`	`ref`	No default value
`options.compensateScrollbar`	`boolean`	`true`

useScrollLock return value
Prop	Type	Default
`scrollLocked`	`boolean`	No default value
`lockScroll`	`callback`	No default value
`unlockScroll`	`callback`	No default value