@vueuse/components 12.2.0 → 12.3.0

package/index.d.cts

@@ -1,7 +1,7 @@
 import * as vue from 'vue';
-import { ComponentPublicInstance, ObjectDirective, Ref, UnwrapNestedRefs, ComputedRef, FunctionDirective } from 'vue';
+import { ComponentPublicInstance, ObjectDirective, Ref, UnwrapNestedRefs, Reactive, ComputedRef, FunctionDirective } from 'vue';
 import { MaybeRef, MaybeRefOrGetter, ConfigurableEventFilter, ConfigurableFlush, Awaitable } from '@vueuse/shared';
-import { UseClipboardOptions, UseDarkOptions, UseDevicesListOptions, UseDraggableOptions, ElementSize as ElementSize$1, UseGeolocationOptions, UseIdleOptions, UseMouseOptions, MouseInElementOptions, MousePressedOptions, UseNowOptions, UsePointerOptions, UseTimeAgoOptions, UseTimestampOptions, UseVirtualListOptions, UseWindowSizeOptions } from '@vueuse/core';
+import { UseClipboardOptions, UseDarkOptions, UseDevicesListOptions, UseDraggableOptions, ElementSize as ElementSize$1, UseGeolocationOptions, UseIdleOptions, UseMouseOptions as UseMouseOptions$1, MouseInElementOptions as MouseInElementOptions$1, MousePressedOptions, UseNowOptions, UsePointerOptions, UseTimeAgoOptions, UseTimestampOptions, UseVirtualListOptions, UseWindowSizeOptions } from '@vueuse/core';
 
 interface ConfigurableWindow {
     window?: Window;
@@ -34,6 +34,10 @@ type OnClickOutsideHandler<T extends {
     detectIframe: false;
 }> = (evt: T['detectIframe'] extends true ? PointerEvent | FocusEvent : PointerEvent) => void;
 
+interface Position {
+    x: number;
+    y: number;
+}
 interface RenderableComponent {
     /**
      * The element that the component should be rendered as
@@ -63,9 +67,9 @@ interface OnKeyStrokeOptions {
     dedupe?: MaybeRefOrGetter<boolean>;
 }
 
-type BindingValueFunction$8 = (event: KeyboardEvent) => void;
-type BindingValueArray$7 = [BindingValueFunction$8, OnKeyStrokeOptions];
-declare const vOnKeyStroke: ObjectDirective<HTMLElement, BindingValueFunction$8 | BindingValueArray$7>;
+type BindingValueFunction$a = (event: KeyboardEvent) => void;
+type BindingValueArray$9 = [BindingValueFunction$a, OnKeyStrokeOptions];
+declare const vOnKeyStroke: ObjectDirective<HTMLElement, BindingValueFunction$a | BindingValueArray$9>;
 
 interface OnLongPressOptions {
     /**
@@ -102,12 +106,12 @@ interface OnLongPressProps extends RenderableComponent {
 }
 declare const OnLongPress: vue.DefineComponent<OnLongPressProps, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<OnLongPressProps> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
 
-type BindingValueFunction$7 = (evt: PointerEvent) => void;
-type BindingValueArray$6 = [
-    BindingValueFunction$7,
+type BindingValueFunction$9 = (evt: PointerEvent) => void;
+type BindingValueArray$8 = [
+    BindingValueFunction$9,
     OnLongPressOptions
 ];
-declare const vOnLongPress: ObjectDirective<HTMLElement, BindingValueFunction$7 | BindingValueArray$6>;
+declare const vOnLongPress: ObjectDirective<HTMLElement, BindingValueFunction$9 | BindingValueArray$8>;
 
 declare const UseActiveElement: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
     [key: string]: any;
@@ -325,13 +329,73 @@ declare class ResizeObserver {
 
 declare const UseElementBounding: vue.DefineComponent<UseResizeObserverOptions & RenderableComponent, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<UseResizeObserverOptions & RenderableComponent> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
 
+interface UseElementBoundingOptions {
+    /**
+     * Reset values to 0 on component unmounted
+     *
+     * @default true
+     */
+    reset?: boolean;
+    /**
+     * Listen to window resize event
+     *
+     * @default true
+     */
+    windowResize?: boolean;
+    /**
+     * Listen to window scroll event
+     *
+     * @default true
+     */
+    windowScroll?: boolean;
+    /**
+     * Immediately call update on component mounted
+     *
+     * @default true
+     */
+    immediate?: boolean;
+    /**
+     * Timing to recalculate the bounding box
+     *
+     * Setting to `next-frame` can be useful when using this together with something like {@link useBreakpoints}
+     * and therefore the layout (which influences the bounding box of the observed element) is not updated on the current tick.
+     *
+     * @default 'sync'
+     */
+    updateTiming?: 'sync' | 'next-frame';
+}
+/**
+ * Reactive bounding box of an HTML element.
+ *
+ * @see https://vueuse.org/useElementBounding
+ * @param target
+ */
+declare function useElementBounding(target: MaybeComputedElementRef, options?: UseElementBoundingOptions): {
+    height: vue.Ref<number, number>;
+    bottom: vue.Ref<number, number>;
+    left: vue.Ref<number, number>;
+    right: vue.Ref<number, number>;
+    top: vue.Ref<number, number>;
+    width: vue.Ref<number, number>;
+    x: vue.Ref<number, number>;
+    y: vue.Ref<number, number>;
+    update: () => void;
+};
+type UseElementBoundingReturn = ReturnType<typeof useElementBounding>;
+
+type ElementBounding = Omit<UseElementBoundingReturn, 'update'>;
+type BindingValueFunction$8 = (bounding: ElementBounding) => void;
+type BindingValueArray$7 = [BindingValueFunction$8, UseElementBoundingOptions];
+declare const vElementBounding: ObjectDirective<HTMLElement, BindingValueFunction$8 | BindingValueArray$7>;
+
 interface UseElementHoverOptions extends ConfigurableWindow {
     delayEnter?: number;
     delayLeave?: number;
+    triggerOnRemoval?: boolean;
 }
 
-type BindingValueFunction$6 = (state: boolean) => void;
-declare const vElementHover: ObjectDirective<HTMLElement, BindingValueFunction$6 | [handler: BindingValueFunction$6, options: UseElementHoverOptions]>;
+type BindingValueFunction$7 = (state: boolean) => void;
+declare const vElementHover: ObjectDirective<HTMLElement, BindingValueFunction$7 | [handler: BindingValueFunction$7, options: UseElementHoverOptions]>;
 
 declare const UseElementSize: vue.DefineComponent<ElementSize$1 & UseResizeObserverOptions & RenderableComponent, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<ElementSize$1 & UseResizeObserverOptions & RenderableComponent> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
 
@@ -351,10 +415,10 @@ declare function useElementSize(target: MaybeComputedElementRef, initialSize?: E
 };
 
 type RemoveFirstFromTuple<T extends any[]> = T['length'] extends 0 ? undefined : (((...b: T) => void) extends (a: any, ...b: infer I) => void ? I : []);
-type BindingValueFunction$5 = (size: ElementSize) => void;
+type BindingValueFunction$6 = (size: ElementSize) => void;
 type VElementSizeOptions = RemoveFirstFromTuple<Parameters<typeof useElementSize>>;
-type BindingValueArray$5 = [BindingValueFunction$5, ...VElementSizeOptions];
-declare const vElementSize: ObjectDirective<HTMLElement, BindingValueFunction$5 | BindingValueArray$5>;
+type BindingValueArray$6 = [BindingValueFunction$6, ...VElementSizeOptions];
+declare const vElementSize: ObjectDirective<HTMLElement, BindingValueFunction$6 | BindingValueArray$6>;
 
 declare const UseElementVisibility: vue.DefineComponent<RenderableComponent, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<RenderableComponent> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
 
@@ -391,9 +455,9 @@ interface UseElementVisibilityOptions extends ConfigurableWindow, Pick<UseInters
     scrollTarget?: MaybeRefOrGetter<HTMLElement | undefined | null>;
 }
 
-type BindingValueFunction$4 = (state: boolean) => void;
-type BindingValueArray$4 = [BindingValueFunction$4, UseElementVisibilityOptions];
-declare const vElementVisibility: ObjectDirective<HTMLElement, BindingValueFunction$4 | BindingValueArray$4>;
+type BindingValueFunction$5 = (state: boolean) => void;
+type BindingValueArray$5 = [BindingValueFunction$5, UseElementVisibilityOptions];
+declare const vElementVisibility: ObjectDirective<HTMLElement, BindingValueFunction$5 | BindingValueArray$5>;
 
 declare const UseEyeDropper: vue.DefineComponent<vue.ExtractPropTypes<{
     sRGBHex: StringConstructor;
@@ -413,6 +477,8 @@ declare const UseIdle: vue.DefineComponent<UseIdleOptions & {
     timeout: number;
 }> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
 
+type UseMouseSourceType = 'mouse' | 'touch' | null;
+
 interface UseImageOptions {
     /** Address of the resource */
     src: string;
@@ -564,17 +630,86 @@ declare function useInfiniteScroll<T extends InfiniteScrollElement>(element: May
     reset(): void;
 };
 
-type BindingValueFunction$3 = Parameters<typeof useInfiniteScroll>[1];
-type BindingValueArray$3 = [BindingValueFunction$3, UseInfiniteScrollOptions];
-declare const vInfiniteScroll: ObjectDirective<HTMLElement, BindingValueFunction$3 | BindingValueArray$3>;
+type BindingValueFunction$4 = Parameters<typeof useInfiniteScroll>[1];
+type BindingValueArray$4 = [BindingValueFunction$4, UseInfiniteScrollOptions];
+declare const vInfiniteScroll: ObjectDirective<HTMLElement, BindingValueFunction$4 | BindingValueArray$4>;
 
-type BindingValueFunction$2 = IntersectionObserverCallback;
-type BindingValueArray$2 = [BindingValueFunction$2, UseIntersectionObserverOptions];
-declare const vIntersectionObserver: ObjectDirective<HTMLElement, BindingValueFunction$2 | BindingValueArray$2>;
+type BindingValueFunction$3 = IntersectionObserverCallback;
+type BindingValueArray$3 = [BindingValueFunction$3, UseIntersectionObserverOptions];
+declare const vIntersectionObserver: ObjectDirective<HTMLElement, BindingValueFunction$3 | BindingValueArray$3>;
 
-declare const UseMouse: vue.DefineComponent<UseMouseOptions, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<UseMouseOptions> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
+declare const UseMouse: vue.DefineComponent<UseMouseOptions$1, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<UseMouseOptions$1> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
+
+declare const UseMouseInElement: vue.DefineComponent<MouseInElementOptions$1 & RenderableComponent, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<MouseInElementOptions$1 & RenderableComponent> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
+
+type UseMouseCoordType = 'page' | 'client' | 'screen' | 'movement';
+type UseMouseEventExtractor = (event: MouseEvent | Touch) => [x: number, y: number] | null | undefined;
+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;
+}
+
+interface MouseInElementOptions extends UseMouseOptions {
+    handleOutside?: boolean;
+}
+/**
+ * Reactive mouse position related to an element.
+ *
+ * @see https://vueuse.org/useMouseInElement
+ * @param target
+ * @param options
+ */
+declare function useMouseInElement(target?: MaybeElementRef, options?: MouseInElementOptions): {
+    x: vue.Ref<number, number>;
+    y: vue.Ref<number, number>;
+    sourceType: vue.Ref<UseMouseSourceType, UseMouseSourceType>;
+    elementX: vue.Ref<number, number>;
+    elementY: vue.Ref<number, number>;
+    elementPositionX: vue.Ref<number, number>;
+    elementPositionY: vue.Ref<number, number>;
+    elementHeight: vue.Ref<number, number>;
+    elementWidth: vue.Ref<number, number>;
+    isOutside: vue.Ref<boolean, boolean>;
+    stop: () => void;
+};
+type UseMouseInElementReturn = ReturnType<typeof useMouseInElement>;
 
-declare const UseMouseInElement: vue.DefineComponent<MouseInElementOptions & RenderableComponent, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<MouseInElementOptions & RenderableComponent> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
+type MouseInElement = Omit<UseMouseInElementReturn, 'stop'>;
+type BindingValueFunction$2 = (mouse: Reactive<MouseInElement>) => void;
+type BindingValueArray$2 = [BindingValueFunction$2, MouseInElementOptions];
+declare const vMouseInElement: ObjectDirective<HTMLElement, BindingValueFunction$2 | BindingValueArray$2>;
 
 declare const UseMousePressed: vue.DefineComponent<Omit<MousePressedOptions, "target"> & RenderableComponent, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<Omit<MousePressedOptions, "target"> & RenderableComponent> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
 
@@ -733,4 +868,4 @@ declare const UseWindowFocus: vue.DefineComponent<{}, () => vue.VNode<vue.Render
 
 declare const UseWindowSize: vue.DefineComponent<UseWindowSizeOptions, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<UseWindowSizeOptions> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
 
-export { OnClickOutside, type OnClickOutsideProps, OnLongPress, type OnLongPressProps, UseActiveElement, UseBattery, UseBrowserLocation, UseClipboard, UseColorMode, UseDark, UseDeviceMotion, UseDeviceOrientation, UseDevicePixelRatio, UseDevicesList, UseDocumentVisibility, UseDraggable, type UseDraggableProps, UseElementBounding, UseElementSize, UseElementVisibility, UseEyeDropper, UseFullscreen, UseGeolocation, UseIdle, UseImage, UseMouse, UseMouseInElement, UseMousePressed, UseNetwork, UseNow, UseObjectUrl, type UseObjectUrlProps, UseOffsetPagination, UseOnline, UsePageLeave, UsePointer, UsePointerLock, UsePreferredColorScheme, UsePreferredContrast, UsePreferredDark, UsePreferredLanguages, UsePreferredReducedMotion, UsePreferredReducedTransparency, UseScreenSafeArea, UseTimeAgo, UseTimestamp, UseVirtualList, type UseVirtualListProps, UseWindowFocus, UseWindowSize, vOnClickOutside as VOnClickOutside, vOnLongPress as VOnLongPress, vElementHover, vElementSize, vElementVisibility, vInfiniteScroll, vIntersectionObserver, vOnClickOutside, vOnKeyStroke, vOnLongPress, vResizeObserver, vScroll, vScrollLock };
+export { OnClickOutside, type OnClickOutsideProps, OnLongPress, type OnLongPressProps, UseActiveElement, UseBattery, UseBrowserLocation, UseClipboard, UseColorMode, UseDark, UseDeviceMotion, UseDeviceOrientation, UseDevicePixelRatio, UseDevicesList, UseDocumentVisibility, UseDraggable, type UseDraggableProps, UseElementBounding, UseElementSize, UseElementVisibility, UseEyeDropper, UseFullscreen, UseGeolocation, UseIdle, UseImage, UseMouse, UseMouseInElement, UseMousePressed, UseNetwork, UseNow, UseObjectUrl, type UseObjectUrlProps, UseOffsetPagination, UseOnline, UsePageLeave, UsePointer, UsePointerLock, UsePreferredColorScheme, UsePreferredContrast, UsePreferredDark, UsePreferredLanguages, UsePreferredReducedMotion, UsePreferredReducedTransparency, UseScreenSafeArea, UseTimeAgo, UseTimestamp, UseVirtualList, type UseVirtualListProps, UseWindowFocus, UseWindowSize, vOnClickOutside as VOnClickOutside, vOnLongPress as VOnLongPress, vElementBounding, vElementHover, vElementSize, vElementVisibility, vInfiniteScroll, vIntersectionObserver, vMouseInElement, vOnClickOutside, vOnKeyStroke, vOnLongPress, vResizeObserver, vScroll, vScrollLock };

package/index.d.mts

@@ -1,7 +1,7 @@
 import * as vue from 'vue';
-import { ComponentPublicInstance, ObjectDirective, Ref, UnwrapNestedRefs, ComputedRef, FunctionDirective } from 'vue';
+import { ComponentPublicInstance, ObjectDirective, Ref, UnwrapNestedRefs, Reactive, ComputedRef, FunctionDirective } from 'vue';
 import { MaybeRef, MaybeRefOrGetter, ConfigurableEventFilter, ConfigurableFlush, Awaitable } from '@vueuse/shared';
-import { UseClipboardOptions, UseDarkOptions, UseDevicesListOptions, UseDraggableOptions, ElementSize as ElementSize$1, UseGeolocationOptions, UseIdleOptions, UseMouseOptions, MouseInElementOptions, MousePressedOptions, UseNowOptions, UsePointerOptions, UseTimeAgoOptions, UseTimestampOptions, UseVirtualListOptions, UseWindowSizeOptions } from '@vueuse/core';
+import { UseClipboardOptions, UseDarkOptions, UseDevicesListOptions, UseDraggableOptions, ElementSize as ElementSize$1, UseGeolocationOptions, UseIdleOptions, UseMouseOptions as UseMouseOptions$1, MouseInElementOptions as MouseInElementOptions$1, MousePressedOptions, UseNowOptions, UsePointerOptions, UseTimeAgoOptions, UseTimestampOptions, UseVirtualListOptions, UseWindowSizeOptions } from '@vueuse/core';
 
 interface ConfigurableWindow {
     window?: Window;
@@ -34,6 +34,10 @@ type OnClickOutsideHandler<T extends {
     detectIframe: false;
 }> = (evt: T['detectIframe'] extends true ? PointerEvent | FocusEvent : PointerEvent) => void;
 
+interface Position {
+    x: number;
+    y: number;
+}
 interface RenderableComponent {
     /**
      * The element that the component should be rendered as
@@ -63,9 +67,9 @@ interface OnKeyStrokeOptions {
     dedupe?: MaybeRefOrGetter<boolean>;
 }
 
-type BindingValueFunction$8 = (event: KeyboardEvent) => void;
-type BindingValueArray$7 = [BindingValueFunction$8, OnKeyStrokeOptions];
-declare const vOnKeyStroke: ObjectDirective<HTMLElement, BindingValueFunction$8 | BindingValueArray$7>;
+type BindingValueFunction$a = (event: KeyboardEvent) => void;
+type BindingValueArray$9 = [BindingValueFunction$a, OnKeyStrokeOptions];
+declare const vOnKeyStroke: ObjectDirective<HTMLElement, BindingValueFunction$a | BindingValueArray$9>;
 
 interface OnLongPressOptions {
     /**
@@ -102,12 +106,12 @@ interface OnLongPressProps extends RenderableComponent {
 }
 declare const OnLongPress: vue.DefineComponent<OnLongPressProps, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<OnLongPressProps> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
 
-type BindingValueFunction$7 = (evt: PointerEvent) => void;
-type BindingValueArray$6 = [
-    BindingValueFunction$7,
+type BindingValueFunction$9 = (evt: PointerEvent) => void;
+type BindingValueArray$8 = [
+    BindingValueFunction$9,
     OnLongPressOptions
 ];
-declare const vOnLongPress: ObjectDirective<HTMLElement, BindingValueFunction$7 | BindingValueArray$6>;
+declare const vOnLongPress: ObjectDirective<HTMLElement, BindingValueFunction$9 | BindingValueArray$8>;
 
 declare const UseActiveElement: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
     [key: string]: any;
@@ -325,13 +329,73 @@ declare class ResizeObserver {
 
 declare const UseElementBounding: vue.DefineComponent<UseResizeObserverOptions & RenderableComponent, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<UseResizeObserverOptions & RenderableComponent> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
 
+interface UseElementBoundingOptions {
+    /**
+     * Reset values to 0 on component unmounted
+     *
+     * @default true
+     */
+    reset?: boolean;
+    /**
+     * Listen to window resize event
+     *
+     * @default true
+     */
+    windowResize?: boolean;
+    /**
+     * Listen to window scroll event
+     *
+     * @default true
+     */
+    windowScroll?: boolean;
+    /**
+     * Immediately call update on component mounted
+     *
+     * @default true
+     */
+    immediate?: boolean;
+    /**
+     * Timing to recalculate the bounding box
+     *
+     * Setting to `next-frame` can be useful when using this together with something like {@link useBreakpoints}
+     * and therefore the layout (which influences the bounding box of the observed element) is not updated on the current tick.
+     *
+     * @default 'sync'
+     */
+    updateTiming?: 'sync' | 'next-frame';
+}
+/**
+ * Reactive bounding box of an HTML element.
+ *
+ * @see https://vueuse.org/useElementBounding
+ * @param target
+ */
+declare function useElementBounding(target: MaybeComputedElementRef, options?: UseElementBoundingOptions): {
+    height: vue.Ref<number, number>;
+    bottom: vue.Ref<number, number>;
+    left: vue.Ref<number, number>;
+    right: vue.Ref<number, number>;
+    top: vue.Ref<number, number>;
+    width: vue.Ref<number, number>;
+    x: vue.Ref<number, number>;
+    y: vue.Ref<number, number>;
+    update: () => void;
+};
+type UseElementBoundingReturn = ReturnType<typeof useElementBounding>;
+
+type ElementBounding = Omit<UseElementBoundingReturn, 'update'>;
+type BindingValueFunction$8 = (bounding: ElementBounding) => void;
+type BindingValueArray$7 = [BindingValueFunction$8, UseElementBoundingOptions];
+declare const vElementBounding: ObjectDirective<HTMLElement, BindingValueFunction$8 | BindingValueArray$7>;
+
 interface UseElementHoverOptions extends ConfigurableWindow {
     delayEnter?: number;
     delayLeave?: number;
+    triggerOnRemoval?: boolean;
 }
 
-type BindingValueFunction$6 = (state: boolean) => void;
-declare const vElementHover: ObjectDirective<HTMLElement, BindingValueFunction$6 | [handler: BindingValueFunction$6, options: UseElementHoverOptions]>;
+type BindingValueFunction$7 = (state: boolean) => void;
+declare const vElementHover: ObjectDirective<HTMLElement, BindingValueFunction$7 | [handler: BindingValueFunction$7, options: UseElementHoverOptions]>;
 
 declare const UseElementSize: vue.DefineComponent<ElementSize$1 & UseResizeObserverOptions & RenderableComponent, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<ElementSize$1 & UseResizeObserverOptions & RenderableComponent> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
 
@@ -351,10 +415,10 @@ declare function useElementSize(target: MaybeComputedElementRef, initialSize?: E
 };
 
 type RemoveFirstFromTuple<T extends any[]> = T['length'] extends 0 ? undefined : (((...b: T) => void) extends (a: any, ...b: infer I) => void ? I : []);
-type BindingValueFunction$5 = (size: ElementSize) => void;
+type BindingValueFunction$6 = (size: ElementSize) => void;
 type VElementSizeOptions = RemoveFirstFromTuple<Parameters<typeof useElementSize>>;
-type BindingValueArray$5 = [BindingValueFunction$5, ...VElementSizeOptions];
-declare const vElementSize: ObjectDirective<HTMLElement, BindingValueFunction$5 | BindingValueArray$5>;
+type BindingValueArray$6 = [BindingValueFunction$6, ...VElementSizeOptions];
+declare const vElementSize: ObjectDirective<HTMLElement, BindingValueFunction$6 | BindingValueArray$6>;
 
 declare const UseElementVisibility: vue.DefineComponent<RenderableComponent, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<RenderableComponent> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
 
@@ -391,9 +455,9 @@ interface UseElementVisibilityOptions extends ConfigurableWindow, Pick<UseInters
     scrollTarget?: MaybeRefOrGetter<HTMLElement | undefined | null>;
 }
 
-type BindingValueFunction$4 = (state: boolean) => void;
-type BindingValueArray$4 = [BindingValueFunction$4, UseElementVisibilityOptions];
-declare const vElementVisibility: ObjectDirective<HTMLElement, BindingValueFunction$4 | BindingValueArray$4>;
+type BindingValueFunction$5 = (state: boolean) => void;
+type BindingValueArray$5 = [BindingValueFunction$5, UseElementVisibilityOptions];
+declare const vElementVisibility: ObjectDirective<HTMLElement, BindingValueFunction$5 | BindingValueArray$5>;
 
 declare const UseEyeDropper: vue.DefineComponent<vue.ExtractPropTypes<{
     sRGBHex: StringConstructor;
@@ -413,6 +477,8 @@ declare const UseIdle: vue.DefineComponent<UseIdleOptions & {
     timeout: number;
 }> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
 
+type UseMouseSourceType = 'mouse' | 'touch' | null;
+
 interface UseImageOptions {
     /** Address of the resource */
     src: string;
@@ -564,17 +630,86 @@ declare function useInfiniteScroll<T extends InfiniteScrollElement>(element: May
     reset(): void;
 };
 
-type BindingValueFunction$3 = Parameters<typeof useInfiniteScroll>[1];
-type BindingValueArray$3 = [BindingValueFunction$3, UseInfiniteScrollOptions];
-declare const vInfiniteScroll: ObjectDirective<HTMLElement, BindingValueFunction$3 | BindingValueArray$3>;
+type BindingValueFunction$4 = Parameters<typeof useInfiniteScroll>[1];
+type BindingValueArray$4 = [BindingValueFunction$4, UseInfiniteScrollOptions];
+declare const vInfiniteScroll: ObjectDirective<HTMLElement, BindingValueFunction$4 | BindingValueArray$4>;
 
-type BindingValueFunction$2 = IntersectionObserverCallback;
-type BindingValueArray$2 = [BindingValueFunction$2, UseIntersectionObserverOptions];
-declare const vIntersectionObserver: ObjectDirective<HTMLElement, BindingValueFunction$2 | BindingValueArray$2>;
+type BindingValueFunction$3 = IntersectionObserverCallback;
+type BindingValueArray$3 = [BindingValueFunction$3, UseIntersectionObserverOptions];
+declare const vIntersectionObserver: ObjectDirective<HTMLElement, BindingValueFunction$3 | BindingValueArray$3>;
 
-declare const UseMouse: vue.DefineComponent<UseMouseOptions, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<UseMouseOptions> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
+declare const UseMouse: vue.DefineComponent<UseMouseOptions$1, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<UseMouseOptions$1> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
+
+declare const UseMouseInElement: vue.DefineComponent<MouseInElementOptions$1 & RenderableComponent, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<MouseInElementOptions$1 & RenderableComponent> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
+
+type UseMouseCoordType = 'page' | 'client' | 'screen' | 'movement';
+type UseMouseEventExtractor = (event: MouseEvent | Touch) => [x: number, y: number] | null | undefined;
+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;
+}
+
+interface MouseInElementOptions extends UseMouseOptions {
+    handleOutside?: boolean;
+}
+/**
+ * Reactive mouse position related to an element.
+ *
+ * @see https://vueuse.org/useMouseInElement
+ * @param target
+ * @param options
+ */
+declare function useMouseInElement(target?: MaybeElementRef, options?: MouseInElementOptions): {
+    x: vue.Ref<number, number>;
+    y: vue.Ref<number, number>;
+    sourceType: vue.Ref<UseMouseSourceType, UseMouseSourceType>;
+    elementX: vue.Ref<number, number>;
+    elementY: vue.Ref<number, number>;
+    elementPositionX: vue.Ref<number, number>;
+    elementPositionY: vue.Ref<number, number>;
+    elementHeight: vue.Ref<number, number>;
+    elementWidth: vue.Ref<number, number>;
+    isOutside: vue.Ref<boolean, boolean>;
+    stop: () => void;
+};
+type UseMouseInElementReturn = ReturnType<typeof useMouseInElement>;
 
-declare const UseMouseInElement: vue.DefineComponent<MouseInElementOptions & RenderableComponent, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<MouseInElementOptions & RenderableComponent> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
+type MouseInElement = Omit<UseMouseInElementReturn, 'stop'>;
+type BindingValueFunction$2 = (mouse: Reactive<MouseInElement>) => void;
+type BindingValueArray$2 = [BindingValueFunction$2, MouseInElementOptions];
+declare const vMouseInElement: ObjectDirective<HTMLElement, BindingValueFunction$2 | BindingValueArray$2>;
 
 declare const UseMousePressed: vue.DefineComponent<Omit<MousePressedOptions, "target"> & RenderableComponent, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<Omit<MousePressedOptions, "target"> & RenderableComponent> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
 
@@ -733,4 +868,4 @@ declare const UseWindowFocus: vue.DefineComponent<{}, () => vue.VNode<vue.Render
 
 declare const UseWindowSize: vue.DefineComponent<UseWindowSizeOptions, {}, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<UseWindowSizeOptions> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, false, {}, any>;
 
-export { OnClickOutside, type OnClickOutsideProps, OnLongPress, type OnLongPressProps, UseActiveElement, UseBattery, UseBrowserLocation, UseClipboard, UseColorMode, UseDark, UseDeviceMotion, UseDeviceOrientation, UseDevicePixelRatio, UseDevicesList, UseDocumentVisibility, UseDraggable, type UseDraggableProps, UseElementBounding, UseElementSize, UseElementVisibility, UseEyeDropper, UseFullscreen, UseGeolocation, UseIdle, UseImage, UseMouse, UseMouseInElement, UseMousePressed, UseNetwork, UseNow, UseObjectUrl, type UseObjectUrlProps, UseOffsetPagination, UseOnline, UsePageLeave, UsePointer, UsePointerLock, UsePreferredColorScheme, UsePreferredContrast, UsePreferredDark, UsePreferredLanguages, UsePreferredReducedMotion, UsePreferredReducedTransparency, UseScreenSafeArea, UseTimeAgo, UseTimestamp, UseVirtualList, type UseVirtualListProps, UseWindowFocus, UseWindowSize, vOnClickOutside as VOnClickOutside, vOnLongPress as VOnLongPress, vElementHover, vElementSize, vElementVisibility, vInfiniteScroll, vIntersectionObserver, vOnClickOutside, vOnKeyStroke, vOnLongPress, vResizeObserver, vScroll, vScrollLock };
+export { OnClickOutside, type OnClickOutsideProps, OnLongPress, type OnLongPressProps, UseActiveElement, UseBattery, UseBrowserLocation, UseClipboard, UseColorMode, UseDark, UseDeviceMotion, UseDeviceOrientation, UseDevicePixelRatio, UseDevicesList, UseDocumentVisibility, UseDraggable, type UseDraggableProps, UseElementBounding, UseElementSize, UseElementVisibility, UseEyeDropper, UseFullscreen, UseGeolocation, UseIdle, UseImage, UseMouse, UseMouseInElement, UseMousePressed, UseNetwork, UseNow, UseObjectUrl, type UseObjectUrlProps, UseOffsetPagination, UseOnline, UsePageLeave, UsePointer, UsePointerLock, UsePreferredColorScheme, UsePreferredContrast, UsePreferredDark, UsePreferredLanguages, UsePreferredReducedMotion, UsePreferredReducedTransparency, UseScreenSafeArea, UseTimeAgo, UseTimestamp, UseVirtualList, type UseVirtualListProps, UseWindowFocus, UseWindowSize, vOnClickOutside as VOnClickOutside, vOnLongPress as VOnLongPress, vElementBounding, vElementHover, vElementSize, vElementVisibility, vInfiniteScroll, vIntersectionObserver, vMouseInElement, vOnClickOutside, vOnKeyStroke, vOnLongPress, vResizeObserver, vScroll, vScrollLock };