@wikimedia/codex/dist/types/composables/useScrollLock.d.ts

Codex Design System for Wikimedia

import { type Ref } from 'vue';
/**
 * Lock document scroll behind overlays: `body` overflow, optional scrollbar compensation,
 * and on iOS-style WebKit a fixed-body freeze with scroll position restore on unlock.
 *
 * @param isActive - When true, scroll is locked
 */
export default function useScrollLock(isActive: Ref<boolean>): void;