Skip to content

useLockScroll

Background scroll lock management hook with global reference counting. Multiple overlays can independently lock/unlock without conflicts.

Usage

ts
import { ref } from 'vue'
import { useLockScroll } from 'see-u-ui'

const isShow = ref(false)
const { locked, lock, unlock } = useLockScroll(isShow)

API

useLockScroll(isLocked)

ParamTypeDefaultDescription
isLockedRef<boolean>Reactive lock state

Returns:

PropertyTypeDescription
lockedRef<boolean>Current lock state
lock() => voidManual lock
unlock() => voidManual unlock

resetLockScroll()

Force-reset global lock state. Use on page navigation or keep-alive scenarios.

Liao ICP No. 2025070134