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,84 @@
+---
+category: Sensors
+---
+
+# usePointer
+
+Reactive [pointer state](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_events).
+
+## Basic Usage
+
+```ts
+import { usePointer } from '@vueuse/core';
+
+const { x, y, pressure, pointerType } = usePointer();
+```
+
+## Component Usage
+
+By default, the component will track the pointer on `window`
+
+```vue
+<template>
+  <UsePointer v-slot="{ x, y }"> x: {{ x }} y: {{ y }} </UsePointer>
+</template>
+```
+
+To track local position in the element, set `target="self"`:
+
+```vue
+<template>
+  <UsePointer v-slot="{ x, y }" target="self"> x: {{ x }} y: {{ y }} </UsePointer>
+</template>
+```
+
+## Type Declarations
+
+```ts
+export interface UsePointerState extends Position {
+  pressure: number;
+  pointerId: number;
+  tiltX: number;
+  tiltY: number;
+  width: number;
+  height: number;
+  twist: number;
+  pointerType: PointerType | null;
+}
+export interface UsePointerOptions extends ConfigurableWindow {
+  /**
+   * Pointer types that listen to.
+   *
+   * @default ['mouse', 'touch', 'pen']
+   */
+  pointerTypes?: PointerType[];
+  /**
+   * Initial values
+   */
+  initialValue?: MaybeRef<Partial<UsePointerState>>;
+  /**
+   * @default window
+   */
+  target?: MaybeRef<EventTarget | null | undefined> | Document | Window;
+}
+/**
+ * Reactive pointer state.
+ *
+ * @see https://vueuse.org/usePointer
+ * @param options
+ */
+export declare function usePointer(options?: UsePointerOptions): {
+  isInside: ShallowRef<boolean, boolean>;
+  pressure: Ref<number, number>;
+  pointerId: Ref<number, number>;
+  tiltX: Ref<number, number>;
+  tiltY: Ref<number, number>;
+  width: Ref<number, number>;
+  height: Ref<number, number>;
+  twist: Ref<number, number>;
+  pointerType: Ref<PointerType | null, PointerType | null>;
+  x: Ref<number, number>;
+  y: Ref<number, number>;
+};
+export type UsePointerReturn = ReturnType<typeof usePointer>;
+```