Skip to content

Commit d7a0701

Browse files
authored
fix(types): deprecate embeded ResizeObserverSize types (#5127)
1 parent aee846c commit d7a0701

File tree

2 files changed

+15
-17
lines changed

2 files changed

+15
-17
lines changed

packages/core/useResizeObserver/directive.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import type { ResizeObserverCallback, UseResizeObserverOptions } from '@vueuse/core'
1+
import type { UseResizeObserverOptions } from '@vueuse/core'
22
import type { ObjectDirective } from 'vue'
33
import { useResizeObserver } from '@vueuse/core'
44

packages/core/useResizeObserver/index.ts

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,19 @@ import { defaultWindow } from '../_configurable'
77
import { unrefElement } from '../unrefElement'
88
import { useSupported } from '../useSupported'
99

10+
/**
11+
* @deprecated This interface is now available in the DOM lib.
12+
* Use the global {@link globalThis.ResizeObserverSize} instead.
13+
*/
1014
export interface ResizeObserverSize {
1115
readonly inlineSize: number
1216
readonly blockSize: number
1317
}
1418

19+
/**
20+
* @deprecated This interface is now available in the DOM lib.
21+
* Use the global {@link globalThis.ResizeObserverEntry} instead.
22+
*/
1523
export interface ResizeObserverEntry {
1624
readonly target: Element
1725
readonly contentRect: DOMRectReadOnly
@@ -20,23 +28,13 @@ export interface ResizeObserverEntry {
2028
readonly devicePixelContentBoxSize: ReadonlyArray<ResizeObserverSize>
2129
}
2230

31+
/**
32+
* @deprecated This interface is now available in the DOM lib.
33+
* Use the global {@link globalThis.ResizeObserverCallback} instead.
34+
*/
2335
export type ResizeObserverCallback = (entries: ReadonlyArray<ResizeObserverEntry>, observer: ResizeObserver) => void
2436

25-
export interface UseResizeObserverOptions extends ConfigurableWindow {
26-
/**
27-
* Sets which box model the observer will observe changes to. Possible values
28-
* are `content-box` (the default), `border-box` and `device-pixel-content-box`.
29-
*
30-
* @default 'content-box'
31-
*/
32-
box?: ResizeObserverBoxOptions
33-
}
34-
35-
declare class ResizeObserver {
36-
constructor(callback: ResizeObserverCallback)
37-
disconnect(): void
38-
observe(target: Element, options?: UseResizeObserverOptions): void
39-
unobserve(target: Element): void
37+
export interface UseResizeObserverOptions extends ResizeObserverOptions, ConfigurableWindow {
4038
}
4139

4240
/**
@@ -49,7 +47,7 @@ declare class ResizeObserver {
4947
*/
5048
export function useResizeObserver(
5149
target: MaybeComputedElementRef | MaybeComputedElementRef[] | MaybeRefOrGetter<MaybeElement[]>,
52-
callback: ResizeObserverCallback,
50+
callback: globalThis.ResizeObserverCallback,
5351
options: UseResizeObserverOptions = {},
5452
) {
5553
const { window = defaultWindow, ...observerOptions } = options

0 commit comments

Comments
 (0)