enableBodyScrollLock

enableBodyScrollLock is a utility function that locks the body scroll. It prevents the body from scrolling by applying fixed positioning. This is useful when opening modals, drawers, or other overlay components.

Safe to call in SSR environment (no-op on server). Calling multiple times has no effect until unlocked.

Interface

function enableBodyScrollLock(): void;

Parameters

This function does not accept any parameters.

Return Value

This function does not return anything.

Example

// When modal opens
enableBodyScrollLock();

// When modal closes
disableBodyScrollLock();