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 |
usePointerLock
Reactive pointer lock.
Basic Usage
import { usePointerLock } from '@vueuse/core';
const { isSupported, lock, unlock, element, triggerElement } = usePointerLock();
Component Usage
<template>
<UsePointerLock v-slot="{ lock }">
<canvas />
<button @click="lock">Lock Pointer on Canvas</button>
</UsePointerLock>
</template>
Type Declarations
export interface UsePointerLockOptions extends ConfigurableDocument {}
/**
* Reactive pointer lock.
*
* @see https://vueuse.org/usePointerLock
* @param target
* @param options
*
* @__NO_SIDE_EFFECTS__
*/
export declare function usePointerLock(
target?: MaybeElementRef,
options?: UsePointerLockOptions,
): {
isSupported: ComputedRef<boolean>;
element: ShallowRef<MaybeElement, MaybeElement>;
triggerElement: ShallowRef<MaybeElement, MaybeElement>;
lock: (e: MaybeElementRef | Event) => Promise<HTMLElement | SVGElement>;
unlock: () => Promise<boolean>;
};
export type UsePointerLockReturn = ReturnType<typeof usePointerLock>;