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.
2.9 KiB
2.9 KiB
category
| category |
|---|
| Elements |
useMouseInElement
Reactive mouse position related to an element
Usage
<script setup lang="ts">
import { useMouseInElement } from '@vueuse/core';
import { useTemplateRef } from 'vue';
const target = useTemplateRef('target');
const { x, y, isOutside } = useMouseInElement(target);
</script>
<template>
<div ref="target">
<h1>Hello world</h1>
</div>
</template>
Component Usage
<template>
<UseMouseInElement v-slot="{ elementX, elementY, isOutside }">
x: {{ elementX }} y: {{ elementY }} Is Outside: {{ isOutside }}
</UseMouseInElement>
</template>
Directive Usage
<script setup lang="ts">
import { vMouseInElement } from '@vueuse/components';
import { UseMouseSourceType } from '@vueuse/core';
interface MouseInElementType {
x: number;
y: number;
sourceType: UseMouseSourceType;
elementX: number;
elementY: number;
elementPositionX: number;
elementPositionY: number;
elementHeight: number;
elementWidth: number;
isOutside: boolean;
}
const options = {
handleOutside: true,
};
function onMouseInElement({
x,
y,
sourceType,
elementX,
elementY,
elementPositionX,
elementPositionY,
elementHeight,
elementWidth,
isOutside,
}: MouseInElementType) {
console.log(
x,
y,
sourceType,
elementX,
elementY,
elementPositionX,
elementPositionY,
elementHeight,
elementWidth,
isOutside,
);
}
</script>
<template>
<textarea v-mouse-in-element="onMouseInElement" />
<!-- with options -->
<textarea v-mouse-in-element="[onMouseInElement, options]" />
</template>
Type Declarations
export interface MouseInElementOptions extends UseMouseOptions {
/**
* Whether to handle mouse events when the cursor is outside the target element.
* When enabled, mouse position will continue to be tracked even when outside the element bounds.
*
* @default true
*/
handleOutside?: boolean;
/**
* Listen to window resize event
*
* @default true
*/
windowScroll?: boolean;
/**
* Listen to window scroll event
*
* @default true
*/
windowResize?: boolean;
}
/**
* Reactive mouse position related to an element.
*
* @see https://vueuse.org/useMouseInElement
* @param target
* @param options
*/
export declare function useMouseInElement(
target?: MaybeElementRef,
options?: MouseInElementOptions,
): {
x: ShallowRef<number, number>;
y: ShallowRef<number, number>;
sourceType: ShallowRef<UseMouseSourceType, UseMouseSourceType>;
elementX: ShallowRef<number, number>;
elementY: ShallowRef<number, number>;
elementPositionX: ShallowRef<number, number>;
elementPositionY: ShallowRef<number, number>;
elementHeight: ShallowRef<number, number>;
elementWidth: ShallowRef<number, number>;
isOutside: ShallowRef<boolean, boolean>;
stop: () => void;
};
export type UseMouseInElementReturn = ReturnType<typeof useMouseInElement>;