Skip to content

Upgrading @vueuse/nuxt 8 to 9

Breaking8.9.4 → 9.13.0Breaking48Deprecated1New93Changed10Fixed95Other5

BreakingUpgrade verdict

48 breaking changes.

  • If you import these TypeScript types directly, update the names to the new Use-prefixed versions.
  • Renames useSpeechSynthesis type Status to UseSpeechSynthesisStatus.
  • Renames onKeyStroke type KeyStrokeOptions to OnKeyStrokeOptions.
  • Renames useAsyncState type AsyncStateOptions to UseAsyncStateOptions.
Top 4 of 49 that need code or config changes
Breaking48
Renames function options types with a consistent Use prefix, affecting direct type imports.
Renames useSpeechSynthesis type Status to UseSpeechSynthesisStatus.
StatusUseSpeechSynthesisStatususeSpeechSynthesis
Renames onKeyStroke type KeyStrokeOptions to OnKeyStrokeOptions.
KeyStrokeOptionsOnKeyStrokeOptionsonKeyStroke
Renames useAsyncState type AsyncStateOptions to UseAsyncStateOptions.
AsyncStateOptionsUseAsyncStateOptionsuseAsyncState
Renames useClipboard types ClipboardOptions to UseClipboardOptions and ClipboardReturn to UseClipboardReturn.
ClipboardOptionsUseClipboardOptionsClipboardReturnUseClipboardReturnuseClipboard
Renames useElementVisibility type VisibilityScrollTargetOptions to UseElementVisibilityOptions.
VisibilityScrollTargetOptionsUseElementVisibilityOptionsuseElementVisibility
Renames useEventSource return type to UseEventSourceReturn.
UseEventSourceReturnuseEventSource
Renames useFavicon type FaviconOptions to UseFaviconOptions.
FaviconOptionsUseFaviconOptionsuseFavicon
Renames useFocusWithin type FocusWithinReturn to UseFocusWithinReturn.
FocusWithinReturnUseFocusWithinReturnuseFocusWithin
Renames useGeolocation type GeolocationOptions to UseGeolocationOptions.
GeolocationOptionsUseGeolocationOptionsuseGeolocation
Renames useIdle type IdleOptions to UseIdleOptions.
IdleOptionsUseIdleOptionsuseIdle
Renames useIntersectionObserver type IntersectionObserverOptions to UseIntersectionObserverOptions.
IntersectionObserverOptionsUseIntersectionObserverOptionsuseIntersectionObserver
Renames useJwt types JwtOptions to UseJwtOptions and JwtResult to UseJwtReturn.
JwtOptionsUseJwtOptionsJwtResultUseJwtReturnuseJwt
Renames useKeyModifier type ModifierOptions to UseModifierOptions.
ModifierOptionsUseModifierOptionsuseKeyModifier
Renames useMagicKeys type MagicKeys to UseMagicKeysReturn.
MagicKeysUseMagicKeysReturnuseMagicKeys
Renames useMemoize type UseMemoizedFn to UseMemoizeReturn and adds type UseMemoizeOptions.
UseMemoizedFnUseMemoizeReturnUseMemoizeOptionsuseMemoize
Renames useMemory type MemoryOptions to UseMemoryOptions.
MemoryOptionsUseMemoryOptionsuseMemory
Renames useMouse type MouseOptions to UseMouseOptions.
MouseOptionsUseMouseOptionsuseMouse
Renames type MutationObserverOptions to UseMutationObserverOptions.
MutationObserverOptionsUseMutationObserverOptions
Renames types ParallaxOptions to UseParallaxOptions and ParallaxReturn to UseParallaxReturn.
ParallaxOptionsUseParallaxOptionsParallaxReturnUseParallaxReturn
Renames types PointerSwipeOptions to UsePointerSwipeOptions and PointerSwipeReturn to UsePointerSwipeReturn.
PointerSwipeOptionsUsePointerSwipeOptionsPointerSwipeReturnUsePointerSwipeReturn
Renames type RTDBOptions to UseRTDBOptions.
RTDBOptionsUseRTDBOptions
Renames type RafFnOptions to UseRafFnOptions.
RafFnOptionsUseRafFnOptions
Renames type ResizeObserverOptions to UseResizeObserverOptions.
ResizeObserverOptionsUseResizeObserverOptions
Renames type ShareOptions to UseShareOptions.
ShareOptionsUseShareOptions
Renames type SpeechRecognitionOptions to UseSpeechRecognitionOptions.
SpeechRecognitionOptionsUseSpeechRecognitionOptions
Renames type SpeechSynthesisOptions to UseSpeechSynthesisOptions.
SpeechSynthesisOptionsUseSpeechSynthesisOptions
Removes voiceInfo and allows voice to be a ref in useSpeechSynthesis.
useSpeechSynthesisvoiceInfovoice
Renames type StorageOptions to UseStorageOptions.
StorageOptionsUseStorageOptions
Renames type StorageAsyncOptions to UseStorageAsyncOptions.
StorageAsyncOptionsUseStorageAsyncOptions
Renames types SwipeOptions to UseSwipeOptions and SwipeReturn to UseSwipeReturn.
SwipeOptionsUseSwipeOptionsSwipeReturnUseSwipeReturn
Renames type TimestampOptions to UseTimestampOptions.
TimestampOptionsUseTimestampOptions
Renames type TransitionOptions to UseTransitionOptions.
TransitionOptionsUseTransitionOptions
Renames type VModelOptions to UseVModelOptions.
VModelOptionsUseVModelOptions
Renames types WebSocketOptions to UseWebSocketOptions and WebSocketResult to UseWebSocketReturn.
WebSocketOptionsUseWebSocketOptionsWebSocketResultUseWebSocketReturn
Renames type WebWorkerOptions to UseWebWorkerOptions.
WebWorkerOptionsUseWebWorkerOptions
Renames type WindowSizeOptions to UseWindowSizeOptions.
WindowSizeOptionsUseWindowSizeOptions
Renames type IntervalOptions to UseIntervalOptions.
IntervalOptionsUseIntervalOptions
Renames type IntervalFnOptions to UseIntervalFnOptions.
IntervalFnOptionsUseIntervalFnOptions
Renames TimeoutOptions to UseTimeoutOptions and TimeoutFnOptions to UseTimeoutFnOptions.
useTimeoutFnuseTimeoutTimeoutOptionsUseTimeoutOptionsTimeoutFnOptionsUseTimeoutFnOptions
Enables support for reactive getter by default in reactify.
reactify
Changes useThrottleFn trailing option default to false.
useThrottleFntrailing
Bumps Nuxt support to RC.9 and updates the autoImports:sources hook.
autoImports:sources
Changes isSupported from boolean to Ref<boolean> for SSR compatibility.
isSupportedRef<boolean>
Supports firebase 9 modular.
firebase
Moves logicAnd, logicOr, logicNot and useClamp to @vueuse/math.
logicAndlogicOrlogicNotuseClamp@vueuse/math
Stores key instead of keyCode in useMagicKeys current.
useMagicKeyskeykeyCodecurrent
firebase: Supports firebase 9, an incompatible upgrade for existing firebase integrations.
firebase
Deprecated1
Deprecates useToFixed in favor of usePrecision.
useToFixedusePrecision