fargo
1a822493ba
963 markdown files reformatted with the repository's pinned prettier so pnpm format:check covers the folded tree like every other repo file. The formatter's embedded-language pass also normalized code fences (TS semicolons, closed HTML tags in examples, lowercased CSS hex colors, one renumbered list that skipped an index). Alphanumeric token deltas vs the fold commit were audited file-by-file; all are formatter-equivalent markup normalizations plus the four sanitized skills.
1.1 KiB
1.1 KiB
category
| category |
|---|
| Sensors |
useScrollLock
Lock scrolling of the element.
Usage
<script setup lang="ts">
import { useScrollLock } from '@vueuse/core';
import { useTemplateRef } from 'vue';
const el = useTemplateRef('el');
const isLocked = useScrollLock(el);
isLocked.value = true; // lock
isLocked.value = false; // unlock
</script>
<template>
<div ref="el" />
</template>
Directive Usage
<script setup lang="ts">
import { vScrollLock } from '@vueuse/components';
const data = ref([1, 2, 3, 4, 5, 6]);
const isLocked = ref(false);
const toggleLock = useToggle(isLocked);
</script>
<template>
<div v-scroll-lock="isLocked">
<div v-for="item in data" :key="item">
{{ item }}
</div>
</div>
<button @click="toggleLock()">Toggle lock state</button>
</template>
Type Declarations
/**
* Lock scrolling of the element.
*
* @see https://vueuse.org/useScrollLock
* @param element
*/
export declare function useScrollLock(
element: MaybeRefOrGetter<HTMLElement | SVGElement | Window | Document | null | undefined>,
initialState?: boolean,
): WritableComputedRef<boolean, boolean>;