useLockBodyScroll
HookPrevents body scrolling when active. Useful for modals and overlays.
npx arupui add use-lock-body-scroll
Usage
use-lock-body-scroll.tsx
import { useLockBodyScroll } from "@/hooks/use-lock-body-scroll"
function Modal({ open }: { open: boolean }) {
useLockBodyScroll(open)
if (!open) return null
return <div className="fixed inset-0">Modal content</div>
}Parameters
| Parameter | Type | Description |
|---|---|---|
lock | boolean | Whether to lock scrolling (default: true) |
lockbooleanWhether to lock scrolling (default: true)
Returns
void