import type { ConfigurableWindow } from '../_configurable'; import type { Position, MaybeGetter, ConfigurableEventFilter } from '../../types'; export type UseMouseSourceType = 'mouse' | 'touch' | null; export type UseMouseCoordType = 'page' | 'client' | 'screen' | 'movement'; 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?: MaybeGetter; /** * Listen to `touchmove` events * * @default true */ touch?: boolean; /** * Reset to initial value when `touchend` event fired * * @default false */ resetOnTouchEnds?: boolean; /** * Initial values */ initialValue?: Position; } /** * Reactive mouse position. * * @see https://sveltuse.pages.dev/core/useMouse * @param options */ export declare function useMouse(options?: UseMouseOptions): { x: import("svelte/store").Writable; y: import("svelte/store").Writable; sourceType: import("svelte/store").Writable; }; export type UseMouseReturn = ReturnType;