Skip to content

Upgrading @vueuse/core 4 to 5

Unknown4.11.2 → 5.3.0

Fetching 16 releases from GitHub…0 / 16
UnknownUpgrade verdict

DepDelta is still reading the notes for this range, so breaking changes can't be ruled out yet.

  • DepDelta is still reading the release notes in this range, so it can't rule out breaking changes yet.
  • This page updates as the notes come in.
Still reading release notes

DepDelta is still reading the release notes in this range. This updates as they come in.

1 package of its own release moves with it.

Generated by DepDelta from published .d.ts files. Not mixed with prose notes.

  • removed: const DefaultMagicKeysAliasMap: Readonly<Record<string, string>>
  • removed: const TransitionPresets: Record<string, CubicBezierPoints>
  • removed: const breakpointsAntDesign: { xs: number; sm: number; md: number; lg: number; xl: number; xxl: number }
  • removed: const breakpointsBootstrapV5: { sm: number; md: number; lg: number; xl: number; xxl: number }
  • removed: const breakpointsSematic: { mobileS: number; mobileM: number; mobileL: number; tablet: number; laptop: number; laptopL: number; desktop4K: number }
  • removed: const breakpointsTailwind: { sm: number; md: number; lg: number; xl: number; '2xl': number }
  • removed: const breakpointsVuetify: { xs: number; sm: number; md: number; lg: number }
  • removed: const useWebWorkerFn: <T extends (...fnArgs: any[]) => any>(fn: T, options?: WebWorkerOptions) => { workerFn: (...fnArgs: Parameters<T>) => Promise<ReturnType<T>>; workerStatus: vue…
  • removed: enum SwipeDirection
  • removed: export * from '@vueuse/shared'
  • removed: function asyncComputed<T>(evaluationCallback: (onCancel: AsyncComputedOnCancel) => T | Promise<T>, initialState?: T, optionsOrRef?: Ref<boolean> | AsyncComputedOptions): Ref<T>
  • removed: function autoResetRef<T>(defaultValue: T, afterMs?: MaybeRef<number>): Ref<T>
  • removed: function createFetch(config?: CreateFetchOptions): typeof useFetch
  • removed: function createGlobalState<T extends object>(stateFactory: () => T): () => T
  • removed: function onClickOutside<E extends keyof OnClickOutsideEvents = 'pointerdown'>(target: MaybeElementRef, handler: (evt: OnClickOutsideEvents[E]) => void, options?: OnClickOutsideOptions<E>): Fn | undefined
  • removed: function onKeyDown(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: Omit<KeyStrokeOptions, 'eventName'>): _vueuse_shared.Fn
  • removed: function onKeyPressed(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: Omit<KeyStrokeOptions, 'eventName'>): _vueuse_shared.Fn
  • removed: function onKeyStroke(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: KeyStrokeOptions): _vueuse_shared.Fn
  • removed: function onKeyUp(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: Omit<KeyStrokeOptions, 'eventName'>): _vueuse_shared.Fn
  • removed: function onStartTyping(callback: (event: KeyboardEvent) => void, options?: ConfigurableDocument): void
  • removed: function templateRef<T extends Element | null>(key: string, initialValue?: T | null): Readonly<Ref<T>>
  • removed: function toRefs<T extends object>(objectRef: MaybeRef<T>): ToRefs<T>
  • removed: function unrefElement(elRef: MaybeElementRef): any
  • removed: function useActiveElement<T extends HTMLElement>(options?: ConfigurableWindow): vue_demi.ComputedRef<T | null | undefined>
  • removed: function useAsyncState<T>(promise: Promise<T> | (() => Promise<T>), initialState: T, options?: AsyncStateOptions): { state: vue_demi.Ref<T>; isReady: vue_demi.Ref<boolean>; ready: vue_demi.Ref<boolean>; error: vue_demi.Ref<{ name: string; message: string; stack?: string | undefined } | undefined>; execute: (delay?: number) => Promise<void> }
  • removed: function useBattery({ navigator }?: ConfigurableNavigator): { isSupported: boolean | undefined; charging: vue_demi.Ref<boolean>; chargingTime: vue_demi.Ref<number>; dischargingTime: vue_demi.Ref<number>; level: vue_demi.Ref<number> }
  • removed: function useBreakpoints<K extends string>(breakpoints: Breakpoints<K>, options?: ConfigurableWindow): { greater(k: K): vue.Ref<boolean>; smaller(k: K): vue.Ref<boolean>; between(a: K, b: K): vue.Ref<boolean>; isGreater(k: K): boolean; isSmaller(k: K): boolean; isInBetween(a: K, b: K): boolean }
  • removed: function useBrowserLocation({ window }?: ConfigurableWindow): vue_demi.Ref<{ trigger: string; state?: any; length?: number | undefined; hash?: string | undefined; host?: string | undefined; hostname?: string | undefined; href?: string | undefined; origin?: string | undefined; pathname?: string | undefined; port?: string | undefined; protocol?: string | undefined; search?: string | undefined }>
  • removed: function useClipboard(options: ClipboardOptions<MaybeRef<string>>): ClipboardReturn<true>
  • removed: function useClipboard(options?: ClipboardOptions<undefined>): ClipboardReturn<false>
  • removed: function useCssVar(prop: string, target?: MaybeElementRef, { window }?: ConfigurableWindow): vue_demi.Ref<string>
  • removed: function useDark(options?: UseDarkOptions): vue_demi.WritableComputedRef<boolean>
  • removed: function useDeviceLight({ window }?: ConfigurableWindow): Ref<number | null>
  • removed: function useDeviceMotion(options?: DeviceMotionOptions): { acceleration: Ref<DeviceMotionEventAcceleration | null>; accelerationIncludingGravity: Ref<DeviceMotionEventAcceleration | null>; rotationRate: Ref<DeviceMotionEventRotationRate | null>; interval: Ref<number> }
  • removed: function useDeviceOrientation(options?: ConfigurableWindow): { isSupported: boolean; isAbsolute: Ref<boolean>; alpha: Ref<number | null>; beta: Ref<number | null>; gamma: Ref<number | null> }
  • removed: function useDevicePixelRatio({ window }?: ConfigurableWindow): { pixelRatio: vue_demi.Ref<number> }
  • removed: function useDevicesList(options?: UseDevicesListOptions): UseDevicesListReturn
  • removed: function useDocumentVisibility({ document }?: ConfigurableDocument): Ref<VisibilityState>
  • removed: function useElementBounding(target: MaybeElementRef, options?: ResizeObserverOptions): { x: vue_demi.Ref<number>; y: vue_demi.Ref<number>; top: vue_demi.Ref<number>; right: vue_demi.Ref<number>; bottom: vue_demi.Ref<number>; left: vue_demi.Ref<number>; width: vue_demi.Ref<number>; height: vue_demi.Ref<number> }
  • removed: function useElementSize(target: MaybeElementRef, initialSize?: ElementSize, options?: ResizeObserverOptions): { width: vue_demi.Ref<number>; height: vue_demi.Ref<number> }
  • removed: function useElementVisibility(element: Ref<Element | null | undefined>, { window, scrollTarget }?: VisibilityScrollTargetOptions): Ref<boolean>
  • removed: function useEventListener<E extends keyof DocumentEventMap>(target: Document, event: E, listener: (this: Document, ev: DocumentEventMap[E]) => any, options?: boolean | AddEventListenerOptions): Fn
  • removed: function useEventListener<E extends keyof WindowEventMap>(event: E, listener: (this: Window, ev: WindowEventMap[E]) => any, options?: boolean | AddEventListenerOptions): Fn
  • removed: function useEventListener<E extends keyof WindowEventMap>(target: Window, event: E, listener: (this: Window, ev: WindowEventMap[E]) => any, options?: boolean | AddEventListenerOptions): Fn
  • removed: function useEventListener<EventType = Event>(target: MaybeRef<EventTarget | null | undefined>, event: string, listener: GeneralEventListener<EventType>, options?: boolean | AddEventListenerOptions): Fn
  • removed: function useEventListener<Names extends string, EventType = Event>(target: InferEventTarget<Names>, event: Names, listener: GeneralEventListener<EventType>, options?: boolean | AddEventListenerOptions): Fn
  • removed: function useEventSource(url: string, events?: Array<string>): { eventSource: Ref<EventSource | null>; event: Ref<string | null>; data: Ref<string | null>; status: Ref<'OPEN' | 'CONNECTING' | 'CLOSED'>; error: Ref<Event | null>; close: () => void }
  • removed: function useFavicon(newIcon?: MaybeRef<string | null | undefined>, options?: FaviconOptions): vue_demi.Ref<string | null | undefined>
  • removed: function useFetch<T>(url: MaybeRef<string>): UseFetchReturn<T>
  • removed: function useFetch<T>(url: MaybeRef<string>, options: RequestInit, useFetchOptions?: UseFetchOptions): UseFetchReturn<T>
  • removed: function useFetch<T>(url: MaybeRef<string>, useFetchOptions: UseFetchOptions): UseFetchReturn<T>
  • removed: function useFullscreen(target?: MaybeElementRef, options?: ConfigurableDocument): { isSupported: boolean; isFullscreen: vue_demi.Ref<boolean>; enter: () => Promise<void>; exit: () => Promise<void>; toggle: () => Promise<void> }
  • removed: function useGeolocation(options?: GeolocationOptions): { isSupported: boolean | undefined; coords: Ref<GeolocationCoordinates>; locatedAt: Ref<number | null>; error: Ref<{ readonly code: number; readonly message: string; readonly PERMISSION_DENIED: number; readonly POSITION_UNAVAILABLE: number; readonly TIMEOUT: number } | null> }
  • removed: function useIdle(timeout?: number, options?: IdleOptions): { idle: vue_demi.Ref<boolean>; lastActive: vue_demi.Ref<number> }
  • removed: function useIntersectionObserver(target: MaybeElementRef, callback: IntersectionObserverCallback, options?: IntersectionObserverOptions): { isSupported: boolean | undefined; stop: () => void }
  • removed: function useLocalStorage(key: string, defaultValue: boolean, options?: StorageOptions<boolean>): Ref<boolean>
  • removed: function useLocalStorage(key: string, defaultValue: number, options?: StorageOptions<number>): Ref<number>
  • removed: function useLocalStorage(key: string, defaultValue: string, options?: StorageOptions<string>): Ref<string>
  • removed: function useLocalStorage<T = unknown>(key: string, defaultValue: null, options?: StorageOptions<T>): Ref<T>
  • removed: function useLocalStorage<T>(key: string, defaultValue: T, options?: StorageOptions<T>): Ref<T>
  • removed: function useMagicKeys(options: UseMagicKeysOptions<true>): MagicKeys<true>
  • removed: function useMagicKeys(options?: UseMagicKeysOptions<false>): MagicKeys<false>
  • removed: function useManualRefHistory<Raw, Serialized = Raw>(source: Ref<Raw>, options?: UseManualRefHistoryOptions<Raw, Serialized>): UseManualRefHistoryReturn<Raw, Serialized>
  • removed: function useMediaControls(target: MaybeRef<HTMLMediaElement | null | undefined>, options?: UseMediaControlsOptions): { currentTime: vue_demi.Ref<number>; duration: vue_demi.Ref<number>; buffering: vue_demi.Ref<boolean>; waiting: vue_demi.Ref<boolean>; seeking: vue_demi.Ref<boolean>; ended: vue_demi.Ref<boolean>; stalled: vue_demi.Ref<boolean>; buffered: vue_demi.Ref<[number, number][]>; playing:…
  • removed: function useMediaQuery(query: string, options?: ConfigurableWindow): vue_demi.Ref<boolean>
  • removed: function useMouse(options?: MouseOptions): { x: vue_demi.Ref<number>; y: vue_demi.Ref<number>; sourceType: vue_demi.Ref<MouseSourceType> }
  • removed: function useMouseInElement(target?: MaybeElementRef, options?: MouseInElementOptions): { x: vue_demi.Ref<number>; y: vue_demi.Ref<number>; sourceType: vue_demi.Ref<MouseSourceType>; elementX: vue_demi.Ref<number>; elementY: vue_demi.Ref<number>; elementPositionX: vue_demi.Ref<number>; elementPositionY: vue_demi.Ref<number>; elementHeight: vue_demi.Ref<number>; elementWidth: vue_demi.Ref<number>;…
  • removed: function useMousePressed(options?: MousePressedOptions): { pressed: vue_demi.Ref<boolean>; sourceType: vue_demi.Ref<MouseSourceType> }
  • removed: function useMutationObserver(target: MaybeElementRef, callback: MutationCallback, options?: MutationObserverOptions): { isSupported: boolean | undefined; stop: () => void }
  • removed: function useNetwork(options?: ConfigurableWindow): NetworkState
  • removed: function useNow(options?: UseNowOptions): { isActive: vue_demi.Ref<boolean>; pause: _vueuse_shared.Fn; resume: _vueuse_shared.Fn; now: vue_demi.Ref<{ toString: () => string; toDateString: () => string; toTimeString: () => string; toLocaleString: { (): string; (locales?: string | string[] | undefined, options?: Intl.DateTimeFormatOptions | undefined): string }; toLocaleDateString: { (): string; (l…
  • removed: function useOnline(options?: ConfigurableWindow): vue.Ref<boolean>
  • removed: function usePageLeave(options?: ConfigurableWindow): vue_demi.Ref<boolean>
  • removed: function useParallax(target: MaybeElementRef, options?: ParallaxOptions): ParallaxReturn
  • removed: function usePermission(permissionDesc: GeneralPermissionDescriptor | GeneralPermissionDescriptor['name'], options: UsePermissionOptions<true>): UsePermissionReturnWithControls
  • removed: function usePermission(permissionDesc: GeneralPermissionDescriptor | GeneralPermissionDescriptor['name'], options?: UsePermissionOptions<false>): UsePermissionReturn
  • removed: function usePointerSwipe(target: MaybeRef<Element | null | undefined>, options?: PointerSwipeOptions): PointerSwipeReturn
  • removed: function usePreferredColorScheme(options?: ConfigurableWindow): vue_demi.ComputedRef<ColorSchemeType>
  • removed: function usePreferredDark(options?: ConfigurableWindow): vue.Ref<boolean>
  • removed: function usePreferredLanguages(options?: ConfigurableWindow): Ref<readonly string[]>
  • removed: function useRafFn(fn: Fn, options?: RafFnOptions): RafFnReturn
  • removed: function useRefHistory<Raw, Serialized = Raw>(source: Ref<Raw>, options?: UseRefHistoryOptions<Raw, Serialized>): UseRefHistoryReturn<Raw, Serialized>
  • removed: function useResizeObserver(target: MaybeElementRef, callback: ResizeObserverCallback, options?: ResizeObserverOptions): { isSupported: boolean | undefined; stop: () => void }
  • removed: function useScriptTag(src: MaybeRef<string>, onLoaded?: (el: HTMLScriptElement) => void, options?: UseScriptTagOptions): { scriptTag: vue_demi.Ref<HTMLScriptElement | null>; load: (waitForScriptLoad?: boolean) => Promise<HTMLScriptElement | boolean>; unload: () => void }
  • removed: function useSessionStorage(key: string, defaultValue: boolean, options?: StorageOptions<boolean>): Ref<boolean>
  • removed: function useSessionStorage(key: string, defaultValue: number, options?: StorageOptions<number>): Ref<number>
  • removed: function useSessionStorage(key: string, defaultValue: string, options?: StorageOptions<string>): Ref<string>
  • removed: function useSessionStorage<T = unknown>(key: string, defaultValue: null, options?: StorageOptions<T>): Ref<T>
  • removed: function useSessionStorage<T>(key: string, defaultValue: T, options?: StorageOptions<T>): Ref<T>
  • removed: function useShare(shareOptions?: MaybeRef<ShareOptions>, options?: ConfigurableNavigator): { isSupported: boolean; share: (overrideOptions?: MaybeRef<ShareOptions>) => Promise<void> }
  • removed: function useSpeechRecognition(options?: SpeechRecognitionOptions): { isSupported: boolean; isListening: Ref<boolean>; isFinal: Ref<boolean>; recognition: SpeechRecognition | undefined; result: Ref<string>; error: Ref<SpeechRecognitionErrorEvent | undefined>; toggle: (value?: boolean) => void; start: () => void; stop: () => void }
  • removed: function useStorage(key: string, defaultValue: boolean, storage?: StorageLike, options?: StorageOptions<boolean>): Ref<boolean>
  • removed: function useStorage(key: string, defaultValue: number, storage?: StorageLike, options?: StorageOptions<number>): Ref<number>
  • removed: function useStorage(key: string, defaultValue: string, storage?: StorageLike, options?: StorageOptions<string>): Ref<string>
  • removed: function useStorage<T = unknown>(key: string, defaultValue: null, storage?: StorageLike, options?: StorageOptions<T>): Ref<T>
  • removed: function useStorage<T>(key: string, defaultValue: T, storage?: StorageLike, options?: StorageOptions<T>): Ref<T>
  • removed: function useSwipe(target: MaybeRef<EventTarget | null | undefined>, options?: SwipeOptions): { isPassiveEventSupported: boolean; isSwiping: vue_demi.Ref<boolean>; direction: ComputedRef<SwipeDirection>; coordsStart: { x: number; y: number }; coordsEnd: { x: number; y: number }; lengthX: ComputedRef<number>; lengthY: ComputedRef<number>; stop: () => void }
  • removed: function useTimeAgo(time: MaybeRef<Date | number | string>, options?: TimeAgoOptions): vue_demi.ComputedRef<string | undefined>
  • removed: function useTimestamp(options?: TimestampOptions): { isActive: vue_demi.Ref<boolean>; pause: _vueuse_shared.Fn; resume: _vueuse_shared.Fn; timestamp: vue_demi.Ref<number> }
  • removed: function useTitle(newTitle?: MaybeRef<string | null | undefined>, options?: UseTitleOptions): vue_demi.Ref<string | null | undefined>
  • removed: function useTransition(source: Ref<number>, options?: TransitionOptions): Ref<number>
  • removed: function useUrlSearchParams<T extends Record<string, any> = UrlParams>(mode?: 'history' | 'hash', options?: ConfigurableWindow): T
  • removed: function useUserMedia(options?: UseUserMediaOptions): { isSupported: boolean; stream: Ref<MediaStream | undefined>; start: () => Promise<MediaStream | undefined>; stop: () => void; restart: () => Promise<MediaStream | undefined>; videoDeviceId: Ref<string | false | undefined>; audioDeviceId: Ref<string | false | undefined>; enabled: Ref<boolean>; autoSwitch: Ref<boolean> }
  • removed: function useVModel<P extends object, K extends keyof P, Name extends string>(props: P, key?: K, emit?: (name: Name, ...args: any[]) => void, options?: VModelOptions): vue_demi.Ref<vue_demi.UnwrapRef<P[K]>> | vue_demi.WritableComputedRef<P[K]>
  • removed: function useVModels<P extends object, Name extends string>(props: P, emit?: (name: Name, ...args: any[]) => void, options?: VModelOptions): ToRefs<P>
  • removed: function useWebSocket<Data = any>(url: string, options?: WebSocketOptions): WebSocketResult<Data>
  • removed: function useWebWorker(url: string, workerOptions?: WorkerOptions, options?: ConfigurableWindow): { data: Ref<any>; post: { (message: any, transfer: Transferable[]): void; (message: any, options?: PostMessageOptions | undefined): void }; terminate: () => void; worker: Ref<Worker | undefined> }
  • removed: function useWindowScroll({ window }?: ConfigurableWindow): { x: vue_demi.Ref<number>; y: vue_demi.Ref<number> }
  • removed: function useWindowSize({ window, initialWidth, initialHeight }?: WindowSizeOptions): { width: vue_demi.Ref<number>; height: vue_demi.Ref<number> }
  • removed: interface AfterFetchContext<T = any>
  • removed: interface AsyncStateOptions
  • removed: interface BatteryManager extends EventTarget
  • removed: interface BeforeFetchContext
  • removed: interface BrowserLocationState
  • removed: interface ClipboardOptions<Source> extends ConfigurableNavigator
  • removed: interface ClipboardReturn<Optional>
  • removed: interface CreateFetchOptions
  • removed: interface ElementSize
  • removed: interface FaviconOptions extends ConfigurableDocument
  • removed: interface GeolocationOptions extends Partial<PositionOptions>, ConfigurableNavigator
  • removed: interface IdleOptions extends ConfigurableWindow, ConfigurableEventFilter
  • removed: interface IntersectionObserverOptions extends ConfigurableWindow
  • removed: interface MagicKeysInternal
  • removed: interface MouseInElementOptions extends MouseOptions
  • removed: interface MouseOptions extends ConfigurableWindow
  • removed: interface MousePressedOptions extends ConfigurableWindow
  • removed: interface MutationObserverOptions extends MutationObserverInit, ConfigurableWindow
  • removed: interface NetworkState
  • removed: interface OnClickOutsideOptions<E extends keyof OnClickOutsideEvents> extends ConfigurableWindow
  • removed: interface ParallaxOptions extends ConfigurableWindow
  • removed: interface ParallaxReturn
  • removed: interface PointerPosition
  • removed: interface PointerSwipeOptions
  • removed: interface PointerSwipeReturn
  • removed: interface RafFnOptions extends ConfigurableWindow
  • removed: interface RafFnReturn extends Pausable
  • removed: interface ResizeObserverEntry
  • removed: interface ResizeObserverOptions extends ConfigurableWindow
  • removed: interface ResizeObserverSize
  • removed: interface ShareOptions
  • removed: interface SpeechRecognitionOptions extends ConfigurableWindow
  • removed: interface StorageOptions<T> extends ConfigurableEventFilter, ConfigurableWindow, ConfigurableFlush
  • removed: interface SwipeOptions extends ConfigurableWindow
  • removed: interface SwipeReturn
  • removed: interface TimeAgoMessages
  • removed: interface TimeAgoOptions
  • removed: interface TimestampOptions
  • removed: interface UseDarkOptions extends StorageOptions<ColorSchemes>
  • removed: interface UseDevicesListOptions extends ConfigurableNavigator
  • removed: interface UseDevicesListReturn
  • removed: interface UseFetchOptions
  • removed: interface UseFetchReturn<T> extends UseFetchReturnMethodConfigured<T>
  • removed: interface UseMagicKeysOptions<Reactive extends Boolean>
  • removed: interface UseManualRefHistoryOptions<Raw, Serialized = Raw>
  • removed: interface UseManualRefHistoryReturn<Raw, Serialized>
  • removed: interface UseMediaSource
  • removed: interface UseMediaTextTrack
  • removed: interface UseMediaTextTrackSource
  • removed: interface UseNowOptions
  • removed: interface UsePermissionOptions<Controls extends boolean> extends ConfigurableNavigator
  • removed: interface UsePermissionReturnWithControls
  • removed: interface UseRefHistoryOptions<Raw, Serialized = Raw>
  • removed: interface UseRefHistoryRecord<T>
  • removed: interface UseRefHistoryReturn<Raw, Serialized>
  • removed: interface UseScriptTagOptions extends ConfigurableDocument
  • removed: interface UseTitleOptions extends ConfigurableDocument
  • removed: interface UseUserMediaOptions extends ConfigurableNavigator
  • removed: interface VModelOptions
  • removed: interface VisibilityScrollTargetOptions extends ConfigurableWindow
  • removed: interface WebSocketOptions
  • removed: interface WebSocketResult<T>
  • removed: interface WebWorkerOptions extends ConfigurableWindow
  • removed: interface WindowSizeOptions extends ConfigurableWindow
  • removed: member SwipeDirection.DOWN = 'DOWN'
  • removed: member SwipeDirection.LEFT = 'LEFT'
  • removed: member SwipeDirection.NONE = 'NONE'
  • removed: member SwipeDirection.RIGHT = 'RIGHT'
  • removed: member SwipeDirection.UP = 'UP'
  • removed: method UseFetchReturn.delete(payload?: unknown, type?: PayloadType): UseFetchReturnMethodConfigured<T>
  • removed: method UseFetchReturn.get(): UseFetchReturnMethodConfigured<T>
  • removed: method UseFetchReturn.post(payload?: unknown, type?: PayloadType): UseFetchReturnMethodConfigured<T>
  • removed: method UseFetchReturn.put(payload?: unknown, type?: PayloadType): UseFetchReturnMethodConfigured<T>
  • removed: method UseManualRefHistoryReturn.clear(): void
  • removed: method UseManualRefHistoryReturn.commit(): void
  • removed: method UseManualRefHistoryReturn.redo(): void
  • removed: method UseManualRefHistoryReturn.reset(): void
  • removed: method UseManualRefHistoryReturn.undo(): void
  • removed: method UseRefHistoryReturn.batch(fn: (cancel: Fn) => void): void
  • removed: method UseRefHistoryReturn.clear(): void
  • removed: method UseRefHistoryReturn.commit(): void
  • removed: method UseRefHistoryReturn.dispose(): void
  • removed: method UseRefHistoryReturn.pause(): void
  • removed: method UseRefHistoryReturn.redo(): void
  • removed: method UseRefHistoryReturn.reset(): void
  • removed: method UseRefHistoryReturn.resume(commit?: boolean): void
  • removed: method UseRefHistoryReturn.undo(): void
  • removed: property AfterFetchContext.data: T | null
  • removed: property AfterFetchContext.response: Response
  • removed: property AsyncStateOptions.delay?: number
  • removed: property AsyncStateOptions.immediate?: boolean
  • removed: property AsyncStateOptions.onError?: (e: Error) => void
  • removed: property AsyncStateOptions.resetOnExecute?: boolean
  • removed: property BatteryManager.charging: boolean
  • removed: property BatteryManager.chargingTime: number
  • removed: property BatteryManager.dischargingTime: number
  • removed: property BatteryManager.level: number
  • removed: property BeforeFetchContext.cancel: Fn
  • removed: property BeforeFetchContext.options: RequestInit
  • removed: property BeforeFetchContext.url: string
  • removed: property BrowserLocationState.hash?: string
  • removed: property BrowserLocationState.host?: string
  • removed: property BrowserLocationState.hostname?: string
  • removed: property BrowserLocationState.href?: string
  • removed: property BrowserLocationState.length?: number
  • removed: property BrowserLocationState.origin?: string
  • removed: property BrowserLocationState.pathname?: string
  • removed: property BrowserLocationState.port?: string
  • removed: property BrowserLocationState.protocol?: string
  • removed: property BrowserLocationState.search?: string
  • removed: property BrowserLocationState.state?: any
  • removed: property BrowserLocationState.trigger: string
  • removed: property ClipboardOptions.copiedDuring?: number
  • removed: property ClipboardOptions.read?: boolean
  • removed: property ClipboardOptions.source?: Source
  • removed: property ClipboardReturn.copied: ComputedRef<boolean>
  • removed: property ClipboardReturn.copy: Optional extends true ? (text?: string) => Promise<void> : (text: string) => Promise<void>
  • removed: property ClipboardReturn.isSupported: boolean
  • removed: property ClipboardReturn.text: ComputedRef<string>
  • removed: property CreateFetchOptions.baseUrl?: MaybeRef<string>
  • removed: property CreateFetchOptions.fetchOptions?: RequestInit
  • removed: property CreateFetchOptions.options?: UseFetchOptions
  • removed: property ElementSize.height: number
  • removed: property ElementSize.width: number
  • removed: property FaviconOptions.baseUrl?: string
  • removed: property FaviconOptions.rel?: string
  • removed: property IdleOptions.events?: WindowEventName[]
  • removed: property IdleOptions.initialState?: boolean
  • removed: property IdleOptions.listenForVisibilityChange?: boolean
  • removed: property IntersectionObserverOptions.root?: MaybeElementRef
  • removed: property IntersectionObserverOptions.rootMargin?: string
  • removed: property IntersectionObserverOptions.threshold?: number | number[]
  • removed: property MagicKeysInternal.current: Set<string>
  • removed: property MouseInElementOptions.handleOutside?: boolean
  • removed: property MouseOptions.initialValue?: { x: number; y: number }
  • removed: property MouseOptions.resetOnTouchEnds?: boolean
  • removed: property MouseOptions.touch?: boolean
  • removed: property MousePressedOptions.initialValue?: boolean
  • removed: property MousePressedOptions.target?: MaybeElementRef
  • removed: property MousePressedOptions.touch?: boolean
  • removed: property NetworkState.downlink: Ref<number | undefined>
  • removed: property NetworkState.downlinkMax: Ref<number | undefined>
  • removed: property NetworkState.effectiveType: Ref<NetworkEffectiveType | undefined>
  • removed: property NetworkState.isOnline: Ref<boolean>
  • removed: property NetworkState.isSupported: boolean
  • removed: property NetworkState.offlineAt: Ref<number | undefined>
  • removed: property NetworkState.saveData: Ref<boolean | undefined>
  • removed: property NetworkState.type: Ref<NetworkType>
  • removed: property OnClickOutsideOptions.event?: E
  • removed: property ParallaxOptions.deviceOrientationRollAdjust?: (i: number) => number
  • removed: property ParallaxOptions.deviceOrientationTiltAdjust?: (i: number) => number
  • removed: property ParallaxOptions.mouseRollAdjust?: (i: number) => number
  • removed: property ParallaxOptions.mouseTiltAdjust?: (i: number) => number
  • removed: property ParallaxReturn.roll: ComputedRef<number>
  • removed: property ParallaxReturn.source: ComputedRef<'deviceOrientation' | 'mouse'>
  • removed: property ParallaxReturn.tilt: ComputedRef<number>
  • removed: property PointerPosition.x: number
  • removed: property PointerPosition.y: number
  • removed: property PointerSwipeOptions.onSwipe?: (e: PointerEvent) => void
  • removed: property PointerSwipeOptions.onSwipeEnd?: (e: PointerEvent, direction: SwipeDirection) => void
  • removed: property PointerSwipeOptions.onSwipeStart?: (e: PointerEvent) => void
  • removed: property PointerSwipeOptions.threshold?: number
  • removed: property PointerSwipeReturn.direction: ComputedRef<SwipeDirection | null>
  • removed: property PointerSwipeReturn.distanceX: ComputedRef<number>
  • removed: property PointerSwipeReturn.distanceY: ComputedRef<number>
  • removed: property PointerSwipeReturn.stop: () => void
  • removed: property RafFnOptions.immediate?: boolean
  • removed: property RafFnReturn.start: Fn
  • removed: property RafFnReturn.stop: Fn
  • removed: property ResizeObserverOptions.box?: 'content-box' | 'border-box'
  • removed: property ShareOptions.files?: File[]
  • removed: property ShareOptions.text?: string
  • removed: property ShareOptions.title?: string
  • removed: property ShareOptions.url?: string
  • removed: property SpeechRecognitionOptions.continuous?: boolean
  • removed: property SpeechRecognitionOptions.interimResults?: boolean
  • removed: property SpeechRecognitionOptions.lang?: string
  • removed: property StorageOptions.deep?: boolean
  • removed: property StorageOptions.listenToStorageChanges?: boolean
  • removed: property StorageOptions.serializer?: Serializer<T>
  • removed: property SwipeOptions.onSwipe?: (e: TouchEvent) => void
  • removed: property SwipeOptions.onSwipeEnd?: (e: TouchEvent, direction: SwipeDirection) => void
  • removed: property SwipeOptions.onSwipeStart?: (e: TouchEvent) => void
  • removed: property SwipeOptions.passive?: boolean
  • removed: property SwipeOptions.threshold?: number
  • removed: property SwipeReturn.coordsEnd: { readonly x: number; readonly y: number }
  • removed: property SwipeReturn.coordsStart: { readonly x: number; readonly y: number }
  • removed: property SwipeReturn.direction: ComputedRef<SwipeDirection | null>
  • removed: property SwipeReturn.isPassiveEventSupported: boolean
  • removed: property SwipeReturn.isSwiping: ComputedRef<boolean>
  • removed: property SwipeReturn.lengthX: ComputedRef<number>
  • removed: property SwipeReturn.lengthY: ComputedRef<number>
  • removed: property SwipeReturn.stop: () => void
  • removed: property TimeAgoMessages.day: string | MessageFormatter<number>
  • removed: property TimeAgoMessages.future: string | MessageFormatter<string>
  • removed: property TimeAgoMessages.hour: string | MessageFormatter<number>
  • removed: property TimeAgoMessages.justNow: string
  • removed: property TimeAgoMessages.minute: string | MessageFormatter<number>
  • removed: property TimeAgoMessages.month: string | MessageFormatter<number>
  • removed: property TimeAgoMessages.past: string | MessageFormatter<string>
  • removed: property TimeAgoMessages.second: string | MessageFormatter<number>
  • removed: property TimeAgoMessages.week: string | MessageFormatter<number>
  • removed: property TimeAgoMessages.year: string | MessageFormatter<number>
  • removed: property TimeAgoOptions.fullDateFormatter?: (date: Date) => string
  • removed: property TimeAgoOptions.max?: 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year' | number
  • removed: property TimeAgoOptions.messages?: TimeAgoMessages
  • removed: property TimeAgoOptions.updateInterval?: number
  • removed: property TimestampOptions.interval?: 'requestAnimationFrame' | number
  • removed: property TimestampOptions.offset?: number
  • removed: property UseDarkOptions.attribute?: string
  • removed: property UseDarkOptions.onChanged?: (isDark: boolean) => void
  • removed: property UseDarkOptions.selector?: string
  • removed: property UseDarkOptions.storage?: StorageLike
  • removed: property UseDarkOptions.storageKey?: string | null
  • removed: property UseDarkOptions.valueDark?: string
  • removed: property UseDarkOptions.valueLight?: string
  • removed: property UseDevicesListOptions.onUpdated?: (devices: MediaDeviceInfo[]) => void
  • removed: property UseDevicesListOptions.requestPermissions?: boolean
  • removed: property UseDevicesListReturn.audioInputs: ComputedRef<MediaDeviceInfo[]>
  • removed: property UseDevicesListReturn.audioOutputs: ComputedRef<MediaDeviceInfo[]>
  • removed: property UseDevicesListReturn.devices: Ref<MediaDeviceInfo[]>
  • removed: property UseDevicesListReturn.ensurePermissions: () => Promise<boolean>
  • removed: property UseDevicesListReturn.isSupported: boolean
  • removed: property UseDevicesListReturn.permissionGranted: Ref<boolean>
  • removed: property UseDevicesListReturn.videoInputs: ComputedRef<MediaDeviceInfo[]>
  • removed: property UseFetchOptions.afterFetch?: (ctx: AfterFetchContext) => Promise<Partial<AfterFetchContext>> | Partial<AfterFetchContext>
  • removed: property UseFetchOptions.beforeFetch?: (ctx: BeforeFetchContext) => Promise<Partial<BeforeFetchContext> | void> | Partial<BeforeFetchContext> | void
  • removed: property UseFetchOptions.fetch?: typeof window.fetch
  • removed: property UseFetchOptions.immediate?: boolean
  • removed: property UseFetchOptions.refetch?: MaybeRef<boolean>
  • removed: property UseMagicKeysOptions.aliasMap?: Record<string, string>
  • removed: property UseMagicKeysOptions.onEventFired?: (e: KeyboardEvent) => void | boolean
  • removed: property UseMagicKeysOptions.passive?: boolean
  • removed: property UseMagicKeysOptions.reactive?: Reactive
  • removed: property UseMagicKeysOptions.target?: MaybeRef<EventTarget>
  • removed: property UseManualRefHistoryOptions.capacity?: number
  • removed: property UseManualRefHistoryOptions.clone?: boolean | CloneFn<Raw>
  • removed: property UseManualRefHistoryOptions.dump?: (v: Raw) => Serialized
  • removed: property UseManualRefHistoryOptions.parse?: (v: Serialized) => Raw
  • removed: property UseManualRefHistoryOptions.setSource?: (source: Ref<Raw>, v: Raw) => void
  • removed: property UseManualRefHistoryReturn.canRedo: Ref<boolean>
  • removed: property UseManualRefHistoryReturn.canUndo: Ref<boolean>
  • removed: property UseManualRefHistoryReturn.history: Ref<UseRefHistoryRecord<Serialized>[]>
  • removed: property UseManualRefHistoryReturn.last: Ref<UseRefHistoryRecord<Serialized>>
  • removed: property UseManualRefHistoryReturn.redoStack: Ref<UseRefHistoryRecord<Serialized>[]>
  • removed: property UseManualRefHistoryReturn.source: Ref<Raw>
  • removed: property UseManualRefHistoryReturn.undoStack: Ref<UseRefHistoryRecord<Serialized>[]>
  • removed: property UseMediaSource.src: string
  • removed: property UseMediaSource.type?: string
  • removed: property UseMediaTextTrack.activeCues: TextTrackCueList | null
  • removed: property UseMediaTextTrack.cues: TextTrackCueList | null
  • removed: property UseMediaTextTrack.id: number
  • removed: property UseMediaTextTrack.inBandMetadataTrackDispatchType: string
  • removed: property UseMediaTextTrack.kind: TextTrackKind
  • removed: property UseMediaTextTrack.label: string
  • removed: property UseMediaTextTrack.language: string
  • removed: property UseMediaTextTrack.mode: TextTrackMode
  • removed: property UseMediaTextTrackSource.default?: boolean
  • removed: property UseMediaTextTrackSource.kind: TextTrackKind
  • removed: property UseMediaTextTrackSource.label: string
  • removed: property UseMediaTextTrackSource.src: string
  • removed: property UseMediaTextTrackSource.srcLang: string
  • removed: property UseNowOptions.interval?: 'requestAnimationFrame' | number
  • removed: property UsePermissionOptions.controls?: Controls
  • removed: property UsePermissionReturnWithControls.isSupported: boolean
  • removed: property UsePermissionReturnWithControls.query: () => Promise<PermissionStatus | undefined>
  • removed: property UsePermissionReturnWithControls.state: UsePermissionReturn
  • removed: property UseRefHistoryOptions.capacity?: number
  • removed: property UseRefHistoryOptions.clone?: boolean | CloneFn<Raw>
  • removed: property UseRefHistoryOptions.deep?: boolean
  • removed: property UseRefHistoryOptions.dump?: (v: Raw) => Serialized
  • removed: property UseRefHistoryOptions.flush?: 'pre' | 'post' | 'sync'
  • removed: property UseRefHistoryOptions.parse?: (v: Serialized) => Raw
  • removed: property UseRefHistoryRecord.snapshot: T
  • removed: property UseRefHistoryRecord.timestamp: number
  • removed: property UseRefHistoryReturn.canRedo: Ref<boolean>
  • removed: property UseRefHistoryReturn.canUndo: Ref<boolean>
  • removed: property UseRefHistoryReturn.history: Ref<UseRefHistoryRecord<Serialized>[]>
  • removed: property UseRefHistoryReturn.isTracking: Ref<boolean>
  • removed: property UseRefHistoryReturn.last: Ref<UseRefHistoryRecord<Serialized>>
  • removed: property UseRefHistoryReturn.redoStack: Ref<UseRefHistoryRecord<Serialized>[]>
  • removed: property UseRefHistoryReturn.source: Ref<Raw>
  • removed: property UseRefHistoryReturn.undoStack: Ref<UseRefHistoryRecord<Serialized>[]>
  • removed: property UseScriptTagOptions.async?: boolean
  • removed: property UseScriptTagOptions.crossOrigin?: 'anonymous' | 'use-credentials'
  • removed: property UseScriptTagOptions.defer?: boolean
  • removed: property UseScriptTagOptions.immediate?: boolean
  • removed: property UseScriptTagOptions.manual?: boolean
  • removed: property UseScriptTagOptions.noModule?: boolean
  • removed: property UseScriptTagOptions.referrerPolicy?: 'no-referrer' | 'no-referrer-when-downgrade' | 'origin' | 'origin-when-cross-origin' | 'same-origin' | 'strict-origin' | 'strict-origin-when-cross-origin' | 'unsafe-url'
  • removed: property UseScriptTagOptions.type?: string
  • removed: property UseTitleOptions.observe?: boolean
  • removed: property UseUserMediaOptions.audioDeviceId?: MaybeRef<string | undefined | false | 'none'>
  • removed: property UseUserMediaOptions.autoSwitch?: MaybeRef<boolean>
  • removed: property UseUserMediaOptions.enabled?: MaybeRef<boolean>
  • removed: property UseUserMediaOptions.videoDeviceId?: MaybeRef<string | undefined | false | 'none'>
  • removed: property VModelOptions.eventName?: string
  • removed: property VModelOptions.passive?: boolean
  • removed: property VisibilityScrollTargetOptions.scrollTarget?: Ref<Element | null | undefined>
  • removed: property WebSocketOptions.autoReconnect?: boolean | { retries?: number; delay?: number; onFailed?: Fn }
  • removed: property WebSocketOptions.heartbeat?: boolean | { message?: string; interval?: number }
  • removed: property WebSocketOptions.immediate?: boolean
  • removed: property WebSocketOptions.onConnected?: (ws: WebSocket) => void
  • removed: property WebSocketOptions.onDisconnected?: (ws: WebSocket, event: CloseEvent) => void
  • removed: property WebSocketOptions.onError?: (ws: WebSocket, event: Event) => void
  • removed: property WebSocketOptions.onMessage?: (ws: WebSocket, event: MessageEvent) => void
  • removed: property WebSocketResult.close: WebSocket['close']
  • removed: property WebSocketResult.data: Ref<T | null>
  • removed: property WebSocketResult.open: Fn
  • removed: property WebSocketResult.send: (data: string | ArrayBuffer | Blob, useBuffer?: boolean) => boolean
  • removed: property WebSocketResult.status: Ref<WebSocketStatus>
  • removed: property WebSocketResult.ws: Ref<WebSocket | undefined>
  • removed: property WebWorkerOptions.dependencies?: string[]
  • removed: property WebWorkerOptions.timeout?: number
  • removed: property WindowSizeOptions.initialHeight?: number
  • removed: property WindowSizeOptions.initialWidth?: number
  • removed: readonly property PointerSwipeReturn.isSwiping: Ref<boolean>
  • removed: readonly property PointerSwipeReturn.posEnd: PointerPosition
  • removed: readonly property PointerSwipeReturn.posStart: PointerPosition
  • removed: readonly property ResizeObserverEntry.borderBoxSize?: ReadonlyArray<ResizeObserverSize>
  • removed: readonly property ResizeObserverEntry.contentBoxSize?: ReadonlyArray<ResizeObserverSize>
  • removed: readonly property ResizeObserverEntry.contentRect: DOMRectReadOnly
  • removed: readonly property ResizeObserverEntry.devicePixelContentBoxSize?: ReadonlyArray<ResizeObserverSize>
  • removed: readonly property ResizeObserverEntry.target: Element
  • removed: readonly property ResizeObserverSize.blockSize: number
  • removed: readonly property ResizeObserverSize.inlineSize: number
  • removed: type AsyncComputedOnCancel = (cancelCallback: Fn) => void
  • removed: type AsyncComputedOptions = { lazy?: Boolean; evaluating?: Ref<boolean> }
  • removed: type Breakpoints<K extends string = string> = Record<K, number | string>
  • removed: type CloneFn<F, T = F> = (x: F) => T
  • removed: type ColorSchemeType = 'dark' | 'light' | 'no-preference'
  • removed: type ColorSchemes = 'light' | 'dark' | 'auto'
  • removed: type DocumentEventName = keyof DocumentEventMap
  • removed: type GeneralEventListener<E = Event> = { (evt: E): void }
  • removed: type GeneralPermissionDescriptor = PermissionDescriptor | DevicePermissionDescriptor | MidiPermissionDescriptor | PushPermissionDescriptor | { name: DescriptorNamePolyfill }
  • removed: type KeyFilter = null | undefined | string | KeyPredicate
  • removed: type KeyPredicate = (event: KeyboardEvent) => boolean
  • removed: type KeyStrokeEventName = 'keydown' | 'keypress' | 'keyup'
  • removed: type KeyStrokeOptions = { eventName?: KeyStrokeEventName; target?: MaybeRef<EventTarget>; passive?: boolean }
  • removed: type MagicKeys<Reactive extends Boolean> = Readonly<Omit<Reactive extends true ? Record<string, boolean> : Record<string, ComputedRef<boolean>>, keyof MagicKeysInternal> & MagicKeysInternal>
  • removed: type MaybeElementRef = MaybeRef<Element | VueInstance | undefined | null>
  • removed: type MessageFormatter<T = number> = (value: T, isPast: boolean) => string
  • removed: type MouseSourceType = 'mouse' | 'touch' | null
  • removed: type NetworkEffectiveType = 'slow-2g' | '2g' | '3g' | '4g' | undefined
  • removed: type NetworkType = 'bluetooth' | 'cellular' | 'ethernet' | 'none' | 'wifi' | 'wimax' | 'other' | 'unknown'
  • removed: type OnClickOutsideEvents = Pick<WindowEventMap, 'mousedown' | 'mouseup' | 'touchstart' | 'touchend' | 'pointerdown' | 'pointerup'>
  • removed: type ResizeObserverCallback = (entries: ReadonlyArray<ResizeObserverEntry>, observer: ResizeObserver) => void
  • removed: type Serializer<T> = { read(raw: string): T; write(value: T): string }
  • removed: type StorageLike = Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>
  • removed: type UrlParams = Record<string, string[] | string>
  • removed: type UsePermissionReturn = Readonly<Ref<PermissionState | undefined>>
  • removed: type VueInstance = InstanceType<ReturnType<typeof defineComponent>>
  • removed: type WebSocketStatus = 'OPEN' | 'CONNECTING' | 'CLOSED'
  • removed: type WebWorkerStatus = 'PENDING' | 'SUCCESS' | 'RUNNING' | 'ERROR' | 'TIMEOUT_EXPIRED'
  • removed: type WindowEventName = keyof WindowEventMap
  • added: const DefaultMagicKeysAliasMap: Readonly<Record<string, string>>
  • added: const StorageSerializers: Record<'boolean' | 'object' | 'number' | 'any' | 'string', Serializer<any>>
  • added: const TransitionPresets: Record<string, CubicBezierPoints | EasingFunction>
  • added: const breakpointsAntDesign: { xs: number; sm: number; md: number; lg: number; xl: number; xxl: number }
  • added: const breakpointsBootstrapV5: { sm: number; md: number; lg: number; xl: number; xxl: number }
  • added: const breakpointsSematic: { mobileS: number; mobileM: number; mobileL: number; tablet: number; laptop: number; laptopL: number; desktop4K: number }
  • added: const breakpointsTailwind: { sm: number; md: number; lg: number; xl: number; '2xl': number }
  • added: const breakpointsVuetify: { xs: number; sm: number; md: number; lg: number }
  • added: const useWebWorkerFn: <T extends (...fnArgs: any[]) => any>(fn: T, options?: WebWorkerOptions) => { workerFn: (...fnArgs: Parameters<T>) => Promise<ReturnType<T>>; workerStatus: vue…
  • added: enum SwipeDirection
  • added: export * from '@vueuse/shared'
  • added: function asyncComputed<T>(evaluationCallback: (onCancel: AsyncComputedOnCancel) => T | Promise<T>, initialState?: T, optionsOrRef?: Ref<boolean> | AsyncComputedOptions): Ref<T>
  • added: function autoResetRef<T>(defaultValue: T, afterMs?: MaybeRef<number>): Ref<T>
  • added: function computedInject<T, K = any>(key: InjectionKey<T> | string, getter: ComputedInjectGetter<T, K>): ComputedRef<K | undefined>
  • added: function computedInject<T, K = any>(key: InjectionKey<T> | string, getter: ComputedInjectGetterWithDefault<T, K>, defaultSource: T, treatDefaultAsFactory?: false): ComputedRef<K>
  • added: function computedInject<T, K = any>(key: InjectionKey<T> | string, options: WritableComputedInjectOptions<T, K>): ComputedRef<K | undefined>
  • added: function computedInject<T, K = any>(key: InjectionKey<T> | string, options: WritableComputedInjectOptionsWithDefault<T, K>, defaultSource: T | (() => T), treatDefaultAsFactory: true): ComputedRef<K>
  • added: function createFetch(config?: CreateFetchOptions): typeof useFetch
  • added: function createGlobalState<T extends object>(stateFactory: () => T): () => T
  • added: function onClickOutside<E extends keyof OnClickOutsideEvents = 'pointerdown'>(target: MaybeElementRef, handler: (evt: OnClickOutsideEvents[E]) => void, options?: OnClickOutsideOptions<E>): Fn | undefined
  • added: function onKeyDown(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: Omit<KeyStrokeOptions, 'eventName'>): _vueuse_shared.Fn
  • added: function onKeyPressed(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: Omit<KeyStrokeOptions, 'eventName'>): _vueuse_shared.Fn
  • added: function onKeyStroke(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: KeyStrokeOptions): _vueuse_shared.Fn
  • added: function onKeyUp(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: Omit<KeyStrokeOptions, 'eventName'>): _vueuse_shared.Fn
  • added: function onStartTyping(callback: (event: KeyboardEvent) => void, options?: ConfigurableDocument): void
  • added: function templateRef<T extends Element | null>(key: string, initialValue?: T | null): Readonly<Ref<T>>
  • added: function toRefs<T extends object>(objectRef: MaybeRef<T>): ToRefs<T>
  • added: function unrefElement(elRef: MaybeElementRef): any
  • added: function useActiveElement<T extends HTMLElement>(options?: ConfigurableWindow): vue_demi.ComputedRef<T | null | undefined>
  • added: function useAsyncState<T>(promise: Promise<T> | (() => Promise<T>), initialState: T, options?: AsyncStateOptions): { state: vue_demi.Ref<T>; isReady: vue_demi.Ref<boolean>; error: vue_demi.Ref<{ name: string; message: string; stack?: string | undefined } | undefined>; execute: (delay?: number) => Promise<void> }
  • added: function useBattery({ navigator }?: ConfigurableNavigator): { isSupported: boolean | undefined; charging: vue_demi.Ref<boolean>; chargingTime: vue_demi.Ref<number>; dischargingTime: vue_demi.Ref<number>; level: vue_demi.Ref<number> }
  • added: function useBreakpoints<K extends string>(breakpoints: Breakpoints<K>, options?: ConfigurableWindow): { greater(k: K): vue.Ref<boolean>; smaller(k: K): vue.Ref<boolean>; between(a: K, b: K): vue.Ref<boolean>; isGreater(k: K): boolean; isSmaller(k: K): boolean; isInBetween(a: K, b: K): boolean }
  • added: function useBrowserLocation({ window }?: ConfigurableWindow): vue_demi.Ref<{ trigger: string; state?: any; length?: number | undefined; hash?: string | undefined; host?: string | undefined; hostname?: string | undefined; href?: string | undefined; origin?: string | undefined; pathname?: string | undefined; port?: string | undefined; protocol?: string | undefined; search?: string | undefined }>
  • added: function useClipboard(options: ClipboardOptions<MaybeRef<string>>): ClipboardReturn<true>
  • added: function useClipboard(options?: ClipboardOptions<undefined>): ClipboardReturn<false>
  • added: function useCssVar(prop: string, target?: MaybeElementRef, { window }?: ConfigurableWindow): vue_demi.Ref<string>
  • added: function useDark(options?: UseDarkOptions): vue_demi.WritableComputedRef<boolean>
  • added: function useDeviceMotion(options?: DeviceMotionOptions): { acceleration: Ref<DeviceMotionEventAcceleration | null>; accelerationIncludingGravity: Ref<DeviceMotionEventAcceleration | null>; rotationRate: Ref<DeviceMotionEventRotationRate | null>; interval: Ref<number> }
  • added: function useDeviceOrientation(options?: ConfigurableWindow): { isSupported: boolean; isAbsolute: Ref<boolean>; alpha: Ref<number | null>; beta: Ref<number | null>; gamma: Ref<number | null> }
  • added: function useDevicePixelRatio({ window }?: ConfigurableWindow): { pixelRatio: vue_demi.Ref<number> }
  • added: function useDevicesList(options?: UseDevicesListOptions): UseDevicesListReturn
  • added: function useDocumentVisibility({ document }?: ConfigurableDocument): Ref<VisibilityState>
  • added: function useElementBounding(target: MaybeElementRef, options?: ResizeObserverOptions): { x: vue_demi.Ref<number>; y: vue_demi.Ref<number>; top: vue_demi.Ref<number>; right: vue_demi.Ref<number>; bottom: vue_demi.Ref<number>; left: vue_demi.Ref<number>; width: vue_demi.Ref<number>; height: vue_demi.Ref<number> }
  • added: function useElementSize(target: MaybeElementRef, initialSize?: ElementSize, options?: ResizeObserverOptions): { width: vue_demi.Ref<number>; height: vue_demi.Ref<number> }
  • added: function useElementVisibility(element: Ref<Element | null | undefined>, { window, scrollTarget }?: VisibilityScrollTargetOptions): Ref<boolean>
  • added: function useEventListener<E extends keyof DocumentEventMap>(target: Document, event: E, listener: (this: Document, ev: DocumentEventMap[E]) => any, options?: boolean | AddEventListenerOptions): Fn
  • added: function useEventListener<E extends keyof WindowEventMap>(event: E, listener: (this: Window, ev: WindowEventMap[E]) => any, options?: boolean | AddEventListenerOptions): Fn
  • added: function useEventListener<E extends keyof WindowEventMap>(target: Window, event: E, listener: (this: Window, ev: WindowEventMap[E]) => any, options?: boolean | AddEventListenerOptions): Fn
  • added: function useEventListener<EventType = Event>(target: MaybeRef<EventTarget | null | undefined>, event: string, listener: GeneralEventListener<EventType>, options?: boolean | AddEventListenerOptions): Fn
  • added: function useEventListener<Names extends string, EventType = Event>(target: InferEventTarget<Names>, event: Names, listener: GeneralEventListener<EventType>, options?: boolean | AddEventListenerOptions): Fn
  • added: function useEventSource(url: string, events?: Array<string>): { eventSource: Ref<EventSource | null>; event: Ref<string | null>; data: Ref<string | null>; status: Ref<'OPEN' | 'CONNECTING' | 'CLOSED'>; error: Ref<Event | null>; close: () => void }
  • added: function useFavicon(newIcon?: MaybeRef<string | null | undefined>, options?: FaviconOptions): vue_demi.Ref<string | null | undefined>
  • added: function useFetch<T>(url: MaybeRef<string>): UseFetchReturn<T>
  • added: function useFetch<T>(url: MaybeRef<string>, options: RequestInit, useFetchOptions?: UseFetchOptions): UseFetchReturn<T>
  • added: function useFetch<T>(url: MaybeRef<string>, useFetchOptions: UseFetchOptions): UseFetchReturn<T>
  • added: function useFullscreen(target?: MaybeElementRef, options?: ConfigurableDocument): { isSupported: boolean; isFullscreen: vue_demi.Ref<boolean>; enter: () => Promise<void>; exit: () => Promise<void>; toggle: () => Promise<void> }
  • added: function useGeolocation(options?: GeolocationOptions): { isSupported: boolean | undefined; coords: Ref<GeolocationCoordinates>; locatedAt: Ref<number | null>; error: Ref<{ readonly code: number; readonly message: string; readonly PERMISSION_DENIED: number; readonly POSITION_UNAVAILABLE: number; readonly TIMEOUT: number } | null> }
  • added: function useIdle(timeout?: number, options?: IdleOptions): UseIdleReturn
  • added: function useIntersectionObserver(target: MaybeElementRef, callback: IntersectionObserverCallback, options?: IntersectionObserverOptions): { isSupported: boolean | undefined; stop: () => void }
  • added: function useLocalStorage(key: string, defaultValue: boolean, options?: StorageOptions<boolean>): Ref<boolean>
  • added: function useLocalStorage(key: string, defaultValue: number, options?: StorageOptions<number>): Ref<number>
  • added: function useLocalStorage(key: string, defaultValue: string, options?: StorageOptions<string>): Ref<string>
  • added: function useLocalStorage<T = unknown>(key: string, defaultValue: null, options?: StorageOptions<T>): Ref<T>
  • added: function useLocalStorage<T>(key: string, defaultValue: T, options?: StorageOptions<T>): Ref<T>
  • added: function useMagicKeys(options: UseMagicKeysOptions<true>): MagicKeys<true>
  • added: function useMagicKeys(options?: UseMagicKeysOptions<false>): MagicKeys<false>
  • added: function useManualRefHistory<Raw, Serialized = Raw>(source: Ref<Raw>, options?: UseManualRefHistoryOptions<Raw, Serialized>): UseManualRefHistoryReturn<Raw, Serialized>
  • added: function useMediaControls(target: MaybeRef<HTMLMediaElement | null | undefined>, options?: UseMediaControlsOptions): { currentTime: vue_demi.Ref<number>; duration: vue_demi.Ref<number>; buffering: vue_demi.Ref<boolean>; waiting: vue_demi.Ref<boolean>; seeking: vue_demi.Ref<boolean>; ended: vue_demi.Ref<boolean>; stalled: vue_demi.Ref<boolean>; buffered: vue_demi.Ref<[number, number][]>; playing:…
  • added: function useMediaQuery(query: string, options?: ConfigurableWindow): vue_demi.Ref<boolean>
  • added: function useMouse(options?: MouseOptions): { x: vue_demi.Ref<number>; y: vue_demi.Ref<number>; sourceType: vue_demi.Ref<MouseSourceType> }
  • added: function useMouseInElement(target?: MaybeElementRef, options?: MouseInElementOptions): { x: vue_demi.Ref<number>; y: vue_demi.Ref<number>; sourceType: vue_demi.Ref<MouseSourceType>; elementX: vue_demi.Ref<number>; elementY: vue_demi.Ref<number>; elementPositionX: vue_demi.Ref<number>; elementPositionY: vue_demi.Ref<number>; elementHeight: vue_demi.Ref<number>; elementWidth: vue_demi.Ref<number>;…
  • added: function useMousePressed(options?: MousePressedOptions): { pressed: vue_demi.Ref<boolean>; sourceType: vue_demi.Ref<MouseSourceType> }
  • added: function useMutationObserver(target: MaybeElementRef, callback: MutationCallback, options?: MutationObserverOptions): { isSupported: boolean | undefined; stop: () => void }
  • added: function useNetwork(options?: ConfigurableWindow): Readonly<NetworkState>
  • added: function useNow(options: UseNowOptions<true>): { now: Ref<Date> } & Pausable
  • added: function useNow(options?: UseNowOptions<false>): Ref<Date>
  • added: function useOnline(options?: ConfigurableWindow): vue.Ref<boolean>
  • added: function usePageLeave(options?: ConfigurableWindow): vue_demi.Ref<boolean>
  • added: function useParallax(target: MaybeElementRef, options?: ParallaxOptions): ParallaxReturn
  • added: function usePermission(permissionDesc: GeneralPermissionDescriptor | GeneralPermissionDescriptor['name'], options: UsePermissionOptions<true>): UsePermissionReturnWithControls
  • added: function usePermission(permissionDesc: GeneralPermissionDescriptor | GeneralPermissionDescriptor['name'], options?: UsePermissionOptions<false>): UsePermissionReturn
  • added: function usePointerSwipe(target: MaybeRef<HTMLElement | null | undefined>, options?: PointerSwipeOptions): PointerSwipeReturn
  • added: function usePreferredColorScheme(options?: ConfigurableWindow): vue_demi.ComputedRef<ColorSchemeType>
  • added: function usePreferredDark(options?: ConfigurableWindow): vue.Ref<boolean>
  • added: function usePreferredLanguages(options?: ConfigurableWindow): Ref<readonly string[]>
  • added: function useRafFn(fn: Fn, options?: RafFnOptions): Pausable
  • added: function useRefHistory<Raw, Serialized = Raw>(source: Ref<Raw>, options?: UseRefHistoryOptions<Raw, Serialized>): UseRefHistoryReturn<Raw, Serialized>
  • added: function useResizeObserver(target: MaybeElementRef, callback: ResizeObserverCallback, options?: ResizeObserverOptions): { isSupported: boolean | undefined; stop: () => void }
  • added: function useScriptTag(src: MaybeRef<string>, onLoaded?: (el: HTMLScriptElement) => void, options?: UseScriptTagOptions): { scriptTag: vue_demi.Ref<HTMLScriptElement | null>; load: (waitForScriptLoad?: boolean) => Promise<HTMLScriptElement | boolean>; unload: () => void }
  • added: function useSessionStorage(key: string, defaultValue: boolean, options?: StorageOptions<boolean>): Ref<boolean>
  • added: function useSessionStorage(key: string, defaultValue: number, options?: StorageOptions<number>): Ref<number>
  • added: function useSessionStorage(key: string, defaultValue: string, options?: StorageOptions<string>): Ref<string>
  • added: function useSessionStorage<T = unknown>(key: string, defaultValue: null, options?: StorageOptions<T>): Ref<T>
  • added: function useSessionStorage<T>(key: string, defaultValue: T, options?: StorageOptions<T>): Ref<T>
  • added: function useShare(shareOptions?: MaybeRef<ShareOptions>, options?: ConfigurableNavigator): { isSupported: boolean; share: (overrideOptions?: MaybeRef<ShareOptions>) => Promise<void> }
  • added: function useSpeechRecognition(options?: SpeechRecognitionOptions): { isSupported: boolean; isListening: Ref<boolean>; isFinal: Ref<boolean>; recognition: SpeechRecognition | undefined; result: Ref<string>; error: Ref<SpeechRecognitionErrorEvent | undefined>; toggle: (value?: boolean) => void; start: () => void; stop: () => void }
  • added: function useStorage(key: string, defaultValue: boolean, storage?: StorageLike, options?: StorageOptions<boolean>): Ref<boolean>
  • added: function useStorage(key: string, defaultValue: number, storage?: StorageLike, options?: StorageOptions<number>): Ref<number>
  • added: function useStorage(key: string, defaultValue: string, storage?: StorageLike, options?: StorageOptions<string>): Ref<string>
  • added: function useStorage<T = unknown>(key: string, defaultValue: null, storage?: StorageLike, options?: StorageOptions<T>): Ref<T>
  • added: function useStorage<T>(key: string, defaultValue: T, storage?: StorageLike, options?: StorageOptions<T>): Ref<T>
  • added: function useSwipe(target: MaybeRef<EventTarget | null | undefined>, options?: SwipeOptions): SwipeReturn
  • added: function useTemplateRefsList<T = Element>(): Readonly<Ref<Readonly<TemplateRefsList<T>>>>
  • added: function useTimeAgo(time: MaybeRef<Date | number | string>, options: TimeAgoOptions<true>): { timeAgo: ComputedRef<string> } & Pausable
  • added: function useTimeAgo(time: MaybeRef<Date | number | string>, options?: TimeAgoOptions<false>): ComputedRef<string>
  • added: function useTimestamp(options: TimestampOptions<true>): { timestamp: Ref<number> } & Pausable
  • added: function useTimestamp(options?: TimestampOptions<false>): Ref<number>
  • added: function useTitle(newTitle?: MaybeRef<string | null | undefined>, options?: UseTitleOptions): vue_demi.Ref<string | null | undefined>
  • added: function useTransition(source: Ref<number>, options?: TransitionOptions): ComputedRef<number>
  • added: function useTransition<T extends MaybeRef<number>[]>(source: [...T], options?: TransitionOptions): ComputedRef<{ [K in keyof T]: number }>
  • added: function useTransition<T extends Ref<number[]>>(source: T, options?: TransitionOptions): ComputedRef<number[]>
  • added: function useUrlSearchParams<T extends Record<string, any> = UrlParams>(mode?: 'history' | 'hash', options?: ConfigurableWindow): T
  • added: function useUserMedia(options?: UseUserMediaOptions): { isSupported: boolean; stream: Ref<MediaStream | undefined>; start: () => Promise<MediaStream | undefined>; stop: () => void; restart: () => Promise<MediaStream | undefined>; videoDeviceId: Ref<string | false | undefined>; audioDeviceId: Ref<string | false | undefined>; enabled: Ref<boolean>; autoSwitch: Ref<boolean> }
  • added: function useVModel<P extends object, K extends keyof P, Name extends string>(props: P, key?: K, emit?: (name: Name, ...args: any[]) => void, options?: VModelOptions): vue_demi.Ref<vue_demi.UnwrapRef<P[K]>> | vue_demi.WritableComputedRef<P[K]>
  • added: function useVModels<P extends object, Name extends string>(props: P, emit?: (name: Name, ...args: any[]) => void, options?: VModelOptions): ToRefs<P>
  • added: function useWebSocket<Data = any>(url: string, options?: WebSocketOptions): WebSocketResult<Data>
  • added: function useWebWorker(url: string, workerOptions?: WorkerOptions, options?: ConfigurableWindow): { data: Ref<any>; post: { (message: any, transfer: Transferable[]): void; (message: any, options?: PostMessageOptions | undefined): void }; terminate: () => void; worker: Ref<Worker | undefined> }
  • added: function useWindowFocus({ window }?: ConfigurableWindow): Ref<boolean>
  • added: function useWindowScroll({ window }?: ConfigurableWindow): { x: vue_demi.Ref<number>; y: vue_demi.Ref<number> }
  • added: function useWindowSize({ window, initialWidth, initialHeight }?: WindowSizeOptions): { width: vue_demi.Ref<number>; height: vue_demi.Ref<number> }
  • added: interface AfterFetchContext<T = any>
  • added: interface AsyncStateOptions
  • added: interface BatteryManager extends EventTarget
  • added: interface BeforeFetchContext
  • added: interface BrowserLocationState
  • added: interface ClipboardOptions<Source> extends ConfigurableNavigator
  • added: interface ClipboardReturn<Optional>
  • added: interface CreateFetchOptions
  • added: interface DeviceMotionOptions extends ConfigurableWindow, ConfigurableEventFilter
  • added: interface ElementSize
  • added: interface FaviconOptions extends ConfigurableDocument
  • added: interface GeolocationOptions extends Partial<PositionOptions>, ConfigurableNavigator
  • added: interface IdleOptions extends ConfigurableWindow, ConfigurableEventFilter
  • added: interface IntersectionObserverOptions extends ConfigurableWindow
  • added: interface MagicKeysInternal
  • added: interface MouseInElementOptions extends MouseOptions
  • added: interface MouseOptions extends ConfigurableWindow
  • added: interface MousePressedOptions extends ConfigurableWindow
  • added: interface MutationObserverOptions extends MutationObserverInit, ConfigurableWindow
  • added: interface NetworkState
  • added: interface OnClickOutsideOptions<E extends keyof OnClickOutsideEvents> extends ConfigurableWindow
  • added: interface ParallaxOptions extends ConfigurableWindow
  • added: interface ParallaxReturn
  • added: interface PointerPosition
  • added: interface PointerSwipeOptions
  • added: interface PointerSwipeReturn
  • added: interface RafFnOptions extends ConfigurableWindow
  • added: interface ResizeObserverEntry
  • added: interface ResizeObserverOptions extends ConfigurableWindow
  • added: interface ResizeObserverSize
  • added: interface ShareOptions
  • added: interface SpeechRecognitionOptions extends ConfigurableWindow
  • added: interface StorageOptions<T> extends ConfigurableEventFilter, ConfigurableWindow, ConfigurableFlush
  • added: interface SwipeOptions extends ConfigurableWindow
  • added: interface SwipeReturn
  • added: interface TimeAgoMessages
  • added: interface TimeAgoOptions<Controls extends boolean>
  • added: interface TimestampOptions<Controls extends boolean>
  • added: interface UseDarkOptions extends StorageOptions<ColorSchemes>
  • added: interface UseDevicesListOptions extends ConfigurableNavigator
  • added: interface UseDevicesListReturn
  • added: interface UseFetchOptions
  • added: interface UseIdleReturn
  • added: interface UseMagicKeysOptions<Reactive extends Boolean>
  • added: interface UseManualRefHistoryOptions<Raw, Serialized = Raw>
  • added: interface UseManualRefHistoryReturn<Raw, Serialized>
  • added: interface UseMediaSource
  • added: interface UseMediaTextTrack
  • added: interface UseMediaTextTrackSource
  • added: interface UseNowOptions<Controls extends boolean>
  • added: interface UsePermissionOptions<Controls extends boolean> extends ConfigurableNavigator
  • added: interface UsePermissionReturnWithControls
  • added: interface UseRefHistoryOptions<Raw, Serialized = Raw>
  • added: interface UseRefHistoryRecord<T>
  • added: interface UseRefHistoryReturn<Raw, Serialized>
  • added: interface UseScriptTagOptions extends ConfigurableDocument
  • added: interface UseTitleOptions extends ConfigurableDocument
  • added: interface UseUserMediaOptions extends ConfigurableNavigator
  • added: interface VModelOptions
  • added: interface VisibilityScrollTargetOptions extends ConfigurableWindow
  • added: interface WebSocketOptions
  • added: interface WebSocketResult<T>
  • added: interface WebWorkerOptions extends ConfigurableWindow
  • added: interface WindowSizeOptions extends ConfigurableWindow
  • added: interface WritableComputedInjectOptions<T, K>
  • added: interface WritableComputedInjectOptionsWithDefault<T, K>
  • added: member SwipeDirection.DOWN = 'DOWN'
  • added: member SwipeDirection.LEFT = 'LEFT'
  • added: member SwipeDirection.NONE = 'NONE'
  • added: member SwipeDirection.RIGHT = 'RIGHT'
  • added: member SwipeDirection.UP = 'UP'
  • added: method UseManualRefHistoryReturn.clear(): void
  • added: method UseManualRefHistoryReturn.commit(): void
  • added: method UseManualRefHistoryReturn.redo(): void
  • added: method UseManualRefHistoryReturn.reset(): void
  • added: method UseManualRefHistoryReturn.undo(): void
  • added: method UseRefHistoryReturn.batch(fn: (cancel: Fn) => void): void
  • added: method UseRefHistoryReturn.clear(): void
  • added: method UseRefHistoryReturn.commit(): void
  • added: method UseRefHistoryReturn.dispose(): void
  • added: method UseRefHistoryReturn.pause(): void
  • added: method UseRefHistoryReturn.redo(): void
  • added: method UseRefHistoryReturn.reset(): void
  • added: method UseRefHistoryReturn.resume(commit?: boolean): void
  • added: method UseRefHistoryReturn.undo(): void
  • added: property AfterFetchContext.data: T | null
  • added: property AfterFetchContext.response: Response
  • added: property AsyncStateOptions.delay?: number
  • added: property AsyncStateOptions.immediate?: boolean
  • added: property AsyncStateOptions.onError?: (e: Error) => void
  • added: property AsyncStateOptions.resetOnExecute?: boolean
  • added: property BatteryManager.charging: boolean
  • added: property BatteryManager.chargingTime: number
  • added: property BatteryManager.dischargingTime: number
  • added: property BatteryManager.level: number
  • added: property BeforeFetchContext.cancel: Fn
  • added: property BeforeFetchContext.options: RequestInit
  • added: property BeforeFetchContext.url: string
  • added: property BrowserLocationState.hash?: string
  • added: property BrowserLocationState.host?: string
  • added: property BrowserLocationState.hostname?: string
  • added: property BrowserLocationState.href?: string
  • added: property BrowserLocationState.length?: number
  • added: property BrowserLocationState.origin?: string
  • added: property BrowserLocationState.pathname?: string
  • added: property BrowserLocationState.port?: string
  • added: property BrowserLocationState.protocol?: string
  • added: property BrowserLocationState.search?: string
  • added: property BrowserLocationState.state?: any
  • added: property BrowserLocationState.trigger: string
  • added: property ClipboardOptions.copiedDuring?: number
  • added: property ClipboardOptions.read?: boolean
  • added: property ClipboardOptions.source?: Source
  • added: property ClipboardReturn.copied: ComputedRef<boolean>
  • added: property ClipboardReturn.copy: Optional extends true ? (text?: string) => Promise<void> : (text: string) => Promise<void>
  • added: property ClipboardReturn.isSupported: boolean
  • added: property ClipboardReturn.text: ComputedRef<string>
  • added: property CreateFetchOptions.baseUrl?: MaybeRef<string>
  • added: property CreateFetchOptions.fetchOptions?: RequestInit
  • added: property CreateFetchOptions.options?: UseFetchOptions
  • added: property ElementSize.height: number
  • added: property ElementSize.width: number
  • added: property FaviconOptions.baseUrl?: string
  • added: property FaviconOptions.rel?: string
  • added: property IdleOptions.events?: WindowEventName[]
  • added: property IdleOptions.initialState?: boolean
  • added: property IdleOptions.listenForVisibilityChange?: boolean
  • added: property IntersectionObserverOptions.root?: MaybeElementRef
  • added: property IntersectionObserverOptions.rootMargin?: string
  • added: property IntersectionObserverOptions.threshold?: number | number[]
  • added: property MagicKeysInternal.current: Set<string>
  • added: property MouseInElementOptions.handleOutside?: boolean
  • added: property MouseOptions.initialValue?: { x: number; y: number }
  • added: property MouseOptions.resetOnTouchEnds?: boolean
  • added: property MouseOptions.touch?: boolean
  • added: property MousePressedOptions.drag?: boolean
  • added: property MousePressedOptions.initialValue?: boolean
  • added: property MousePressedOptions.target?: MaybeElementRef
  • added: property MousePressedOptions.touch?: boolean
  • added: property NetworkState.downlink: Ref<number | undefined>
  • added: property NetworkState.downlinkMax: Ref<number | undefined>
  • added: property NetworkState.effectiveType: Ref<NetworkEffectiveType | undefined>
  • added: property NetworkState.isOnline: Ref<boolean>
  • added: property NetworkState.isSupported: boolean
  • added: property NetworkState.offlineAt: Ref<number | undefined>
  • added: property NetworkState.rtt: Ref<number | undefined>
  • added: property NetworkState.saveData: Ref<boolean | undefined>
  • added: property NetworkState.type: Ref<NetworkType>
  • added: property OnClickOutsideOptions.event?: E
  • added: property ParallaxOptions.deviceOrientationRollAdjust?: (i: number) => number
  • added: property ParallaxOptions.deviceOrientationTiltAdjust?: (i: number) => number
  • added: property ParallaxOptions.mouseRollAdjust?: (i: number) => number
  • added: property ParallaxOptions.mouseTiltAdjust?: (i: number) => number
  • added: property ParallaxReturn.roll: ComputedRef<number>
  • added: property ParallaxReturn.source: ComputedRef<'deviceOrientation' | 'mouse'>
  • added: property ParallaxReturn.tilt: ComputedRef<number>
  • added: property PointerPosition.x: number
  • added: property PointerPosition.y: number
  • added: property PointerSwipeOptions.onSwipe?: (e: PointerEvent) => void
  • added: property PointerSwipeOptions.onSwipeEnd?: (e: PointerEvent, direction: SwipeDirection) => void
  • added: property PointerSwipeOptions.onSwipeStart?: (e: PointerEvent) => void
  • added: property PointerSwipeOptions.threshold?: number
  • added: property PointerSwipeReturn.direction: Readonly<Ref<SwipeDirection | null>>
  • added: property PointerSwipeReturn.distanceX: Readonly<Ref<number>>
  • added: property PointerSwipeReturn.distanceY: Readonly<Ref<number>>
  • added: property PointerSwipeReturn.stop: () => void
  • added: property RafFnOptions.immediate?: boolean
  • added: property ResizeObserverOptions.box?: 'content-box' | 'border-box'
  • added: property ShareOptions.files?: File[]
  • added: property ShareOptions.text?: string
  • added: property ShareOptions.title?: string
  • added: property ShareOptions.url?: string
  • added: property SpeechRecognitionOptions.continuous?: boolean
  • added: property SpeechRecognitionOptions.interimResults?: boolean
  • added: property SpeechRecognitionOptions.lang?: string
  • added: property StorageOptions.deep?: boolean
  • added: property StorageOptions.listenToStorageChanges?: boolean
  • added: property StorageOptions.serializer?: Serializer<T>
  • added: property SwipeOptions.onSwipe?: (e: TouchEvent) => void
  • added: property SwipeOptions.onSwipeEnd?: (e: TouchEvent, direction: SwipeDirection) => void
  • added: property SwipeOptions.onSwipeStart?: (e: TouchEvent) => void
  • added: property SwipeOptions.passive?: boolean
  • added: property SwipeOptions.threshold?: number
  • added: property SwipeReturn.coordsEnd: { readonly x: number; readonly y: number }
  • added: property SwipeReturn.coordsStart: { readonly x: number; readonly y: number }
  • added: property SwipeReturn.direction: ComputedRef<SwipeDirection | null>
  • added: property SwipeReturn.isPassiveEventSupported: boolean
  • added: property SwipeReturn.isSwiping: Ref<boolean>
  • added: property SwipeReturn.lengthX: ComputedRef<number>
  • added: property SwipeReturn.lengthY: ComputedRef<number>
  • added: property SwipeReturn.stop: () => void
  • added: property TimeAgoMessages.day: string | MessageFormatter<number>
  • added: property TimeAgoMessages.future: string | MessageFormatter<string>
  • added: property TimeAgoMessages.hour: string | MessageFormatter<number>
  • added: property TimeAgoMessages.justNow: string
  • added: property TimeAgoMessages.minute: string | MessageFormatter<number>
  • added: property TimeAgoMessages.month: string | MessageFormatter<number>
  • added: property TimeAgoMessages.past: string | MessageFormatter<string>
  • added: property TimeAgoMessages.second: string | MessageFormatter<number>
  • added: property TimeAgoMessages.week: string | MessageFormatter<number>
  • added: property TimeAgoMessages.year: string | MessageFormatter<number>
  • added: property TimeAgoOptions.controls?: Controls
  • added: property TimeAgoOptions.fullDateFormatter?: (date: Date) => string
  • added: property TimeAgoOptions.max?: 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year' | number
  • added: property TimeAgoOptions.messages?: TimeAgoMessages
  • added: property TimeAgoOptions.updateInterval?: number
  • added: property TimestampOptions.controls?: Controls
  • added: property TimestampOptions.interval?: 'requestAnimationFrame' | number
  • added: property TimestampOptions.offset?: number
  • added: property UseDarkOptions.attribute?: string
  • added: property UseDarkOptions.onChanged?: (isDark: boolean) => void
  • added: property UseDarkOptions.selector?: string
  • added: property UseDarkOptions.storage?: StorageLike
  • added: property UseDarkOptions.storageKey?: string | null
  • added: property UseDarkOptions.valueDark?: string
  • added: property UseDarkOptions.valueLight?: string
  • added: property UseDevicesListOptions.onUpdated?: (devices: MediaDeviceInfo[]) => void
  • added: property UseDevicesListOptions.requestPermissions?: boolean
  • added: property UseDevicesListReturn.audioInputs: ComputedRef<MediaDeviceInfo[]>
  • added: property UseDevicesListReturn.audioOutputs: ComputedRef<MediaDeviceInfo[]>
  • added: property UseDevicesListReturn.devices: Ref<MediaDeviceInfo[]>
  • added: property UseDevicesListReturn.ensurePermissions: () => Promise<boolean>
  • added: property UseDevicesListReturn.isSupported: boolean
  • added: property UseDevicesListReturn.permissionGranted: Ref<boolean>
  • added: property UseDevicesListReturn.videoInputs: ComputedRef<MediaDeviceInfo[]>
  • added: property UseFetchOptions.afterFetch?: (ctx: AfterFetchContext) => Promise<Partial<AfterFetchContext>> | Partial<AfterFetchContext>
  • added: property UseFetchOptions.beforeFetch?: (ctx: BeforeFetchContext) => Promise<Partial<BeforeFetchContext> | void> | Partial<BeforeFetchContext> | void
  • added: property UseFetchOptions.fetch?: typeof window.fetch
  • added: property UseFetchOptions.immediate?: boolean
  • added: property UseFetchOptions.refetch?: MaybeRef<boolean>
  • added: property UseIdleReturn.idle: Ref<boolean>
  • added: property UseIdleReturn.lastActive: Ref<number>
  • added: property UseMagicKeysOptions.aliasMap?: Record<string, string>
  • added: property UseMagicKeysOptions.onEventFired?: (e: KeyboardEvent) => void | boolean
  • added: property UseMagicKeysOptions.passive?: boolean
  • added: property UseMagicKeysOptions.reactive?: Reactive
  • added: property UseMagicKeysOptions.target?: MaybeRef<EventTarget>
  • added: property UseManualRefHistoryOptions.capacity?: number
  • added: property UseManualRefHistoryOptions.clone?: boolean | CloneFn<Raw>
  • added: property UseManualRefHistoryOptions.dump?: (v: Raw) => Serialized
  • added: property UseManualRefHistoryOptions.parse?: (v: Serialized) => Raw
  • added: property UseManualRefHistoryOptions.setSource?: (source: Ref<Raw>, v: Raw) => void
  • added: property UseManualRefHistoryReturn.canRedo: Ref<boolean>
  • added: property UseManualRefHistoryReturn.canUndo: Ref<boolean>
  • added: property UseManualRefHistoryReturn.history: Ref<UseRefHistoryRecord<Serialized>[]>
  • added: property UseManualRefHistoryReturn.last: Ref<UseRefHistoryRecord<Serialized>>
  • added: property UseManualRefHistoryReturn.redoStack: Ref<UseRefHistoryRecord<Serialized>[]>
  • added: property UseManualRefHistoryReturn.source: Ref<Raw>
  • added: property UseManualRefHistoryReturn.undoStack: Ref<UseRefHistoryRecord<Serialized>[]>
  • added: property UseMediaSource.src: string
  • added: property UseMediaSource.type?: string
  • added: property UseMediaTextTrack.activeCues: TextTrackCueList | null
  • added: property UseMediaTextTrack.cues: TextTrackCueList | null
  • added: property UseMediaTextTrack.id: number
  • added: property UseMediaTextTrack.inBandMetadataTrackDispatchType: string
  • added: property UseMediaTextTrack.kind: TextTrackKind
  • added: property UseMediaTextTrack.label: string
  • added: property UseMediaTextTrack.language: string
  • added: property UseMediaTextTrack.mode: TextTrackMode
  • added: property UseMediaTextTrackSource.default?: boolean
  • added: property UseMediaTextTrackSource.kind: TextTrackKind
  • added: property UseMediaTextTrackSource.label: string
  • added: property UseMediaTextTrackSource.src: string
  • added: property UseMediaTextTrackSource.srcLang: string
  • added: property UseNowOptions.controls?: Controls
  • added: property UseNowOptions.interval?: 'requestAnimationFrame' | number
  • added: property UsePermissionOptions.controls?: Controls
  • added: property UsePermissionReturnWithControls.isSupported: boolean
  • added: property UsePermissionReturnWithControls.query: () => Promise<PermissionStatus | undefined>
  • added: property UsePermissionReturnWithControls.state: UsePermissionReturn
  • added: property UseRefHistoryOptions.capacity?: number
  • added: property UseRefHistoryOptions.clone?: boolean | CloneFn<Raw>
  • added: property UseRefHistoryOptions.deep?: boolean
  • added: property UseRefHistoryOptions.dump?: (v: Raw) => Serialized
  • added: property UseRefHistoryOptions.flush?: 'pre' | 'post' | 'sync'
  • added: property UseRefHistoryOptions.parse?: (v: Serialized) => Raw
  • added: property UseRefHistoryRecord.snapshot: T
  • added: property UseRefHistoryRecord.timestamp: number
  • added: property UseRefHistoryReturn.canRedo: Ref<boolean>
  • added: property UseRefHistoryReturn.canUndo: Ref<boolean>
  • added: property UseRefHistoryReturn.history: Ref<UseRefHistoryRecord<Serialized>[]>
  • added: property UseRefHistoryReturn.isTracking: Ref<boolean>
  • added: property UseRefHistoryReturn.last: Ref<UseRefHistoryRecord<Serialized>>
  • added: property UseRefHistoryReturn.redoStack: Ref<UseRefHistoryRecord<Serialized>[]>
  • added: property UseRefHistoryReturn.source: Ref<Raw>
  • added: property UseRefHistoryReturn.undoStack: Ref<UseRefHistoryRecord<Serialized>[]>
  • added: property UseScriptTagOptions.async?: boolean
  • added: property UseScriptTagOptions.crossOrigin?: 'anonymous' | 'use-credentials'
  • added: property UseScriptTagOptions.defer?: boolean
  • added: property UseScriptTagOptions.immediate?: boolean
  • added: property UseScriptTagOptions.manual?: boolean
  • added: property UseScriptTagOptions.noModule?: boolean
  • added: property UseScriptTagOptions.referrerPolicy?: 'no-referrer' | 'no-referrer-when-downgrade' | 'origin' | 'origin-when-cross-origin' | 'same-origin' | 'strict-origin' | 'strict-origin-when-cross-origin' | 'unsafe-url'
  • added: property UseScriptTagOptions.type?: string
  • added: property UseTitleOptions.observe?: boolean
  • added: property UseUserMediaOptions.audioDeviceId?: MaybeRef<string | undefined | false | 'none'>
  • added: property UseUserMediaOptions.autoSwitch?: MaybeRef<boolean>
  • added: property UseUserMediaOptions.enabled?: MaybeRef<boolean>
  • added: property UseUserMediaOptions.videoDeviceId?: MaybeRef<string | undefined | false | 'none'>
  • added: property VModelOptions.eventName?: string
  • added: property VModelOptions.passive?: boolean
  • added: property VisibilityScrollTargetOptions.scrollTarget?: Ref<Element | null | undefined>
  • added: property WebSocketOptions.autoReconnect?: boolean | { retries?: number; delay?: number; onFailed?: Fn }
  • added: property WebSocketOptions.heartbeat?: boolean | { message?: string; interval?: number }
  • added: property WebSocketOptions.immediate?: boolean
  • added: property WebSocketOptions.onConnected?: (ws: WebSocket) => void
  • added: property WebSocketOptions.onDisconnected?: (ws: WebSocket, event: CloseEvent) => void
  • added: property WebSocketOptions.onError?: (ws: WebSocket, event: Event) => void
  • added: property WebSocketOptions.onMessage?: (ws: WebSocket, event: MessageEvent) => void
  • added: property WebSocketResult.close: WebSocket['close']
  • added: property WebSocketResult.data: Ref<T | null>
  • added: property WebSocketResult.open: Fn
  • added: property WebSocketResult.send: (data: string | ArrayBuffer | Blob, useBuffer?: boolean) => boolean
  • added: property WebSocketResult.status: Ref<WebSocketStatus>
  • added: property WebSocketResult.ws: Ref<WebSocket | undefined>
  • added: property WebWorkerOptions.dependencies?: string[]
  • added: property WebWorkerOptions.timeout?: number
  • added: property WindowSizeOptions.initialHeight?: number
  • added: property WindowSizeOptions.initialWidth?: number
  • added: property WritableComputedInjectOptions.get: ComputedInjectGetter<T, K>
  • added: property WritableComputedInjectOptions.set: ComputedInjectSetter<K>
  • added: property WritableComputedInjectOptionsWithDefault.get: ComputedInjectGetterWithDefault<T, K>
  • added: property WritableComputedInjectOptionsWithDefault.set: ComputedInjectSetter<K>
  • added: readonly property PointerSwipeReturn.isSwiping: Ref<boolean>
  • added: readonly property PointerSwipeReturn.posEnd: PointerPosition
  • added: readonly property PointerSwipeReturn.posStart: PointerPosition
  • added: readonly property ResizeObserverEntry.borderBoxSize?: ReadonlyArray<ResizeObserverSize>
  • added: readonly property ResizeObserverEntry.contentBoxSize?: ReadonlyArray<ResizeObserverSize>
  • added: readonly property ResizeObserverEntry.contentRect: DOMRectReadOnly
  • added: readonly property ResizeObserverEntry.devicePixelContentBoxSize?: ReadonlyArray<ResizeObserverSize>
  • added: readonly property ResizeObserverEntry.target: Element
  • added: readonly property ResizeObserverSize.blockSize: number
  • added: readonly property ResizeObserverSize.inlineSize: number
  • added: type AsyncComputedOnCancel = (cancelCallback: Fn) => void
  • added: type AsyncComputedOptions = { lazy?: Boolean; evaluating?: Ref<boolean> }
  • added: type Breakpoints<K extends string = string> = Record<K, number | string>
  • added: type CloneFn<F, T = F> = (x: F) => T
  • added: type ColorSchemeType = 'dark' | 'light' | 'no-preference'
  • added: type ColorSchemes = 'light' | 'dark' | 'auto'
  • added: type ComputedInjectGetter<T, K> = (source: T | undefined, ctx?: any) => K
  • added: type ComputedInjectGetterWithDefault<T, K> = (source: T, ctx?: any) => K
  • added: type ComputedInjectSetter<T> = (v: T) => void
  • added: type CreateGlobalStateReturn = ReturnType<typeof createGlobalState>
  • added: type DocumentEventName = keyof DocumentEventMap
  • added: type GeneralEventListener<E = Event> = { (evt: E): void }
  • added: type GeneralPermissionDescriptor = PermissionDescriptor | DevicePermissionDescriptor | MidiPermissionDescriptor | PushPermissionDescriptor | { name: DescriptorNamePolyfill }
  • added: type KeyFilter = null | undefined | string | KeyPredicate
  • added: type KeyPredicate = (event: KeyboardEvent) => boolean
  • added: type KeyStrokeEventName = 'keydown' | 'keypress' | 'keyup'
  • added: type KeyStrokeOptions = { eventName?: KeyStrokeEventName; target?: MaybeRef<EventTarget>; passive?: boolean }
  • added: type MagicKeys<Reactive extends Boolean> = Readonly<Omit<Reactive extends true ? Record<string, boolean> : Record<string, ComputedRef<boolean>>, keyof MagicKeysInternal> & MagicKeysInternal>
  • added: type MaybeElementRef = MaybeRef<Element | VueInstance | undefined | null>
  • added: type MessageFormatter<T = number> = (value: T, isPast: boolean) => string
  • added: type MouseSourceType = 'mouse' | 'touch' | null
  • added: type NetworkEffectiveType = 'slow-2g' | '2g' | '3g' | '4g' | undefined
  • added: type NetworkType = 'bluetooth' | 'cellular' | 'ethernet' | 'none' | 'wifi' | 'wimax' | 'other' | 'unknown'
  • added: type OnClickOutsideEvents = Pick<WindowEventMap, 'mousedown' | 'mouseup' | 'touchstart' | 'touchend' | 'pointerdown' | 'pointerup'>
  • added: type ResizeObserverCallback = (entries: ReadonlyArray<ResizeObserverEntry>, observer: ResizeObserver) => void
  • added: type Serializer<T> = { read(raw: string): T; write(value: T): string }
  • added: type StorageLike = Pick<Storage, 'getItem' | 'setItem' | 'removeItem'>
  • added: type TemplateRefsList<T> = T[] & { set(el: Object | null): void }
  • added: type TransitionOptions = { delay?: MaybeRef<number>; disabled?: MaybeRef<boolean>; duration?: MaybeRef<number>; onFinished?: () => void; onStarted?: () => void; transition?: MaybeRef<E…
  • added: type UrlParams = Record<string, string[] | string>
  • added: type UseAsyncStateReturn = ReturnType<typeof useAsyncState>
  • added: type UseBatteryReturn = ReturnType<typeof useBattery>
  • added: type UseBreakpointsReturn = ReturnType<typeof useBreakpoints>
  • added: type UseBrowserLocationReturn = ReturnType<typeof useBrowserLocation>
  • added: type UseDeviceMotionReturn = ReturnType<typeof useDeviceMotion>
  • added: type UseDeviceOrientationReturn = ReturnType<typeof useDeviceOrientation>
  • added: type UseDevicePixelRatioReturn = ReturnType<typeof useDevicePixelRatio>
  • added: type UseElementBoundingReturn = ReturnType<typeof useElementBounding>
  • added: type UseElementSizeReturn = ReturnType<typeof useElementSize>
  • added: type UseEventListenerReturn = ReturnType<typeof useEventListener>
  • added: type UseFullscreenReturn = ReturnType<typeof useFullscreen>
  • added: type UseGeolocationReturn = ReturnType<typeof useGeolocation>
  • added: type UseIntersectionObserverReturn = ReturnType<typeof useIntersectionObserver>
  • added: type UseMediaControlsReturn = ReturnType<typeof useMediaControls>
  • added: type UseMouseInElementReturn = ReturnType<typeof useMouseInElement>
  • added: type UseMousePressedReturn = ReturnType<typeof useMousePressed>
  • added: type UseMouseReturn = ReturnType<typeof useMouse>
  • added: type UseMutationObserverReturn = ReturnType<typeof useMutationObserver>
  • added: type UseNowReturn = ReturnType<typeof useNow>
  • added: type UsePermissionReturn = Readonly<Ref<PermissionState | undefined>>
  • added: type UseResizeObserverReturn = ReturnType<typeof useResizeObserver>
  • added: type UseScriptTagReturn = ReturnType<typeof useScriptTag>
  • added: type UseShareReturn = ReturnType<typeof useShare>
  • added: type UseSpeechRecognitionReturn = ReturnType<typeof useSpeechRecognition>
  • added: type UseTimestampReturn = ReturnType<typeof useTimestamp>
  • added: type UseUserMediaReturn = ReturnType<typeof useUserMedia>
  • added: type UseWebWorkerFnReturn = ReturnType<typeof useWebWorkerFn>
  • added: type UseWebWorkerReturn = ReturnType<typeof useWebWorker>
  • added: type UseWindowScrollReturn = ReturnType<typeof useWindowScroll>
  • added: type UseWindowSizeReturn = ReturnType<typeof useWindowSize>
  • added: type VueInstance = InstanceType<ReturnType<typeof defineComponent>>
  • added: type WebSocketStatus = 'OPEN' | 'CONNECTING' | 'CLOSED'
  • added: type WebWorkerStatus = 'PENDING' | 'SUCCESS' | 'RUNNING' | 'ERROR' | 'TIMEOUT_EXPIRED'
  • added: type WindowEventName = keyof WindowEventMap