fix(useMouse)!: rename type MouseOptions to UseMouseOptions (#1877)

vueuse · Jul 12, 2022 · 4d2c8ad · 4d2c8ad
1 parent 8afa60e
commit 4d2c8ad
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/packages/core/useMouse/component.ts b/packages/core/useMouse/component.ts
@@ -1,8 +1,8 @@
 import { defineComponent, reactive } from 'vue-demi'
-import type { MouseOptions } from '@vueuse/core'
+import type { UseMouseOptions } from '@vueuse/core'
 import { useMouse } from '@vueuse/core'
 
-export const UseMouse = defineComponent<MouseOptions>({
+export const UseMouse = defineComponent<UseMouseOptions>({
   name: 'UseMouse',
   props: ['touch', 'resetOnTouchEnds', 'initialValue'] as unknown as undefined,
   setup(props, { slots }) {

diff --git a/packages/core/useMouse/index.ts b/packages/core/useMouse/index.ts
@@ -5,7 +5,7 @@ import type { ConfigurableWindow } from '../_configurable'
 import { defaultWindow } from '../_configurable'
 import type { Position } from '../types'
 
-export interface MouseOptions extends ConfigurableWindow, ConfigurableEventFilter {
+export interface UseMouseOptions extends ConfigurableWindow, ConfigurableEventFilter {
   /**
    * Mouse position based by page or client
    *
@@ -40,7 +40,7 @@ export type MouseSourceType = 'mouse' | 'touch' | null
  * @see https://vueuse.org/useMouse
  * @param options
  */
-export function useMouse(options: MouseOptions = {}) {
+export function useMouse(options: UseMouseOptions = {}) {
   const {
     type = 'page',
     touch = true,

diff --git a/packages/core/useMouseInElement/index.ts b/packages/core/useMouseInElement/index.ts
@@ -1,11 +1,11 @@
 import { ref, watch } from 'vue-demi'
 import type { MaybeElementRef } from '../unrefElement'
 import { unrefElement } from '../unrefElement'
-import type { MouseOptions } from '../useMouse'
+import type { UseMouseOptions } from '../useMouse'
 import { useMouse } from '../useMouse'
 import { defaultWindow } from '../_configurable'
 
-export interface MouseInElementOptions extends MouseOptions {
+export interface MouseInElementOptions extends UseMouseOptions {
   handleOutside?: boolean
 }