fix(useResizeObserver)!: rename type ResizeObserverOptions to `UseR…

…esizeObserverOptions` (#1862)
vueuse · Jul 12, 2022 · 28db2bc · 28db2bc
1 parent 4d887e4
commit 28db2bc
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/packages/core/useElementBounding/component.ts b/packages/core/useElementBounding/component.ts
@@ -1,9 +1,9 @@
 import { defineComponent, h, reactive, ref } from 'vue-demi'
 import { useElementBounding } from '@vueuse/core'
-import type { ResizeObserverOptions } from '../useResizeObserver'
+import type { UseResizeObserverOptions } from '../useResizeObserver'
 import type { RenderableComponent } from '../types'
 
-export const UseElementBounding = defineComponent<ResizeObserverOptions & RenderableComponent>({
+export const UseElementBounding = defineComponent<UseResizeObserverOptions & RenderableComponent>({
   name: 'UseElementBounding',
   props: ['box', 'as'] as unknown as undefined,
   setup(props, { slots }) {

diff --git a/packages/core/useElementSize/component.ts b/packages/core/useElementSize/component.ts
@@ -2,9 +2,9 @@ import { defineComponent, h, reactive, ref } from 'vue-demi'
 import type { ElementSize } from '@vueuse/core'
 import { useElementSize } from '@vueuse/core'
 import type { RenderableComponent } from '../types'
-import type { ResizeObserverOptions } from '../useResizeObserver'
+import type { UseResizeObserverOptions } from '../useResizeObserver'
 
-export const UseElementSize = defineComponent<ElementSize & ResizeObserverOptions & RenderableComponent>({
+export const UseElementSize = defineComponent<ElementSize & UseResizeObserverOptions & RenderableComponent>({
   name: 'UseElementSize',
   props: ['width', 'height', 'box'] as unknown as undefined,
   setup(props, { slots }) {

diff --git a/packages/core/useElementSize/index.ts b/packages/core/useElementSize/index.ts
@@ -1,6 +1,6 @@
 import { ref, watch } from 'vue-demi'
 import type { MaybeComputedElementRef } from '../unrefElement'
-import type { ResizeObserverOptions } from '../useResizeObserver'
+import type { UseResizeObserverOptions } from '../useResizeObserver'
 import { useResizeObserver } from '../useResizeObserver'
 import { unrefElement } from '../unrefElement'
 
@@ -20,7 +20,7 @@ export interface ElementSize {
 export function useElementSize(
   target: MaybeComputedElementRef,
   initialSize: ElementSize = { width: 0, height: 0 },
-  options: ResizeObserverOptions = {},
+  options: UseResizeObserverOptions = {},
 ) {
   const width = ref(initialSize.width)
   const height = ref(initialSize.height)

diff --git a/packages/core/useResizeObserver/index.ts b/packages/core/useResizeObserver/index.ts
@@ -21,7 +21,7 @@ export interface ResizeObserverEntry {
 
 export type ResizeObserverCallback = (entries: ReadonlyArray<ResizeObserverEntry>, observer: ResizeObserver) => void
 
-export interface ResizeObserverOptions extends ConfigurableWindow {
+export interface UseResizeObserverOptions extends ConfigurableWindow {
   /**
    * Sets which box model the observer will observe changes to. Possible values
    * are `content-box` (the default), and `border-box`.
@@ -34,7 +34,7 @@ export interface ResizeObserverOptions extends ConfigurableWindow {
 declare class ResizeObserver {
   constructor(callback: ResizeObserverCallback)
   disconnect(): void
-  observe(target: Element, options?: ResizeObserverOptions): void
+  observe(target: Element, options?: UseResizeObserverOptions): void
   unobserve(target: Element): void
 }
 
@@ -49,7 +49,7 @@ declare class ResizeObserver {
 export function useResizeObserver(
   target: MaybeComputedElementRef,
   callback: ResizeObserverCallback,
-  options: ResizeObserverOptions = {},
+  options: UseResizeObserverOptions = {},
 ) {
   const { window = defaultWindow, ...observerOptions } = options
   let observer: ResizeObserver | undefined