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.8 KiB
1.8 KiB
category
| category |
|---|
| Sensors |
usePointer
Reactive pointer state.
Basic Usage
import { usePointer } from '@vueuse/core';
const { x, y, pressure, pointerType } = usePointer();
Component Usage
By default, the component will track the pointer on window
<template>
<UsePointer v-slot="{ x, y }"> x: {{ x }} y: {{ y }} </UsePointer>
</template>
To track local position in the element, set target="self":
<template>
<UsePointer v-slot="{ x, y }" target="self"> x: {{ x }} y: {{ y }} </UsePointer>
</template>
Type Declarations
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>;