useScrollLock

A custom hook that locks and unlocks scroll.

Installation

npx sse-hooks add use-scroll-lock

yarn dlx sse-hooks add use-scroll-lock

pnpm dlx sse-hooks add use-scroll-lock

deno run -A npm:sse-hooks add use-scroll-lock

bunx sse-hooks add use-scroll-lock

example.ts

import { useScrollLock } from "./{hooks file}";

// Lock the scroll when the modal is mounted, and unlock it when it's unmounted
useScrollLock();

Prop	Default	Type
`options`	`{}`	`UseScrollLockOptions` Options to configure the hook, by default it will lock the scroll automatically.

Return Value	Default	Type
`isLocked`	-	`boolean` Whether the scroll is locked.
`lock`	-	`() => void` Lock the scroll.
`unlock`	-	`() => void` Unlock the scroll.

No specific type aliases defined for this component.

c165d — feat: enhance useRoleGuard and useSSR hooks with additional options and documentation

30da4 — feat: add new hooks and their metadata

cf13e — feat: add custom hooks for step navigation, ternary dark mode, timeout, toggle, unmount, and window size

useScript

Custom hook that dynamically loads scripts and tracking their loading status.

useTernaryDarkMode

Custom hook that manages ternary (system, dark, light) dark mode with local storage support.