chore: consolidate new foundation and archive v1 (#1495)

2026-09-07 12:32:57 -05:00
parent 9a5fbdbda7 5d27700026
commit 127a54fdff
3511 changed files with 727899 additions and 10 deletions
@@ -0,0 +1,52 @@
+---
+category: Sensors
+---
+
+# usePointerLock
+
+Reactive [pointer lock](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API).
+
+## Basic Usage
+
+```ts
+import { usePointerLock } from '@vueuse/core';
+
+const { isSupported, lock, unlock, element, triggerElement } = usePointerLock();
+```
+
+## Component Usage
+
+```vue
+<template>
+  <UsePointerLock v-slot="{ lock }">
+    <canvas />
+    <button @click="lock">Lock Pointer on Canvas</button>
+  </UsePointerLock>
+</template>
+```
+
+## Type Declarations
+
+```ts
+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>;
+```