Skip to content

Upgrading @vueuse/core 8 to 9

Unknown8.9.4 → 9.13.0

Fetching 24 releases from GitHub…0 / 24
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.

Moves @types/web-bluetooth 0.0.14 → 0.0.16. Your build may pick other versions.

2 packages of its own release move with it.

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

  • added: interface Element
  • added: interface PointerLockOptions
  • added: method Element.requestPointerLock(options?: PointerLockOptions): Promise<void> | void
  • added: property PointerLockOptions.unadjustedMovement?: boolean
  • removed: call UseMemoizedFn(...args: Args): Result
  • removed: function useClamp(value: MaybeRef<number>, min: MaybeRef<number>, max: MaybeRef<number>): Ref<number>
  • removed: interface AsyncStateOptions<Shallow extends boolean>
  • removed: interface ClipboardOptions<Source> extends ConfigurableNavigator
  • removed: interface ClipboardReturn<Optional>
  • removed: interface FaviconOptions extends ConfigurableDocument
  • removed: interface FocusWithinReturn
  • removed: interface GeolocationOptions extends Partial<PositionOptions>, ConfigurableNavigator
  • removed: interface IdleOptions extends ConfigurableWindow, ConfigurableEventFilter
  • removed: interface IntersectionObserverOptions extends ConfigurableWindow
  • removed: interface KeyStrokeOptions
  • removed: interface MemoryOptions extends IntervalFnOptions
  • removed: interface ModifierOptions<Initial> extends ConfigurableDocument
  • removed: interface MouseOptions extends ConfigurableWindow, ConfigurableEventFilter
  • removed: interface MutationObserverOptions extends MutationObserverInit, ConfigurableWindow
  • removed: interface ParallaxOptions extends ConfigurableWindow
  • removed: interface ParallaxReturn
  • removed: interface PointerSwipeOptions
  • removed: interface PointerSwipeReturn
  • removed: interface RafFnOptions extends ConfigurableWindow
  • removed: interface ResizeObserverOptions extends ConfigurableWindow
  • removed: interface ShareOptions
  • removed: interface SpeechRecognitionOptions extends ConfigurableWindow
  • removed: interface SpeechSynthesisOptions extends ConfigurableWindow
  • removed: interface StorageAsyncOptions<T> extends Omit<StorageOptions<T>, 'serializer'>
  • removed: interface StorageOptions<T> extends ConfigurableEventFilter, ConfigurableWindow, ConfigurableFlush
  • removed: interface SwipeOptions extends ConfigurableWindow
  • removed: interface SwipeReturn
  • removed: interface TimestampOptions<Controls extends boolean>
  • removed: interface TransitionOptions
  • removed: interface UseMemoizedFn<Result, Args extends unknown[]>
  • removed: interface UseTimeAgoMessages
  • removed: interface UseTitleOptions extends ConfigurableDocument
  • removed: interface UseVirtualListOptions
  • removed: interface VModelOptions<T>
  • removed: interface VisibilityScrollTargetOptions extends ConfigurableWindow
  • removed: interface WebSocketOptions
  • removed: interface WebSocketResult<T>
  • removed: interface WebWorkerOptions extends ConfigurableWindow
  • removed: interface WindowSizeOptions extends ConfigurableWindow
  • 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 UseMemoizedFn.clear(): void
  • removed: method UseMemoizedFn.delete(...args: Args): void
  • removed: method UseMemoizedFn.generateKey(...args: Args): CacheKey
  • removed: method UseMemoizedFn.load(...args: Args): Result
  • removed: method UseRefHistoryReturn.clear(): void
  • removed: method UseRefHistoryReturn.commit(): void
  • removed: method UseRefHistoryReturn.redo(): void
  • removed: method UseRefHistoryReturn.reset(): void
  • removed: method UseRefHistoryReturn.undo(): void
  • removed: property AsyncStateOptions.delay?: number
  • removed: property AsyncStateOptions.immediate?: boolean
  • removed: property AsyncStateOptions.onError?: (e: unknown) => void
  • removed: property AsyncStateOptions.resetOnExecute?: boolean
  • removed: property AsyncStateOptions.shallow?: Shallow
  • 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 FaviconOptions.baseUrl?: string
  • removed: property FaviconOptions.rel?: string
  • removed: property FocusWithinReturn.focused: Ref<boolean>
  • 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 KeyStrokeOptions.eventName?: KeyStrokeEventName
  • removed: property KeyStrokeOptions.passive?: boolean
  • removed: property KeyStrokeOptions.target?: MaybeRef<EventTarget>
  • removed: property MemoryOptions.interval?: number
  • removed: property ModifierOptions.events?: WindowEventName[]
  • removed: property ModifierOptions.initial?: Initial
  • removed: property MouseOptions.initialValue?: Position
  • removed: property MouseOptions.resetOnTouchEnds?: boolean
  • removed: property MouseOptions.touch?: boolean
  • removed: property MouseOptions.type?: 'page' | 'client'
  • 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 PointerSwipeOptions.onSwipe?: (e: PointerEvent) => void
  • removed: property PointerSwipeOptions.onSwipeEnd?: (e: PointerEvent, direction: SwipeDirection) => void
  • removed: property PointerSwipeOptions.onSwipeStart?: (e: PointerEvent) => void
  • removed: property PointerSwipeOptions.pointerTypes?: PointerType[]
  • removed: property PointerSwipeOptions.threshold?: number
  • removed: property PointerSwipeReturn.direction: Readonly<Ref<SwipeDirection | null>>
  • removed: property PointerSwipeReturn.distanceX: Readonly<Ref<number>>
  • removed: property PointerSwipeReturn.distanceY: Readonly<Ref<number>>
  • removed: property PointerSwipeReturn.stop: () => void
  • removed: property RafFnOptions.immediate?: boolean
  • 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?: MaybeRef<string>
  • removed: property SpeechSynthesisOptions.lang?: MaybeRef<string>
  • removed: property SpeechSynthesisOptions.pitch?: SpeechSynthesisUtterance['pitch']
  • removed: property SpeechSynthesisOptions.rate?: SpeechSynthesisUtterance['rate']
  • removed: property SpeechSynthesisOptions.voice?: SpeechSynthesisVoice
  • removed: property SpeechSynthesisOptions.volume?: SpeechSynthesisUtterance['volume']
  • removed: property StorageAsyncOptions.serializer?: SerializerAsync<T>
  • removed: property StorageOptions.deep?: boolean
  • removed: property StorageOptions.listenToStorageChanges?: boolean
  • removed: property StorageOptions.onError?: (error: unknown) => void
  • removed: property StorageOptions.serializer?: Serializer<T>
  • removed: property StorageOptions.shallow?: boolean
  • removed: property StorageOptions.writeDefaults?: boolean
  • 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<Position>
  • removed: property SwipeReturn.coordsStart: Readonly<Position>
  • removed: property SwipeReturn.direction: ComputedRef<SwipeDirection | null>
  • removed: property SwipeReturn.isPassiveEventSupported: boolean
  • removed: property SwipeReturn.isSwiping: Ref<boolean>
  • removed: property SwipeReturn.lengthX: ComputedRef<number>
  • removed: property SwipeReturn.lengthY: ComputedRef<number>
  • removed: property SwipeReturn.stop: () => void
  • removed: property TimestampOptions.controls?: Controls
  • removed: property TimestampOptions.immediate?: boolean
  • removed: property TimestampOptions.interval?: 'requestAnimationFrame' | number
  • removed: property TimestampOptions.offset?: number
  • removed: property TransitionOptions.delay?: MaybeRef<number>
  • removed: property TransitionOptions.disabled?: MaybeRef<boolean>
  • removed: property TransitionOptions.duration?: MaybeRef<number>
  • removed: property TransitionOptions.onFinished?: () => void
  • removed: property TransitionOptions.onStarted?: () => void
  • removed: property TransitionOptions.transition?: MaybeRef<EasingFunction | CubicBezierPoints>
  • removed: property UseMemoizedFn.cache: UseMemoizeCache<CacheKey, Result>
  • removed: property UseRefHistoryReturn.canRedo: Ref<boolean>
  • removed: property UseRefHistoryReturn.canUndo: Ref<boolean>
  • removed: property UseRefHistoryReturn.history: Ref<UseRefHistoryRecord<Serialized>[]>
  • 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 UseTimeAgoMessages.day: string | UseTimeAgoFormatter<number>
  • removed: property UseTimeAgoMessages.future: string | UseTimeAgoFormatter<string>
  • removed: property UseTimeAgoMessages.hour: string | UseTimeAgoFormatter<number>
  • removed: property UseTimeAgoMessages.justNow: string
  • removed: property UseTimeAgoMessages.minute: string | UseTimeAgoFormatter<number>
  • removed: property UseTimeAgoMessages.month: string | UseTimeAgoFormatter<number>
  • removed: property UseTimeAgoMessages.past: string | UseTimeAgoFormatter<string>
  • removed: property UseTimeAgoMessages.second: string | UseTimeAgoFormatter<number>
  • removed: property UseTimeAgoMessages.week: string | UseTimeAgoFormatter<number>
  • removed: property UseTimeAgoMessages.year: string | UseTimeAgoFormatter<number>
  • removed: property UseTimeAgoOptions.fullDateFormatter?: (date: Date) => string
  • removed: property UseTimeAgoOptions.max?: 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year' | number
  • removed: property UseTimeAgoOptions.messages?: UseTimeAgoMessages
  • removed: property UseTitleOptions.observe?: boolean
  • removed: property UseTitleOptions.titleTemplate?: string
  • removed: property UseVirtualListOptions.itemHeight: number | ((index: number) => number)
  • removed: property UseVirtualListOptions.overscan?: number
  • removed: property VModelOptions.deep?: boolean
  • removed: property VModelOptions.defaultValue?: T
  • removed: property VModelOptions.eventName?: string
  • removed: property VModelOptions.passive?: boolean
  • removed: property VisibilityScrollTargetOptions.scrollTarget?: MaybeRef<Element | null | undefined>
  • removed: property WebSocketOptions.autoClose?: boolean
  • removed: property WebSocketOptions.autoReconnect?: boolean | { retries?: number | (() => boolean); 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 WebSocketOptions.protocols?: string[]
  • 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: property WindowSizeOptions.listenOrientation?: boolean
  • removed: readonly property PointerSwipeReturn.isSwiping: Ref<boolean>
  • removed: readonly property PointerSwipeReturn.posEnd: Position
  • removed: readonly property PointerSwipeReturn.posStart: Position
  • removed: type MagicKeys<Reactive extends Boolean> = Readonly<Omit<Reactive extends true ? Record<string, boolean> : Record<string, ComputedRef<boolean>>, keyof MagicKeysInternal> & MagicKeysInternal>
  • removed: type Status = 'init' | 'play' | 'pause' | 'end'
  • removed: type UseBroadcastChannelReturn = ReturnType<typeof useBroadcastChannel>
  • removed: type UseEventListenerReturn = ReturnType<typeof useEventListener>
  • removed: type VoiceInfo = Pick<SpeechSynthesisVoice, 'lang' | 'name'>
  • changed: const TransitionPresets: Record<string, CubicBezierPoints | EasingFunction> → const TransitionPresets: Record<'easeInSine' | 'easeOutSine' | 'easeInOutSine' | 'easeInQuad' | 'easeOutQuad' | 'easeInOutQuad' | 'easeInCubic' | 'easeOutCubic' | 'easeInOutCubic' | 'e…
  • changed: const useBroadcastChannel: (options: UseBroadcastChannelOptions) => { isSupported: boolean | undefined; channel: vue_demi.Ref<BroadcastChannel | undefined>; data: vue_demi.Ref<any>; post… → const useBroadcastChannel: <D, P>(options: UseBroadcastChannelOptions) => UseBroadcastChannelReturn<D, P>
  • changed: const useImage: <Shallow extends true>(options: MaybeRef<UseImageOptions>, asyncStateOptions?: AsyncStateOptions<Shallow>) => UseAsyncStateReturn<HTMLImageElement | undefined,… → const useImage: <Shallow extends true>(options: MaybeComputedRef<UseImageOptions>, asyncStateOptions?: UseAsyncStateOptions<Shallow, any>) => UseAsyncStateReturn<HTMLImageElem…
  • changed: const useScreenOrientation: (options?: ConfigurableWindow) => { isSupported: boolean; orientation: vue_demi.Ref<OrientationType | undefined>; angle: vue_demi.Ref<number>; lockOrientation:… → const useScreenOrientation: (options?: ConfigurableWindow) => { isSupported: vue_demi.Ref<boolean>; orientation: vue_demi.Ref<OrientationType | undefined>; angle: vue_demi.Ref<number>; lo…
  • changed: const useWakeLock: (options?: ConfigurableNavigator & ConfigurableDocument) => { isSupported: boolean | undefined; isActive: vue_demi.Ref<boolean>; request: (type: WakeLockType)… → const useWakeLock: (options?: UseWakeLockOptions) => { isSupported: vue_demi.Ref<boolean>; isActive: vue_demi.Ref<boolean>; request: (type: WakeLockType) => Promise<void>; releas…
  • changed: const useWebNotification: (defaultOptions?: UseWebNotificationOptions) => { isSupported: boolean; notification: Ref<Notification | null>; show: (overrides?: WebNotificationOptions) => P… → const useWebNotification: (defaultOptions?: UseWebNotificationOptions) => { isSupported: Ref<boolean>; notification: Ref<Notification | null>; show: (overrides?: WebNotificationOptions)…
  • changed: const useWebWorkerFn: <T extends (...fnArgs: any[]) => any>(fn: T, options?: WebWorkerOptions) => { workerFn: (...fnArgs: Parameters<T>) => Promise<ReturnType<T>>; workerStatus: vue… → const useWebWorkerFn: <T extends (...fnArgs: any[]) => any>(fn: T, options?: UseWebWorkerOptions) => { workerFn: (...fnArgs: Parameters<T>) => Promise<ReturnType<T>>; workerStatus:…
  • changed: function onClickOutside<T extends OnClickOutsideOptions>(target: MaybeElementRef, handler: <E = T['detectIframe'] extends true ? PointerEvent | FocusEvent : PointerEvent>(evt: E) => void, options?: T): (() => void) | undefined → function onClickOutside<T extends OnClickOutsideOptions>(target: MaybeElementRef, handler: OnClickOutsideHandler<{ detectIframe: T['detectIframe'] }>, options?: T): (() => void) | undefined
  • changed: function onKeyDown(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: Omit<KeyStrokeOptions, 'eventName'>): _vueuse_shared.Fn → function onKeyDown(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: Omit<OnKeyStrokeOptions, 'eventName'>): () => void
  • changed: function onKeyPressed(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: Omit<KeyStrokeOptions, 'eventName'>): _vueuse_shared.Fn → function onKeyPressed(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: Omit<OnKeyStrokeOptions, 'eventName'>): () => void
  • changed: function onKeyStroke(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: KeyStrokeOptions): _vueuse_shared.Fn → function onKeyStroke(handler: (event: KeyboardEvent) => void, options?: OnKeyStrokeOptions): () => void
  • changed: function onKeyUp(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: Omit<KeyStrokeOptions, 'eventName'>): _vueuse_shared.Fn → function onKeyUp(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: Omit<OnKeyStrokeOptions, 'eventName'>): () => void
  • changed: function templateRef<T extends HTMLElement | SVGElement | null>(key: string, initialValue?: T | null): Readonly<Ref<T>> → function templateRef<T extends HTMLElement | SVGElement | Component | null>(key: string, initialValue?: T | null): Readonly<Ref<T>>
  • changed: function unrefElement<T extends MaybeElement>(elRef: MaybeElementRef<T>): UnRefElementReturn<T> → function unrefElement<T extends MaybeElement>(elRef: MaybeComputedElementRef<T>): UnRefElementReturn<T>
  • changed: function useActiveElement<T extends HTMLElement>(options?: ConfigurableWindow): vue_demi.ComputedRef<T | null | undefined> → function useActiveElement<T extends HTMLElement>(options?: UseActiveElementOptions): _vueuse_shared.ComputedRefWithControl<T | null | undefined>
  • changed: function useAsyncState<Data, Shallow extends boolean = true>(promise: Promise<Data> | ((...args: any[]) => Promise<Data>), initialState: Data, options?: AsyncStateOptions<Shallow>): UseAsyncStateReturn<Data, Shallow> → function useAsyncState<Data, Params extends any[] = [], Shallow extends boolean = true>(promise: Promise<Data> | ((...args: Params) => Promise<Data>), initialState: Data, options?: UseAsyncStateOptions<Shallow, Data>): UseAsyncStateReturn<Data, Params, Shallow>
  • changed: function useBase64(target: MaybeRef<ArrayBuffer>): UseBase64Return → function useBase64(target: MaybeComputedRef<ArrayBuffer>): UseBase64Return
  • changed: function useBase64(target: MaybeRef<Blob>): UseBase64Return → function useBase64(target: MaybeComputedRef<Blob>): UseBase64Return
  • changed: function useBase64(target: MaybeRef<HTMLCanvasElement>, options?: ToDataURLOptions): UseBase64Return → function useBase64(target: MaybeComputedRef<HTMLCanvasElement>, options?: ToDataURLOptions): UseBase64Return
  • changed: function useBase64(target: MaybeRef<HTMLImageElement>, options?: ToDataURLOptions): UseBase64Return → function useBase64(target: MaybeComputedRef<HTMLImageElement>, options?: ToDataURLOptions): UseBase64Return
  • changed: function useBase64(target: MaybeRef<string>): UseBase64Return → function useBase64(target: MaybeComputedRef<string>): UseBase64Return
  • changed: function useBase64<T extends Map<string, unknown>>(target: MaybeRef<T>, options?: UseBase64ObjectOptions<T>): UseBase64Return → function useBase64<T extends Map<string, unknown>>(target: MaybeComputedRef<T>, options?: UseBase64ObjectOptions<T>): UseBase64Return
  • changed: function useBase64<T extends Record<string, unknown>>(target: MaybeRef<T>, options?: UseBase64ObjectOptions<T>): UseBase64Return → function useBase64<T extends Record<string, unknown>>(target: MaybeComputedRef<T>, options?: UseBase64ObjectOptions<T>): UseBase64Return
  • changed: function useBase64<T extends Set<unknown>>(target: MaybeRef<T>, options?: UseBase64ObjectOptions<T>): UseBase64Return → function useBase64<T extends Set<unknown>>(target: MaybeComputedRef<T>, options?: UseBase64ObjectOptions<T>): UseBase64Return
  • changed: function useBase64<T>(target: MaybeRef<T[]>, options?: UseBase64ObjectOptions<T[]>): UseBase64Return → function useBase64<T>(target: MaybeComputedRef<T[]>, options?: UseBase64ObjectOptions<T[]>): UseBase64Return
  • changed: 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> } → function useBattery({ navigator }?: ConfigurableNavigator): { isSupported: vue_demi.Ref<boolean>; charging: vue_demi.Ref<boolean>; chargingTime: vue_demi.Ref<number>; dischargingTime: vue_demi.Ref<number>; level: vue_demi.Ref<number> }
  • changed: function useBluetooth(options?: UseBluetoothOptions): { isSupported: boolean | undefined; isConnected: vue_demi.ComputedRef<boolean>; device: vue_demi.Ref<{ readonly id: string; readonly name?: string | undefined; readonly gatt?: { readonly device: any; readonly connected: boolean; connect: () => Promise<BluetoothRemoteGATTServer>; disconnect: () => void; getPrimaryService: (service: BluetoothSer… → function useBluetooth(options?: UseBluetoothOptions): UseBluetoothReturn
  • changed: function useBreakpoints<K extends string>(breakpoints: Breakpoints<K>, options?: ConfigurableWindow): { greater: (k: K) => Ref<boolean>; smaller(k: K): Ref<boolean>; between(a: K, b: K): Ref<boolean>; isGreater(k: K): boolean; isSmaller(k: K): boolean; isInBetween(a: K, b: K): boolean } & Record<K, Ref<boolean>> → function useBreakpoints<K extends string>(breakpoints: Breakpoints<K>, options?: ConfigurableWindow): { greater(k: K): Ref<boolean>; greaterOrEqual: (k: K) => Ref<boolean>; smaller(k: K): Ref<boolean>; smallerOrEqual(k: K): Ref<boolean>; between(a: K, b: K): Ref<boolean>; isGreater(k: K): boolean; isGreaterOrEqual(k: K): boolean; isSmaller(k: K): boolean; isSmallerOrEqual(k: K): boolean; isInBetw…
  • changed: function useClipboard(options: ClipboardOptions<MaybeRef<string>>): ClipboardReturn<true> → function useClipboard(options: UseClipboardOptions<MaybeComputedRef<string>>): UseClipboardReturn<true>
  • changed: function useClipboard(options?: ClipboardOptions<undefined>): ClipboardReturn<false> → function useClipboard(options?: UseClipboardOptions<undefined>): UseClipboardReturn<false>
  • changed: function useCssVar(prop: MaybeRef<string>, target?: MaybeElementRef, { window, initialValue }?: UseCssVarOptions): vue_demi.Ref<string> → function useCssVar(prop: MaybeComputedRef<string>, target?: MaybeElementRef, { window, initialValue }?: UseCssVarOptions): vue_demi.Ref<string>
  • changed: function useCurrentElement<T extends Element = Element>(): vue_demi.ComputedRef<T> → function useCurrentElement<T extends Element = Element>(): _vueuse_shared.ComputedRefWithControl<T>
  • changed: function useCycleList<T>(list: T[], options?: UseCycleListOptions<T>): { state: Ref<T>; index: vue_demi.WritableComputedRef<number>; next: (n?: number) => T; prev: (n?: number) => T } → function useCycleList<T>(list: T[], options?: UseCycleListOptions<T>): UseCycleListReturn<T>
  • changed: function useDebouncedRefHistory<Raw, Serialized = Raw>(source: Ref<Raw>, options?: Omit<UseRefHistoryOptions<Raw, Serialized>, 'eventFilter'> & { debounce?: MaybeRef<number> }): UseRefHistoryReturn<Raw, Serialized> → function useDebouncedRefHistory<Raw, Serialized = Raw>(source: Ref<Raw>, options?: Omit<UseRefHistoryOptions<Raw, Serialized>, 'eventFilter'> & { debounce?: MaybeComputedRef<number> }): UseRefHistoryReturn<Raw, Serialized>
  • changed: function useDeviceOrientation(options?: ConfigurableWindow): { isSupported: boolean; isAbsolute: Ref<boolean>; alpha: Ref<number | null>; beta: Ref<number | null>; gamma: Ref<number | null> } → function useDeviceOrientation(options?: ConfigurableWindow): { isSupported: Ref<boolean>; isAbsolute: Ref<boolean>; alpha: Ref<number | null>; beta: Ref<number | null>; gamma: Ref<number | null> }
  • changed: function useDisplayMedia(options?: UseDisplayMediaOptions): { isSupported: boolean; stream: Ref<MediaStream | undefined>; start: () => Promise<MediaStream | undefined>; stop: () => void; enabled: Ref<boolean> } → function useDisplayMedia(options?: UseDisplayMediaOptions): { isSupported: Ref<boolean>; stream: Ref<MediaStream | undefined>; start: () => Promise<MediaStream | undefined>; stop: () => void; enabled: Ref<boolean> }
  • changed: function useDocumentVisibility({ document }?: ConfigurableDocument): Ref<Document['visibilityState']> → function useDocumentVisibility({ document }?: ConfigurableDocument): Ref<DocumentVisibilityState>
  • changed: function useDraggable(target: MaybeRef<HTMLElement | SVGElement | null | undefined>, options?: UseDraggableOptions): { position: Ref<Position>; isDragging: vue_demi.ComputedRef<boolean>; style: vue_demi.ComputedRef<string>; x: Ref<number>; y: Ref<number> } → function useDraggable(target: MaybeComputedRef<HTMLElement | SVGElement | null | undefined>, options?: UseDraggableOptions): { position: vue_demi.Ref<{ x: number; y: number }>; isDragging: vue_demi.ComputedRef<boolean>; style: vue_demi.ComputedRef<string>; x: vue_demi.Ref<number>; y: vue_demi.Ref<number> }
  • changed: function useDropZone(target: MaybeRef<HTMLElement | null | undefined>, onDrop: (files: File[] | null) => void): UseDropZoneReturn → function useDropZone(target: MaybeComputedRef<HTMLElement | null | undefined>, onDrop?: (files: File[] | null) => void): UseDropZoneReturn
  • changed: function useElementBounding(target: MaybeElementRef, options?: UseElementBoundingOptions): { height: vue_demi.Ref<number>; bottom: vue_demi.Ref<number>; left: vue_demi.Ref<number>; right: vue_demi.Ref<number>; top: vue_demi.Ref<number>; width: vue_demi.Ref<number>; x: vue_demi.Ref<number>; y: vue_demi.Ref<number>; update: () => void } → function useElementBounding(target: MaybeComputedElementRef, options?: UseElementBoundingOptions): { height: vue_demi.Ref<number>; bottom: vue_demi.Ref<number>; left: vue_demi.Ref<number>; right: vue_demi.Ref<number>; top: vue_demi.Ref<number>; width: vue_demi.Ref<number>; x: vue_demi.Ref<number>; y: vue_demi.Ref<number>; update: () => void }
  • changed: function useElementByPoint(options: UseElementByPointOptions): { isActive: vue_demi.Ref<boolean>; pause: _vueuse_shared.Fn; resume: _vueuse_shared.Fn; element: vue_demi.Ref<HTMLElement | null> } → function useElementByPoint(options: UseElementByPointOptions): { isActive: Readonly<vue_demi.Ref<boolean>>; pause: _vueuse_shared.Fn; resume: _vueuse_shared.Fn; element: vue_demi.Ref<HTMLElement | null> }
  • changed: function useElementHover(el: MaybeRef<EventTarget>): Ref<boolean> → function useElementHover(el: MaybeComputedRef<EventTarget | null | undefined>, options?: UseElementHoverOptions): Ref<boolean>
  • changed: function useElementSize(target: MaybeElementRef, initialSize?: ElementSize, options?: ResizeObserverOptions): { width: vue_demi.Ref<number>; height: vue_demi.Ref<number> } → function useElementSize(target: MaybeComputedElementRef, initialSize?: ElementSize, options?: UseResizeObserverOptions): { width: vue_demi.Ref<number>; height: vue_demi.Ref<number> }
  • changed: function useElementVisibility(element: MaybeRef<Element | null | undefined>, { window, scrollTarget }?: VisibilityScrollTargetOptions): vue_demi.Ref<boolean> → function useElementVisibility(element: MaybeComputedElementRef, { window, scrollTarget }?: UseElementVisibilityOptions): vue_demi.Ref<boolean>
  • changed: function useEventListener<E extends keyof DocumentEventMap>(target: Document, event: E, listener: (this: Document, ev: DocumentEventMap[E]) => any, options?: boolean | AddEventListenerOptions): Fn → function useEventListener<E extends keyof DocumentEventMap>(target: DocumentOrShadowRoot, event: Arrayable<E>, listener: Arrayable<(this: Document, ev: DocumentEventMap[E]) => any>, options?: MaybeComputedRef<boolean | AddEventListenerOptions>): Fn
  • changed: function useEventListener<E extends keyof WindowEventMap>(event: E, listener: (this: Window, ev: WindowEventMap[E]) => any, options?: boolean | AddEventListenerOptions): Fn → function useEventListener<E extends keyof WindowEventMap>(event: Arrayable<E>, listener: Arrayable<(this: Window, ev: WindowEventMap[E]) => any>, options?: MaybeComputedRef<boolean | AddEventListenerOptions>): Fn
  • changed: function useEventListener<E extends keyof WindowEventMap>(target: Window, event: E, listener: (this: Window, ev: WindowEventMap[E]) => any, options?: boolean | AddEventListenerOptions): Fn → function useEventListener<E extends keyof WindowEventMap>(target: Window, event: Arrayable<E>, listener: Arrayable<(this: Window, ev: WindowEventMap[E]) => any>, options?: MaybeComputedRef<boolean | AddEventListenerOptions>): Fn
  • changed: function useEventListener<EventType = Event>(target: MaybeRef<EventTarget | null | undefined>, event: string, listener: GeneralEventListener<EventType>, options?: boolean | AddEventListenerOptions): Fn → function useEventListener<EventType = Event>(target: MaybeComputedRef<EventTarget | null | undefined>, event: Arrayable<string>, listener: Arrayable<GeneralEventListener<EventType>>, options?: MaybeComputedRef<boolean | AddEventListenerOptions>): Fn
  • changed: function useEventListener<Names extends string, EventType = Event>(target: InferEventTarget<Names>, event: Names, listener: GeneralEventListener<EventType>, options?: boolean | AddEventListenerOptions): Fn → function useEventListener<Names extends string, EventType = Event>(target: InferEventTarget<Names>, event: Arrayable<Names>, listener: Arrayable<GeneralEventListener<EventType>>, options?: MaybeComputedRef<boolean | AddEventListenerOptions>): Fn
  • changed: function useEyeDropper(options?: UseEyeDropperOptions): { isSupported: boolean; sRGBHex: vue_demi.Ref<string>; open: (openOptions?: EyeDropperOpenOptions) => Promise<{ sRGBHex: string } | undefined> } → function useEyeDropper(options?: UseEyeDropperOptions): { isSupported: vue_demi.Ref<boolean>; sRGBHex: vue_demi.Ref<string>; open: (openOptions?: EyeDropperOpenOptions) => Promise<{ sRGBHex: string } | undefined> }
  • changed: function useFavicon(newIcon?: MaybeRef<string | null | undefined>, options?: FaviconOptions): vue_demi.Ref<string | null | undefined> → function useFavicon(newIcon: MaybeReadonlyRef<string | null | undefined>, options?: UseFaviconOptions): ComputedRef<string | null | undefined>
  • changed: function useFetch<T>(url: MaybeRef<string>): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>> → function useFetch<T>(url: MaybeComputedRef<string>): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
  • changed: function useFetch<T>(url: MaybeRef<string>, options: RequestInit, useFetchOptions?: UseFetchOptions): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>> → function useFetch<T>(url: MaybeComputedRef<string>, options: RequestInit, useFetchOptions?: UseFetchOptions): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
  • changed: function useFetch<T>(url: MaybeRef<string>, useFetchOptions: UseFetchOptions): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>> → function useFetch<T>(url: MaybeComputedRef<string>, useFetchOptions: UseFetchOptions): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
  • changed: function useFocusWithin(target: MaybeElementRef, options?: ConfigurableWindow): FocusWithinReturn → function useFocusWithin(target: MaybeElementRef, options?: ConfigurableWindow): UseFocusWithinReturn
  • changed: function useFullscreen(target?: MaybeElementRef, options?: UseFullscreenOptions): { isSupported: boolean; isFullscreen: vue_demi.Ref<boolean>; enter: () => Promise<void>; exit: () => Promise<void>; toggle: () => Promise<void> } → function useFullscreen(target?: MaybeElementRef, options?: UseFullscreenOptions): { isSupported: vue_demi.Ref<boolean>; isFullscreen: vue_demi.Ref<boolean>; enter: () => Promise<void>; exit: () => Promise<void>; toggle: () => Promise<void> }
  • changed: function useGamepad(options?: UseGamepadOptions): { isSupported: boolean | undefined; onConnected: _vueuse_shared.EventHookOn<number>; onDisconnected: _vueuse_shared.EventHookOn<number>; gamepads: Ref<{ readonly axes: readonly number[]; readonly buttons: readonly { readonly pressed: boolean; readonly touched: boolean; readonly value: number }[]; readonly connected: boolean; readonly hapticActuato… → function useGamepad(options?: UseGamepadOptions): { isSupported: Ref<boolean>; onConnected: _vueuse_shared.EventHookOn<number>; onDisconnected: _vueuse_shared.EventHookOn<number>; gamepads: Ref<{ readonly axes: readonly number[]; readonly buttons: readonly { readonly pressed: boolean; readonly touched: boolean; readonly value: number }[]; readonly connected: boolean; readonly hapticActuators: rea…
  • changed: 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> } → function useGeolocation(options?: UseGeolocationOptions): { isSupported: Ref<boolean>; 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>; resume: () => void; pause: () => void }
  • changed: function useIdle(timeout?: number, options?: IdleOptions): UseIdleReturn → function useIdle(timeout?: number, options?: UseIdleOptions): UseIdleReturn
  • changed: function useInfiniteScroll(element: MaybeRef<HTMLElement | SVGElement | Window | Document | null | undefined>, onLoadMore: (state: UnwrapNestedRefs<ReturnType<typeof useScroll>>) => void | Promise<void>, options?: UseInfiniteScrollOptions): void → function useInfiniteScroll(element: MaybeComputedRef<HTMLElement | SVGElement | Window | Document | null | undefined>, onLoadMore: (state: UnwrapNestedRefs<ReturnType<typeof useScroll>>) => void | Promise<void>, options?: UseInfiniteScrollOptions): void
  • changed: function useIntersectionObserver(target: MaybeElementRef, callback: IntersectionObserverCallback, options?: IntersectionObserverOptions): { isSupported: boolean | undefined; stop: () => void } → function useIntersectionObserver(target: MaybeElementRef, callback: IntersectionObserverCallback, options?: UseIntersectionObserverOptions): { isSupported: vue_demi.Ref<boolean>; stop: () => void }
  • changed: function useKeyModifier<Initial extends boolean | null>(modifier: KeyModifier, options?: ModifierOptions<Initial>): Ref<Initial extends boolean ? boolean : boolean | null> → function useKeyModifier<Initial extends boolean | null>(modifier: KeyModifier, options?: UseModifierOptions<Initial>): UseKeyModifierReturn<Initial>
  • changed: function useLocalStorage(key: string, initialValue: MaybeRef<boolean>, options?: StorageOptions<boolean>): RemovableRef<boolean> → function useLocalStorage(key: string, initialValue: MaybeComputedRef<boolean>, options?: UseStorageOptions<boolean>): RemovableRef<boolean>
  • changed: function useLocalStorage(key: string, initialValue: MaybeRef<number>, options?: StorageOptions<number>): RemovableRef<number> → function useLocalStorage(key: string, initialValue: MaybeComputedRef<number>, options?: UseStorageOptions<number>): RemovableRef<number>
  • changed: function useLocalStorage(key: string, initialValue: MaybeRef<string>, options?: StorageOptions<string>): RemovableRef<string> → function useLocalStorage(key: string, initialValue: MaybeComputedRef<string>, options?: UseStorageOptions<string>): RemovableRef<string>
  • changed: function useLocalStorage<T = unknown>(key: string, initialValue: MaybeRef<null>, options?: StorageOptions<T>): RemovableRef<T> → function useLocalStorage<T = unknown>(key: string, initialValue: MaybeComputedRef<null>, options?: UseStorageOptions<T>): RemovableRef<T>
  • changed: function useLocalStorage<T>(key: string, initialValue: MaybeRef<T>, options?: StorageOptions<T>): RemovableRef<T> → function useLocalStorage<T>(key: string, initialValue: MaybeComputedRef<T>, options?: UseStorageOptions<T>): RemovableRef<T>
  • changed: function useMagicKeys(options: UseMagicKeysOptions<true>): MagicKeys<true> → function useMagicKeys(options: UseMagicKeysOptions<true>): UseMagicKeysReturn<true>
  • changed: function useMagicKeys(options?: UseMagicKeysOptions<false>): MagicKeys<false> → function useMagicKeys(options?: UseMagicKeysOptions<false>): UseMagicKeysReturn<false>
  • changed: function useMediaQuery(query: string, options?: ConfigurableWindow): vue_demi.Ref<boolean> → function useMediaQuery(query: MaybeComputedRef<string>, options?: ConfigurableWindow): vue_demi.Ref<boolean>
  • changed: function useMemoize<Result, Args extends unknown[]>(resolver: (...args: Args) => Result, options?: { getKey?: (...args: Args) => string; cache?: UseMemoizeCache<CacheKey, Result> }): UseMemoizedFn<Result, Args> → function useMemoize<Result, Args extends unknown[]>(resolver: (...args: Args) => Result, options?: UseMemoizeOptions<Result, Args>): UseMemoizeReturn<Result, Args>
  • changed: function useMemory(options?: MemoryOptions): { isSupported: boolean; memory: vue_demi.Ref<MemoryInfo | undefined> } → function useMemory(options?: UseMemoryOptions): { isSupported: vue_demi.Ref<boolean>; memory: vue_demi.Ref<MemoryInfo | undefined> }
  • changed: function useMouse(options?: MouseOptions): { x: vue_demi.Ref<number>; y: vue_demi.Ref<number>; sourceType: vue_demi.Ref<MouseSourceType> } → function useMouse(options?: UseMouseOptions): { x: vue_demi.Ref<number>; y: vue_demi.Ref<number>; sourceType: vue_demi.Ref<MouseSourceType> }
  • changed: function useMutationObserver(target: MaybeElementRef, callback: MutationCallback, options?: MutationObserverOptions): { isSupported: boolean | undefined; stop: () => void } → function useMutationObserver(target: MaybeElementRef, callback: MutationCallback, options?: UseMutationObserverOptions): { isSupported: vue_demi.Ref<boolean>; stop: () => void }
  • changed: function useParallax(target: MaybeElementRef, options?: ParallaxOptions): ParallaxReturn → function useParallax(target: MaybeElementRef, options?: UseParallaxOptions): UseParallaxReturn
  • changed: function usePointerSwipe(target: MaybeRef<HTMLElement | null | undefined>, options?: PointerSwipeOptions): PointerSwipeReturn → function usePointerSwipe(target: MaybeComputedRef<HTMLElement | null | undefined>, options?: UsePointerSwipeOptions): UsePointerSwipeReturn
  • changed: function useRafFn(fn: Fn, options?: RafFnOptions): Pausable → function useRafFn(fn: (args: UseRafFnCallbackArguments) => void, options?: UseRafFnOptions): Pausable
  • changed: function useResizeObserver(target: MaybeElementRef, callback: ResizeObserverCallback, options?: ResizeObserverOptions): { isSupported: boolean | undefined; stop: () => void } → function useResizeObserver(target: MaybeComputedElementRef, callback: ResizeObserverCallback, options?: UseResizeObserverOptions): { isSupported: vue_demi.Ref<boolean>; stop: () => void }
  • changed: 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 } → function useScriptTag(src: MaybeComputedRef<string>, onLoaded?: (el: HTMLScriptElement) => void, options?: UseScriptTagOptions): { scriptTag: vue_demi.Ref<HTMLScriptElement | null>; load: (waitForScriptLoad?: boolean) => Promise<HTMLScriptElement | boolean>; unload: () => void }
  • changed: function useScroll(element: MaybeRef<HTMLElement | SVGElement | Window | Document | null | undefined>, options?: UseScrollOptions): { x: vue_demi.Ref<number>; y: vue_demi.Ref<number>; isScrolling: vue_demi.Ref<boolean>; arrivedState: { left: boolean; right: boolean; top: boolean; bottom: boolean }; directions: { left: boolean; right: boolean; top: boolean; bottom: boolean } } → function useScroll(element: MaybeComputedRef<HTMLElement | SVGElement | Window | Document | null | undefined>, options?: UseScrollOptions): { x: vue_demi.WritableComputedRef<number>; y: vue_demi.WritableComputedRef<number>; isScrolling: vue_demi.Ref<boolean>; arrivedState: { left: boolean; right: boolean; top: boolean; bottom: boolean }; directions: { left: boolean; right: boolean; top: boolean;…
  • changed: function useScrollLock(element: MaybeRef<HTMLElement | SVGElement | Window | Document | null | undefined>, initialState?: boolean): vue_demi.WritableComputedRef<boolean> → function useScrollLock(element: MaybeComputedRef<HTMLElement | SVGElement | Window | Document | null | undefined>, initialState?: boolean): vue_demi.WritableComputedRef<boolean>
  • changed: function useSessionStorage(key: string, initialValue: MaybeRef<boolean>, options?: StorageOptions<boolean>): RemovableRef<boolean> → function useSessionStorage(key: string, initialValue: MaybeComputedRef<boolean>, options?: UseStorageOptions<boolean>): RemovableRef<boolean>
  • changed: function useSessionStorage(key: string, initialValue: MaybeRef<number>, options?: StorageOptions<number>): RemovableRef<number> → function useSessionStorage(key: string, initialValue: MaybeComputedRef<number>, options?: UseStorageOptions<number>): RemovableRef<number>
  • changed: function useSessionStorage(key: string, initialValue: MaybeRef<string>, options?: StorageOptions<string>): RemovableRef<string> → function useSessionStorage(key: string, initialValue: MaybeComputedRef<string>, options?: UseStorageOptions<string>): RemovableRef<string>
  • changed: function useSessionStorage<T = unknown>(key: string, initialValue: MaybeRef<null>, options?: StorageOptions<T>): RemovableRef<T> → function useSessionStorage<T = unknown>(key: string, initialValue: MaybeComputedRef<null>, options?: UseStorageOptions<T>): RemovableRef<T>
  • changed: function useSessionStorage<T>(key: string, initialValue: MaybeRef<T>, options?: StorageOptions<T>): RemovableRef<T> → function useSessionStorage<T>(key: string, initialValue: MaybeComputedRef<T>, options?: UseStorageOptions<T>): RemovableRef<T>
  • changed: function useShare(shareOptions?: MaybeRef<ShareOptions>, options?: ConfigurableNavigator): { isSupported: boolean; share: (overrideOptions?: MaybeRef<ShareOptions>) => Promise<void> } → function useShare(shareOptions?: MaybeComputedRef<UseShareOptions>, options?: ConfigurableNavigator): { isSupported: vue.Ref<boolean>; share: (overrideOptions?: MaybeComputedRef<UseShareOptions>) => Promise<void> }
  • changed: 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 } → function useSpeechRecognition(options?: UseSpeechRecognitionOptions): { isSupported: Ref<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 }
  • changed: function useSpeechSynthesis(text: MaybeRef<string>, options?: SpeechSynthesisOptions): { isSupported: boolean; isPlaying: Ref<boolean>; status: Ref<Status>; voiceInfo: { lang: string; name: string }; utterance: vue_demi.ComputedRef<SpeechSynthesisUtterance>; error: Ref<SpeechSynthesisErrorEvent | undefined>; toggle: (value?: boolean) => void; speak: () => void } → function useSpeechSynthesis(text: MaybeComputedRef<string>, options?: UseSpeechSynthesisOptions): { isSupported: Ref<boolean>; isPlaying: Ref<boolean>; status: Ref<UseSpeechSynthesisStatus>; utterance: vue_demi.ComputedRef<SpeechSynthesisUtterance>; error: Ref<SpeechSynthesisErrorEvent | undefined>; stop: () => void; toggle: (value?: boolean) => void; speak: () => void }
  • changed: function useStorage(key: string, initialValue: MaybeRef<boolean>, storage?: StorageLike, options?: StorageOptions<boolean>): RemovableRef<boolean> → function useStorage(key: string, defaults: MaybeComputedRef<boolean>, storage?: StorageLike, options?: UseStorageOptions<boolean>): RemovableRef<boolean>
  • changed: function useStorage(key: string, initialValue: MaybeRef<number>, storage?: StorageLike, options?: StorageOptions<number>): RemovableRef<number> → function useStorage(key: string, defaults: MaybeComputedRef<number>, storage?: StorageLike, options?: UseStorageOptions<number>): RemovableRef<number>
  • changed: function useStorage(key: string, initialValue: MaybeRef<string>, storage?: StorageLike, options?: StorageOptions<string>): RemovableRef<string> → function useStorage(key: string, defaults: MaybeComputedRef<string>, storage?: StorageLike, options?: UseStorageOptions<string>): RemovableRef<string>
  • changed: function useStorage<T = unknown>(key: string, initialValue: MaybeRef<null>, storage?: StorageLike, options?: StorageOptions<T>): RemovableRef<T> → function useStorage<T = unknown>(key: string, defaults: MaybeComputedRef<null>, storage?: StorageLike, options?: UseStorageOptions<T>): RemovableRef<T>
  • changed: function useStorage<T>(key: string, initialValue: MaybeRef<T>, storage?: StorageLike, options?: StorageOptions<T>): RemovableRef<T> → function useStorage<T>(key: string, defaults: MaybeComputedRef<T>, storage?: StorageLike, options?: UseStorageOptions<T>): RemovableRef<T>
  • changed: function useStorageAsync(key: string, initialValue: MaybeRef<boolean>, storage?: StorageLikeAsync, options?: StorageAsyncOptions<boolean>): RemovableRef<boolean> → function useStorageAsync(key: string, initialValue: MaybeComputedRef<boolean>, storage?: StorageLikeAsync, options?: UseStorageAsyncOptions<boolean>): RemovableRef<boolean>
  • changed: function useStorageAsync(key: string, initialValue: MaybeRef<number>, storage?: StorageLikeAsync, options?: StorageAsyncOptions<number>): RemovableRef<number> → function useStorageAsync(key: string, initialValue: MaybeComputedRef<number>, storage?: StorageLikeAsync, options?: UseStorageAsyncOptions<number>): RemovableRef<number>
  • changed: function useStorageAsync(key: string, initialValue: MaybeRef<string>, storage?: StorageLikeAsync, options?: StorageAsyncOptions<string>): RemovableRef<string> → function useStorageAsync(key: string, initialValue: MaybeComputedRef<string>, storage?: StorageLikeAsync, options?: UseStorageAsyncOptions<string>): RemovableRef<string>
  • changed: function useStorageAsync<T = unknown>(key: string, initialValue: MaybeRef<null>, storage?: StorageLikeAsync, options?: StorageAsyncOptions<T>): RemovableRef<T> → function useStorageAsync<T = unknown>(key: string, initialValue: MaybeComputedRef<null>, storage?: StorageLikeAsync, options?: UseStorageAsyncOptions<T>): RemovableRef<T>
  • changed: function useStorageAsync<T>(key: string, initialValue: MaybeRef<T>, storage?: StorageLikeAsync, options?: StorageAsyncOptions<T>): RemovableRef<T> → function useStorageAsync<T>(key: string, initialValue: MaybeComputedRef<T>, storage?: StorageLikeAsync, options?: UseStorageAsyncOptions<T>): RemovableRef<T>
  • changed: function useSwipe(target: MaybeRef<EventTarget | null | undefined>, options?: SwipeOptions): SwipeReturn → function useSwipe(target: MaybeComputedRef<EventTarget | null | undefined>, options?: UseSwipeOptions): UseSwipeReturn
  • changed: function useThrottledRefHistory<Raw, Serialized = Raw>(source: Ref<Raw>, options?: Omit<UseRefHistoryOptions<Raw, Serialized>, 'eventFilter'> & { throttle?: MaybeRef<number>; trailing?: boolean }): UseRefHistoryReturn<Raw, Serialized> → function useThrottledRefHistory<Raw, Serialized = Raw>(source: Ref<Raw>, options?: UseThrottledRefHistoryOptions<Raw, Serialized>): UseThrottledRefHistoryReturn<Raw, Serialized>
  • changed: function useTimeAgo(time: MaybeRef<Date | number | string>, options: UseTimeAgoOptions<true>): { timeAgo: ComputedRef<string> } & Pausable → function useTimeAgo<UnitNames extends string = UseTimeAgoUnitNamesDefault>(time: MaybeComputedRef<Date | number | string>, options: UseTimeAgoOptions<true, UnitNames>): UseTimeAgoReturn<true>
  • changed: function useTimeAgo(time: MaybeRef<Date | number | string>, options?: UseTimeAgoOptions<false>): ComputedRef<string> → function useTimeAgo<UnitNames extends string = UseTimeAgoUnitNamesDefault>(time: MaybeComputedRef<Date | number | string>, options?: UseTimeAgoOptions<false, UnitNames>): UseTimeAgoReturn<false>
  • changed: function useTimeoutPoll(fn: () => Awaitable<void>, interval: MaybeRef<number>, timeoutPollOptions?: TimeoutFnOptions): Pausable → function useTimeoutPoll(fn: () => Awaitable<void>, interval: MaybeComputedRef<number>, timeoutPollOptions?: UseTimeoutFnOptions): Pausable
  • changed: function useTimestamp(options: TimestampOptions<true>): { timestamp: Ref<number> } & Pausable → function useTimestamp(options: UseTimestampOptions<true>): { timestamp: Ref<number> } & Pausable
  • changed: function useTimestamp(options?: TimestampOptions<false>): Ref<number> → function useTimestamp(options?: UseTimestampOptions<false>): Ref<number>
  • changed: function useTitle(newTitle?: MaybeRef<string | null | undefined>, options?: UseTitleOptions): vue_demi.Ref<string | null | undefined> → function useTitle(newTitle: MaybeReadonlyRef<string | null | undefined>, options?: UseTitleOptions): ComputedRef<string | null | undefined>
  • changed: function useTransition(source: Ref<number>, options?: TransitionOptions): ComputedRef<number> → function useTransition(source: Ref<number>, options?: UseTransitionOptions): ComputedRef<number>
  • changed: function useTransition<T extends MaybeRef<number>[]>(source: [...T], options?: TransitionOptions): ComputedRef<{ [K in keyof T]: number }> → function useTransition<T extends MaybeRef<number>[]>(source: [...T], options?: UseTransitionOptions): ComputedRef<{ [K in keyof T]: number }>
  • changed: function useTransition<T extends Ref<number[]>>(source: T, options?: TransitionOptions): ComputedRef<number[]> → function useTransition<T extends Ref<number[]>>(source: T, options?: UseTransitionOptions): ComputedRef<number[]>
  • changed: 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> } → function useUserMedia(options?: UseUserMediaOptions): { isSupported: Ref<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> }
  • changed: function useVModel<P extends object, K extends keyof P, Name extends string>(props: P, key?: K, emit?: (name: Name, ...args: any[]) => void, options?: VModelOptions<P[K]>): vue_demi.Ref<UnwrapRef<P[K]>> | vue_demi.WritableComputedRef<P[K]> → function useVModel<P extends object, K extends keyof P, Name extends string>(props: P, key?: K, emit?: (name: Name, ...args: any[]) => void, options?: UseVModelOptions<P[K]>): vue_demi.Ref<UnwrapRef<P[K]>> | vue_demi.WritableComputedRef<P[K]>
  • changed: function useVModels<P extends object, Name extends string>(props: P, emit?: (name: Name, ...args: any[]) => void, options?: VModelOptions<any>): ToRefs<P> → function useVModels<P extends object, Name extends string>(props: P, emit?: (name: Name, ...args: any[]) => void, options?: UseVModelOptions<any>): ToRefs<P>
  • changed: function useVibrate(options?: UseVibrateOptions): { isSupported: boolean; pattern: MaybeRef<number | number[]>; intervalControls: Pausable | undefined; vibrate: (pattern?: number | number[]) => void; stop: () => void } → function useVibrate(options?: UseVibrateOptions): { isSupported: vue.Ref<boolean>; pattern: MaybeComputedRef<number | number[]>; intervalControls: Pausable | undefined; vibrate: (pattern?: number | number[]) => void; stop: () => void }
  • changed: function useVirtualList<T = any>(list: MaybeRef<T[]>, options: UseVirtualListOptions): { list: Ref<UseVirtualListItem<T>[]>; scrollTo: (index: number) => void; containerProps: { ref: Ref<any>; onScroll: () => void; style: Partial<CSSStyleDeclaration> }; wrapperProps: vue_demi.ComputedRef<{ style: { width: string; height: string; marginTop: string } }> } → function useVirtualList<T = any>(list: MaybeRef<T[]>, options: UseVirtualListOptions): UseVirtualListReturn<T>
  • changed: function useWebSocket<Data = any>(url: string, options?: WebSocketOptions): WebSocketResult<Data> → function useWebSocket<Data = any>(url: MaybeComputedRef<string | URL | undefined>, options?: UseWebSocketOptions): UseWebSocketReturn<Data>
  • changed: function useWebWorker<Data = any>(url: string, workerOptions?: WorkerOptions, options?: ConfigurableWindow): UseWebWorkerReturn<Data> → function useWebWorker<T = any>(url: string, workerOptions?: WorkerOptions, options?: ConfigurableWindow): UseWebWorkerReturn<T>
  • changed: function useWindowSize(options?: WindowSizeOptions): { width: vue_demi.Ref<number>; height: vue_demi.Ref<number> } → function useWindowSize(options?: UseWindowSizeOptions): { width: vue_demi.Ref<number>; height: vue_demi.Ref<number> }
  • changed: interface MouseInElementOptions extends MouseOptions → interface MouseInElementOptions extends UseMouseOptions
  • changed: interface UseAsyncStateReturn<Data, Shallow extends boolean> → interface UseAsyncStateReturn<Data, Params extends any[], Shallow extends boolean>
  • changed: interface UseColorModeOptions<T extends string = BasicColorSchema> extends StorageOptions<T | BasicColorSchema> → interface UseColorModeOptions<T extends string = BasicColorSchema> extends UseStorageOptions<T | BasicColorSchema>
  • changed: interface UseElementByPointOptions → interface UseElementByPointOptions extends ConfigurableDocument
  • changed: interface UseRefHistoryReturn<Raw, Serialized> → interface UseRefHistoryReturn<Raw, Serialized> extends UseManualRefHistoryReturn<Raw, Serialized>
  • changed: interface UseTimeAgoOptions<Controls extends boolean> → interface UseTimeAgoOptions<Controls extends boolean, UnitNames extends string = UseTimeAgoUnitNamesDefault> extends FormatTimeAgoOptions<UnitNames>
  • changed: method UseFetchReturn.delete(payload?: MaybeRef<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>> → method UseFetchReturn.delete(payload?: MaybeComputedRef<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
  • changed: method UseFetchReturn.head(payload?: MaybeRef<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>> → method UseFetchReturn.head(payload?: MaybeComputedRef<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
  • changed: method UseFetchReturn.options(payload?: MaybeRef<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>> → method UseFetchReturn.options(payload?: MaybeComputedRef<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
  • changed: method UseFetchReturn.patch(payload?: MaybeRef<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>> → method UseFetchReturn.patch(payload?: MaybeComputedRef<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
  • changed: method UseFetchReturn.post(payload?: MaybeRef<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>> → method UseFetchReturn.post(payload?: MaybeComputedRef<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
  • changed: method UseFetchReturn.put(payload?: MaybeRef<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>> → method UseFetchReturn.put(payload?: MaybeComputedRef<unknown>, type?: string): UseFetchReturn<T> & PromiseLike<UseFetchReturn<T>>
  • changed: property AsyncComputedOptions.lazy?: Boolean → property AsyncComputedOptions.lazy?: boolean
  • changed: property CreateFetchOptions.baseUrl?: MaybeRef<string> → property CreateFetchOptions.baseUrl?: MaybeComputedRef<string>
  • changed: property NavigatorLanguageState.isSupported: boolean → property NavigatorLanguageState.isSupported: Ref<boolean>
  • changed: property NetworkState.isSupported: boolean → property NetworkState.isSupported: Ref<boolean>
  • changed: property OnClickOutsideOptions.ignore?: MaybeElementRef[] → property OnClickOutsideOptions.ignore?: (MaybeElementRef | string)[]
  • changed: property UseAsyncStateReturn.execute: (delay?: number, ...args: any[]) => Promise<Data> → property UseAsyncStateReturn.execute: (delay?: number, ...args: Params) => Promise<Data>
  • changed: property UseDevicesListReturn.isSupported: boolean → property UseDevicesListReturn.isSupported: Ref<boolean>
  • changed: property UseDraggableOptions.draggingElement?: MaybeRef<HTMLElement | SVGElement | Window | Document | null | undefined> → property UseDraggableOptions.draggingElement?: MaybeComputedRef<HTMLElement | SVGElement | Window | Document | null | undefined>
  • changed: property UseDraggableOptions.exact?: MaybeRef<boolean> → property UseDraggableOptions.exact?: MaybeComputedRef<boolean>
  • changed: property UseDraggableOptions.initialValue?: MaybeRef<Position> → property UseDraggableOptions.initialValue?: MaybeComputedRef<Position>
  • changed: property UseDraggableOptions.preventDefault?: MaybeRef<boolean> → property UseDraggableOptions.preventDefault?: MaybeComputedRef<boolean>
  • changed: property UseDraggableOptions.stopPropagation?: MaybeRef<boolean> → property UseDraggableOptions.stopPropagation?: MaybeComputedRef<boolean>
  • changed: property UseElementByPointOptions.x: MaybeRef<number> → property UseElementByPointOptions.x: MaybeComputedRef<number>
  • changed: property UseElementByPointOptions.y: MaybeRef<number> → property UseElementByPointOptions.y: MaybeComputedRef<number>
  • changed: property UseFetchOptions.refetch?: MaybeRef<boolean> → property UseFetchOptions.refetch?: MaybeComputedRef<boolean>
  • changed: property UseFileSystemAccessReturn.isSupported: boolean → property UseFileSystemAccessReturn.isSupported: Ref<boolean>
  • changed: property UseMagicKeysOptions.target?: MaybeRef<EventTarget> → property UseMagicKeysOptions.target?: MaybeComputedRef<EventTarget>
  • changed: property UsePermissionReturnWithControls.isSupported: boolean → property UsePermissionReturnWithControls.isSupported: Ref<boolean>
  • changed: property UseVibrateOptions.pattern?: MaybeRef<number[] | number> → property UseVibrateOptions.pattern?: MaybeComputedRef<number[] | number>
  • changed: property UseWebWorkerReturn.worker: Ref<Worker | undefined> → property UseWebWorkerReturn.worker: ShallowRef<Worker | undefined>
  • changed: type KeyFilter = null | undefined | string | string[] | KeyPredicate → type KeyFilter = true | string | string[] | KeyPredicate
  • changed: type UseBreakpointsReturn<K extends string = string> = { greater: (k: K) => Ref<boolean>; smaller(k: K): Ref<boolean>; between(a: K, b: K): Ref<boolean>; isGreater(k: K): boolean; isSmaller(k: K): boolean; isInBetw… → type UseBreakpointsReturn<K extends string = string> = { greater: (k: K) => Ref<boolean>; greaterOrEqual: (k: K) => Ref<boolean>; smaller(k: K): Ref<boolean>; smallerOrEqual: (k: K) => Ref<boolean>; between(a: K, b…
  • changed: type UseFileSystemAccessOptions = ConfigurableWindow & UseFileSystemAccessCommonOptions & { dataType?: MaybeRef<'Text' | 'ArrayBuffer' | 'Blob'> } → type UseFileSystemAccessOptions = ConfigurableWindow & UseFileSystemAccessCommonOptions & { dataType?: MaybeComputedRef<'Text' | 'ArrayBuffer' | 'Blob'> }
  • added: call UseMemoizeReturn(...args: Args): Result
  • added: const breakpointsMasterCss: { '3xs': number; '2xs': number; xs: number; sm: number; md: number; lg: number; xl: number; '2xl': number; '3xl': number; '4xl': number }
  • added: const customStorageEventName = 'vueuse-storage'
  • added: declare global
  • added: function cloneFnJSON<T>(source: T): T
  • added: function formatTimeAgo<UnitNames extends string = UseTimeAgoUnitNamesDefault>(from: Date, options?: FormatTimeAgoOptions<UnitNames>, now?: Date | number): string
  • added: function onKeyStroke(key: KeyFilter, handler: (event: KeyboardEvent) => void, options?: OnKeyStrokeOptions): () => void
  • added: function useCloned<T>(source: MaybeComputedRef<T>, options?: UseClonedOptions): { cloned: vue_demi.Ref<vue_demi.UnwrapRef<T>>; sync: () => void }
  • added: function useFavicon(newIcon?: MaybeRef<string | null | undefined>, options?: UseFaviconOptions): Ref<string | null | undefined>
  • added: function usePointerLock(target?: MaybeElementRef<MaybeHTMLElement>, options?: UsePointerLockOptions): { isSupported: vue_demi.Ref<boolean>; element: vue_demi.Ref<MaybeHTMLElement>; triggerElement: vue_demi.Ref<MaybeHTMLElement>; lock: (e: MaybeElementRef<MaybeHTMLElement> | Event, options?: PointerLockOptions) => Promise<HTMLElement>; unlock: () => Promise<boolean> }
  • added: function usePreferredContrast(options?: ConfigurableWindow): vue_demi.ComputedRef<ContrastType>
  • added: function usePreferredReducedMotion(options?: ConfigurableWindow): vue_demi.ComputedRef<ReducedMotionType>
  • added: function usePrevious<T>(value: MaybeComputedRef<T>): Readonly<Ref<T | undefined>>
  • added: function usePrevious<T>(value: MaybeComputedRef<T>, initialValue: T): Readonly<Ref<T>>
  • added: function useSorted<T = any>(source: MaybeRef<T[]>, compareFn?: UseSortedCompareFn<T>): Ref<T[]>
  • added: function useSorted<T = any>(source: MaybeRef<T[]>, compareFn?: UseSortedCompareFn<T>, options?: Omit<UseSortedOptions<T>, 'compareFn'>): Ref<T[]>
  • added: function useSorted<T = any>(source: MaybeRef<T[]>, options?: UseSortedOptions<T>): Ref<T[]>
  • added: function useSupported(callback: () => unknown, sync?: boolean): Ref<boolean>
  • added: function useTextDirection(options?: UseTextDirectionOptions): vue_demi.WritableComputedRef<UseTextDirectionValue>
  • added: function useTitle(newTitle?: MaybeRef<string | null | undefined>, options?: UseTitleOptions): Ref<string | null | undefined>
  • added: function useWebWorker<T = any>(worker: Worker | WorkerFn): UseWebWorkerReturn<T>
  • added: interface ConfigurableDocumentOrShadowRoot
  • added: interface FormatTimeAgoOptions<UnitNames extends string = UseTimeAgoUnitNamesDefault>
  • added: interface OnKeyStrokeOptions
  • added: interface StorageEventLike
  • added: interface UseActiveElementOptions extends ConfigurableWindow, ConfigurableDocumentOrShadowRoot
  • added: interface UseAsyncStateOptions<Shallow extends boolean, D = any>
  • added: interface UseBluetoothReturn
  • added: interface UseBroadcastChannelReturn<D, P>
  • added: interface UseClipboardOptions<Source> extends ConfigurableNavigator
  • added: interface UseClipboardReturn<Optional>
  • added: interface UseClonedOptions<T = any> extends WatchOptions
  • added: interface UseClonedReturn<T>
  • added: interface UseCycleListReturn<T>
  • added: interface UseElementHoverOptions extends ConfigurableWindow
  • added: interface UseElementVisibilityOptions extends ConfigurableWindow
  • added: interface UseFaviconOptions extends ConfigurableDocument
  • added: interface UseFocusWithinReturn
  • added: interface UseGeolocationOptions extends Partial<PositionOptions>, ConfigurableNavigator
  • added: interface UseHorizontalVirtualListOptions extends UseVirtualListOptionsBase
  • added: interface UseIdleOptions extends ConfigurableWindow, ConfigurableEventFilter
  • added: interface UseIntersectionObserverOptions extends ConfigurableWindow
  • added: interface UseMemoizeOptions<Result, Args extends unknown[]>
  • added: interface UseMemoizeReturn<Result, Args extends unknown[]>
  • added: interface UseMemoryOptions extends UseIntervalFnOptions
  • added: interface UseModifierOptions<Initial> extends ConfigurableDocument
  • added: interface UseMouseOptions extends ConfigurableWindow, ConfigurableEventFilter
  • added: interface UseMutationObserverOptions extends MutationObserverInit, ConfigurableWindow
  • added: interface UseParallaxOptions extends ConfigurableWindow
  • added: interface UseParallaxReturn
  • added: interface UsePointerLockOptions extends ConfigurableDocument
  • added: interface UsePointerSwipeOptions
  • added: interface UsePointerSwipeReturn
  • added: interface UseRafFnCallbackArguments
  • added: interface UseRafFnOptions extends ConfigurableWindow
  • added: interface UseResizeObserverOptions extends ConfigurableWindow
  • added: interface UseShareOptions
  • added: interface UseSortedOptions<T = any>
  • added: interface UseSpeechRecognitionOptions extends ConfigurableWindow
  • added: interface UseSpeechSynthesisOptions extends ConfigurableWindow
  • added: interface UseStorageAsyncOptions<T> extends Omit<UseStorageOptions<T>, 'serializer'>
  • added: interface UseStorageOptions<T> extends ConfigurableEventFilter, ConfigurableWindow, ConfigurableFlush
  • added: interface UseSwipeOptions extends ConfigurableWindow
  • added: interface UseSwipeReturn
  • added: interface UseTextDirectionOptions extends ConfigurableDocument
  • added: interface UseTimeAgoMessagesBuiltIn
  • added: interface UseTimeAgoUnit<Unit extends string = UseTimeAgoUnitNamesDefault>
  • added: interface UseTimestampOptions<Controls extends boolean>
  • added: interface UseTransitionOptions
  • added: interface UseVModelOptions<T>
  • added: interface UseVerticalVirtualListOptions extends UseVirtualListOptionsBase
  • added: interface UseVirtualListOptionsBase
  • added: interface UseVirtualListReturn<T>
  • added: interface UseWebSocketOptions
  • added: interface UseWebSocketReturn<T>
  • added: interface UseWebWorkerOptions extends ConfigurableWindow
  • added: interface UseWindowSizeOptions extends ConfigurableWindow
  • added: method UseMemoizeReturn.clear(): void
  • added: method UseMemoizeReturn.delete(...args: Args): void
  • added: method UseMemoizeReturn.generateKey(...args: Args): CacheKey
  • added: method UseMemoizeReturn.load(...args: Args): Result
  • added: property AsyncComputedOptions.shallow?: boolean
  • added: property ConfigurableDocumentOrShadowRoot.document?: DocumentOrShadowRoot
  • added: property CreateFetchOptions.combination?: Combination
  • added: property FormatTimeAgoOptions.fullDateFormatter?: (date: Date) => string
  • added: property FormatTimeAgoOptions.max?: UnitNames | number
  • added: property FormatTimeAgoOptions.messages?: UseTimeAgoMessages<UnitNames>
  • added: property FormatTimeAgoOptions.rounding?: 'round' | 'ceil' | 'floor' | number
  • added: property FormatTimeAgoOptions.showSecond?: boolean
  • added: property FormatTimeAgoOptions.units?: UseTimeAgoUnit<UseTimeAgoUnitNamesDefault>[]
  • added: property OnKeyStrokeOptions.eventName?: KeyStrokeEventName
  • added: property OnKeyStrokeOptions.passive?: boolean
  • added: property OnKeyStrokeOptions.target?: MaybeComputedRef<EventTarget | null | undefined>
  • added: property StorageEventLike.key: StorageEvent['key']
  • added: property StorageEventLike.newValue: StorageEvent['newValue']
  • added: property StorageEventLike.oldValue: StorageEvent['oldValue']
  • added: property StorageEventLike.storageArea: StorageLike | null
  • added: property UseAsyncStateOptions.delay?: number
  • added: property UseAsyncStateOptions.immediate?: boolean
  • added: property UseAsyncStateOptions.onError?: (e: unknown) => void
  • added: property UseAsyncStateOptions.onSuccess?: (data: D) => void
  • added: property UseAsyncStateOptions.resetOnExecute?: boolean
  • added: property UseAsyncStateOptions.shallow?: Shallow
  • added: property UseAsyncStateOptions.throwError?: boolean
  • added: property UseBluetoothReturn.device: Ref<BluetoothDevice | undefined>
  • added: property UseBluetoothReturn.error: Ref<unknown | null>
  • added: property UseBluetoothReturn.isConnected: ComputedRef<boolean>
  • added: property UseBluetoothReturn.isSupported: Ref<boolean>
  • added: property UseBluetoothReturn.requestDevice: () => Promise<void>
  • added: property UseBluetoothReturn.server: Ref<BluetoothRemoteGATTServer | undefined>
  • added: property UseBroadcastChannelReturn.channel: Ref<BroadcastChannel | undefined>
  • added: property UseBroadcastChannelReturn.close: () => void
  • added: property UseBroadcastChannelReturn.data: Ref<D>
  • added: property UseBroadcastChannelReturn.error: Ref<Event | null>
  • added: property UseBroadcastChannelReturn.isClosed: Ref<boolean>
  • added: property UseBroadcastChannelReturn.isSupported: Ref<boolean>
  • added: property UseBroadcastChannelReturn.post: (data: P) => void
  • added: property UseClipboardOptions.copiedDuring?: number
  • added: property UseClipboardOptions.legacy?: boolean
  • added: property UseClipboardOptions.read?: boolean
  • added: property UseClipboardOptions.source?: Source
  • added: property UseClipboardReturn.copied: ComputedRef<boolean>
  • added: property UseClipboardReturn.copy: Optional extends true ? (text?: string) => Promise<void> : (text: string) => Promise<void>
  • added: property UseClipboardReturn.isSupported: Ref<boolean>
  • added: property UseClipboardReturn.text: ComputedRef<string>
  • added: property UseClonedOptions.clone?: (source: T) => T
  • added: property UseClonedOptions.manual?: boolean
  • added: property UseClonedReturn.cloned: ComputedRef<T>
  • added: property UseClonedReturn.sync: () => void
  • added: property UseColorModeOptions.initialValue?: T | BasicColorSchema
  • added: property UseCycleListReturn.index: Ref<number>
  • added: property UseCycleListReturn.next: (n?: number) => T
  • added: property UseCycleListReturn.prev: (n?: number) => T
  • added: property UseCycleListReturn.state: Ref<T>
  • added: property UseDraggableOptions.handle?: MaybeComputedRef<HTMLElement | SVGElement | null | undefined>
  • added: property UseElementHoverOptions.delayEnter?: number
  • added: property UseElementHoverOptions.delayLeave?: number
  • added: property UseElementVisibilityOptions.scrollTarget?: MaybeComputedRef<HTMLElement | undefined | null>
  • added: property UseFaviconOptions.baseUrl?: string
  • added: property UseFaviconOptions.rel?: string
  • added: property UseFocusWithinReturn.focused: ComputedRef<boolean>
  • added: property UseGeolocationOptions.immediate?: boolean
  • added: property UseHorizontalVirtualListOptions.itemWidth: UseVirtualListItemSize
  • added: property UseIdleOptions.events?: WindowEventName[]
  • added: property UseIdleOptions.initialState?: boolean
  • added: property UseIdleOptions.listenForVisibilityChange?: boolean
  • added: property UseIntersectionObserverOptions.root?: MaybeElementRef
  • added: property UseIntersectionObserverOptions.rootMargin?: string
  • added: property UseIntersectionObserverOptions.threshold?: number | number[]
  • added: property UseManualRefHistoryReturn.clear: () => void
  • added: property UseManualRefHistoryReturn.commit: () => void
  • added: property UseManualRefHistoryReturn.redo: () => void
  • added: property UseManualRefHistoryReturn.reset: () => void
  • added: property UseManualRefHistoryReturn.undo: () => void
  • added: property UseMemoizeOptions.cache?: UseMemoizeCache<CacheKey, Result>
  • added: property UseMemoizeOptions.getKey?: (...args: Args) => string | number
  • added: property UseMemoizeReturn.cache: UseMemoizeCache<CacheKey, Result>
  • added: property UseMemoryOptions.interval?: number
  • added: property UseModifierOptions.events?: WindowEventName[]
  • added: property UseModifierOptions.initial?: Initial
  • added: property UseMouseOptions.initialValue?: Position
  • added: property UseMouseOptions.resetOnTouchEnds?: boolean
  • added: property UseMouseOptions.touch?: boolean
  • added: property UseMouseOptions.type?: 'page' | 'client' | 'movement'
  • added: property UseParallaxOptions.deviceOrientationRollAdjust?: (i: number) => number
  • added: property UseParallaxOptions.deviceOrientationTiltAdjust?: (i: number) => number
  • added: property UseParallaxOptions.mouseRollAdjust?: (i: number) => number
  • added: property UseParallaxOptions.mouseTiltAdjust?: (i: number) => number
  • added: property UseParallaxReturn.roll: ComputedRef<number>
  • added: property UseParallaxReturn.source: ComputedRef<'deviceOrientation' | 'mouse'>
  • added: property UseParallaxReturn.tilt: ComputedRef<number>
  • added: property UsePointerLockOptions.pointerLockOptions?: PointerLockOptions
  • added: property UsePointerSwipeOptions.onSwipe?: (e: PointerEvent) => void
  • added: property UsePointerSwipeOptions.onSwipeEnd?: (e: PointerEvent, direction: SwipeDirection) => void
  • added: property UsePointerSwipeOptions.onSwipeStart?: (e: PointerEvent) => void
  • added: property UsePointerSwipeOptions.pointerTypes?: PointerType[]
  • added: property UsePointerSwipeOptions.threshold?: number
  • added: property UsePointerSwipeReturn.direction: Readonly<Ref<SwipeDirection | null>>
  • added: property UsePointerSwipeReturn.distanceX: Readonly<Ref<number>>
  • added: property UsePointerSwipeReturn.distanceY: Readonly<Ref<number>>
  • added: property UsePointerSwipeReturn.stop: () => void
  • added: property UseRafFnCallbackArguments.delta: number
  • added: property UseRafFnCallbackArguments.timestamp: DOMHighResTimeStamp
  • added: property UseRafFnOptions.immediate?: boolean
  • added: property UseResizeObserverOptions.box?: ResizeObserverBoxOptions
  • added: property UseScrollOptions.behavior?: MaybeComputedRef<ScrollBehavior>
  • added: property UseShareOptions.files?: File[]
  • added: property UseShareOptions.text?: string
  • added: property UseShareOptions.title?: string
  • added: property UseShareOptions.url?: string
  • added: property UseSortedOptions.compareFn?: UseSortedCompareFn<T>
  • added: property UseSortedOptions.dirty?: boolean
  • added: property UseSortedOptions.sortFn?: UseSortedFn<T>
  • added: property UseSpeechRecognitionOptions.continuous?: boolean
  • added: property UseSpeechRecognitionOptions.interimResults?: boolean
  • added: property UseSpeechRecognitionOptions.lang?: MaybeComputedRef<string>
  • added: property UseSpeechSynthesisOptions.lang?: MaybeComputedRef<string>
  • added: property UseSpeechSynthesisOptions.pitch?: SpeechSynthesisUtterance['pitch']
  • added: property UseSpeechSynthesisOptions.rate?: SpeechSynthesisUtterance['rate']
  • added: property UseSpeechSynthesisOptions.voice?: MaybeRef<SpeechSynthesisVoice>
  • added: property UseSpeechSynthesisOptions.volume?: SpeechSynthesisUtterance['volume']
  • added: property UseStorageAsyncOptions.serializer?: SerializerAsync<T>
  • added: property UseStorageOptions.deep?: boolean
  • added: property UseStorageOptions.listenToStorageChanges?: boolean
  • added: property UseStorageOptions.mergeDefaults?: boolean | ((storageValue: T, defaults: T) => T)
  • added: property UseStorageOptions.onError?: (error: unknown) => void
  • added: property UseStorageOptions.serializer?: Serializer<T>
  • added: property UseStorageOptions.shallow?: boolean
  • added: property UseStorageOptions.writeDefaults?: boolean
  • added: property UseSwipeOptions.onSwipe?: (e: TouchEvent) => void
  • added: property UseSwipeOptions.onSwipeEnd?: (e: TouchEvent, direction: SwipeDirection) => void
  • added: property UseSwipeOptions.onSwipeStart?: (e: TouchEvent) => void
  • added: property UseSwipeOptions.passive?: boolean
  • added: property UseSwipeOptions.threshold?: number
  • added: property UseSwipeReturn.coordsEnd: Readonly<Position>
  • added: property UseSwipeReturn.coordsStart: Readonly<Position>
  • added: property UseSwipeReturn.direction: ComputedRef<SwipeDirection | null>
  • added: property UseSwipeReturn.isPassiveEventSupported: boolean
  • added: property UseSwipeReturn.isSwiping: Ref<boolean>
  • added: property UseSwipeReturn.lengthX: ComputedRef<number>
  • added: property UseSwipeReturn.lengthY: ComputedRef<number>
  • added: property UseSwipeReturn.stop: () => void
  • added: property UseTextDirectionOptions.initialValue?: UseTextDirectionValue
  • added: property UseTextDirectionOptions.observe?: boolean
  • added: property UseTextDirectionOptions.selector?: string
  • added: property UseTimeAgoMessagesBuiltIn.future: string | UseTimeAgoFormatter<string>
  • added: property UseTimeAgoMessagesBuiltIn.invalid: string
  • added: property UseTimeAgoMessagesBuiltIn.justNow: string
  • added: property UseTimeAgoMessagesBuiltIn.past: string | UseTimeAgoFormatter<string>
  • added: property UseTimeAgoUnit.max: number
  • added: property UseTimeAgoUnit.name: Unit
  • added: property UseTimeAgoUnit.value: number
  • added: property UseTimestampOptions.callback?: (timestamp: number) => void
  • added: property UseTimestampOptions.controls?: Controls
  • added: property UseTimestampOptions.immediate?: boolean
  • added: property UseTimestampOptions.interval?: 'requestAnimationFrame' | number
  • added: property UseTimestampOptions.offset?: number
  • added: property UseTransitionOptions.delay?: MaybeRef<number>
  • added: property UseTransitionOptions.disabled?: MaybeRef<boolean>
  • added: property UseTransitionOptions.duration?: MaybeRef<number>
  • added: property UseTransitionOptions.onFinished?: () => void
  • added: property UseTransitionOptions.onStarted?: () => void
  • added: property UseTransitionOptions.transition?: MaybeRef<EasingFunction | CubicBezierPoints>
  • added: property UseUrlSearchParamsOptions.write?: boolean
  • added: property UseVModelOptions.clone?: boolean | CloneFn<T>
  • added: property UseVModelOptions.deep?: boolean
  • added: property UseVModelOptions.defaultValue?: T
  • added: property UseVModelOptions.eventName?: string
  • added: property UseVModelOptions.passive?: boolean
  • added: property UseVerticalVirtualListOptions.itemHeight: UseVirtualListItemSize
  • added: property UseVirtualListOptionsBase.overscan?: number
  • added: property UseVirtualListReturn.containerProps: { ref: Ref<HTMLElement | null>; onScroll: () => void; style: StyleValue }
  • added: property UseVirtualListReturn.list: Ref<UseVirtualListItem<T>[]>
  • added: property UseVirtualListReturn.scrollTo: (index: number) => void
  • added: property UseVirtualListReturn.wrapperProps: ComputedRef<{ style: { width: string; height: string; marginTop: string } | { width: string; height: string; marginLeft: string; display: string } }>
  • added: property UseWebSocketOptions.autoClose?: boolean
  • added: property UseWebSocketOptions.autoReconnect?: boolean | { retries?: number | (() => boolean); delay?: number; onFailed?: Fn }
  • added: property UseWebSocketOptions.heartbeat?: boolean | { message?: string | ArrayBuffer | Blob; interval?: number; pongTimeout?: number }
  • added: property UseWebSocketOptions.immediate?: boolean
  • added: property UseWebSocketOptions.onConnected?: (ws: WebSocket) => void
  • added: property UseWebSocketOptions.onDisconnected?: (ws: WebSocket, event: CloseEvent) => void
  • added: property UseWebSocketOptions.onError?: (ws: WebSocket, event: Event) => void
  • added: property UseWebSocketOptions.onMessage?: (ws: WebSocket, event: MessageEvent) => void
  • added: property UseWebSocketOptions.protocols?: string[]
  • added: property UseWebSocketReturn.close: WebSocket['close']
  • added: property UseWebSocketReturn.data: Ref<T | null>
  • added: property UseWebSocketReturn.open: Fn
  • added: property UseWebSocketReturn.send: (data: string | ArrayBuffer | Blob, useBuffer?: boolean) => boolean
  • added: property UseWebSocketReturn.status: Ref<WebSocketStatus>
  • added: property UseWebSocketReturn.ws: Ref<WebSocket | undefined>
  • added: property UseWebWorkerOptions.dependencies?: string[]
  • added: property UseWebWorkerOptions.timeout?: number
  • added: property UseWindowSizeOptions.includeScrollbar?: boolean
  • added: property UseWindowSizeOptions.initialHeight?: number
  • added: property UseWindowSizeOptions.initialWidth?: number
  • added: property UseWindowSizeOptions.listenOrientation?: boolean
  • added: readonly property UsePointerSwipeReturn.isSwiping: Ref<boolean>
  • added: readonly property UsePointerSwipeReturn.posEnd: Position
  • added: readonly property UsePointerSwipeReturn.posStart: Position
  • added: type ContrastType = 'more' | 'less' | 'custom' | 'no-preference'
  • added: type CubicBezierPoints = [number, number, number, number]
  • added: type EasingFunction = (n: number) => number
  • added: type MaybeComputedElementRef<T extends MaybeElement = MaybeElement> = MaybeComputedRef<T>
  • added: type OnClickOutsideHandler<T extends { detectIframe: OnClickOutsideOptions['detectIframe'] } = { detectIframe: false }> = (evt: T['detectIframe'] extends true ? PointerEvent | FocusEvent : PointerEvent) => void
  • added: type ReducedMotionType = 'reduce' | 'no-preference'
  • added: type UseDraggableReturn = ReturnType<typeof useDraggable>
  • added: type UseEventSourceReturn = ReturnType<typeof useEventSource>
  • added: type UseEyeDropperReturn = ReturnType<typeof useEyeDropper>
  • added: type UseFaviconReturn = ReturnType<typeof useFavicon>
  • added: type UseGamepadReturn = ReturnType<typeof useGamepad>
  • added: type UseImageReturn = ReturnType<typeof useImage>
  • added: type UseKeyModifierReturn<Initial> = Ref<Initial extends boolean ? boolean : boolean | null>
  • added: type UseMagicKeysReturn<Reactive extends Boolean> = Readonly<Omit<Reactive extends true ? Record<string, boolean> : Record<string, ComputedRef<boolean>>, keyof MagicKeysInternal> & MagicKeysInternal>
  • added: type UseMemoryReturn = ReturnType<typeof useMemory>
  • added: type UseNetworkReturn = ReturnType<typeof useNetwork>
  • added: type UsePointerLockReturn = ReturnType<typeof usePointerLock>
  • added: type UsePointerReturn = ReturnType<typeof usePointer>
  • added: type UseSortedCompareFn<T = any> = (a: T, b: T) => number
  • added: type UseSortedFn<T = any> = (arr: T[], compareFn: UseSortedCompareFn<T>) => T[]
  • added: type UseSpeechSynthesisStatus = 'init' | 'play' | 'pause' | 'end'
  • added: type UseTextDirectionValue = 'ltr' | 'rtl' | 'auto'
  • added: type UseTextareaAutosizeReturn = ReturnType<typeof useTextareaAutosize>
  • added: type UseThrottledRefHistoryOptions<Raw, Serialized = Raw> = Omit<UseRefHistoryOptions<Raw, Serialized>, 'eventFilter'> & { throttle?: MaybeRef<number>; trailing?: boolean }
  • added: type UseThrottledRefHistoryReturn<Raw, Serialized = Raw> = UseRefHistoryReturn<Raw, Serialized>
  • added: type UseTimeAgoMessages<UnitNames extends string = UseTimeAgoUnitNamesDefault> = UseTimeAgoMessagesBuiltIn & Record<UnitNames, string | UseTimeAgoFormatter<number>>
  • added: type UseTimeAgoReturn<Controls extends boolean = false> = Controls extends true ? { timeAgo: ComputedRef<string> } & Pausable : ComputedRef<string>
  • added: type UseTimeAgoUnitNamesDefault = 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year'
  • added: type UseTitleOptions = ConfigurableDocument & UseTitleOptionsBase
  • added: type UseTitleOptionsBase = { observe?: boolean } | { titleTemplate?: MaybeRef<string> | ((title: string) => string) }
  • added: type UseVirtualListOptions = UseHorizontalVirtualListOptions | UseVerticalVirtualListOptions
  • added: type UseWakeLockOptions = ConfigurableNavigator & ConfigurableDocument
  • added: type UseWebNotificationReturn = ReturnType<typeof useWebNotification>