Files

T

fargo 1a822493ba format: apply repo prettier (3.8.1) to the folded skills tree

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.

2026-08-19 14:37:17 -05:00

2.5 KiB

Raw Blame History

category
Sensors

useMouse

Reactive mouse position

Basic Usage

import { useMouse } from '@vueuse/core';

const { x, y, sourceType } = useMouse();

Touch is enabled by default. To only detect mouse changes, set touch to false. The dragover event is used to track mouse position while dragging.

import { useMouse } from '@vueuse/core';
// ---cut---
const { x, y } = useMouse({ touch: false });

Custom Extractor

It's also possible to provide a custom extractor function to get the position from the event.

import type { UseMouseEventExtractor } from '@vueuse/core';
import { useMouse, useParentElement } from '@vueuse/core';

const parentEl = useParentElement();

const extractor: UseMouseEventExtractor = (event) =>
  event instanceof MouseEvent ? [event.offsetX, event.offsetY] : null;

const { x, y, sourceType } = useMouse({ target: parentEl, type: extractor });

Component Usage

<template>
  <UseMouse v-slot="{ x, y }"> x: {{ x }} y: {{ y }} </UseMouse>
</template>

Type Declarations

export type UseMouseCoordType = 'page' | 'client' | 'screen' | 'movement';
export type UseMouseSourceType = 'mouse' | 'touch' | null;
export type UseMouseEventExtractor = (
  event: MouseEvent | Touch,
) => [x: number, y: number] | null | undefined;
export interface UseMouseOptions extends ConfigurableWindow, ConfigurableEventFilter {
  /**
   * Mouse position based by page, client, screen, or relative to previous position
   *
   * @default 'page'
   */
  type?: UseMouseCoordType | UseMouseEventExtractor;
  /**
   * Listen events on `target` element
   *
   * @default 'Window'
   */
  target?: MaybeRefOrGetter<Window | EventTarget | null | undefined>;
  /**
   * Listen to `touchmove` events
   *
   * @default true
   */
  touch?: boolean;
  /**
   * Listen to `scroll` events on window, only effective on type `page`
   *
   * @default true
   */
  scroll?: boolean;
  /**
   * Reset to initial value when `touchend` event fired
   *
   * @default false
   */
  resetOnTouchEnds?: boolean;
  /**
   * Initial values
   */
  initialValue?: Position;
}
/**
 * Reactive mouse position.
 *
 * @see https://vueuse.org/useMouse
 * @param options
 */
export declare function useMouse(options?: UseMouseOptions): {
  x: ShallowRef<number, number>;
  y: ShallowRef<number, number>;
  sourceType: ShallowRef<UseMouseSourceType, UseMouseSourceType>;
};
export type UseMouseReturn = ReturnType<typeof useMouse>;

2.5 KiB Raw Blame History