vueuse functions

Skill

Apply VueUse composables where appropriate to build concise, maintainable Vue.js / Nuxt features.

Files269
  • @skills/vueuse-functions/LICENSE.md
  • @skills/vueuse-functions/SKILL.md
  • @skills/vueuse-functions/SYNC.md
  • @skills/vueuse-functions/references/computedAsync.md
  • @skills/vueuse-functions/references/computedEager.md
  • @skills/vueuse-functions/references/computedInject.md
  • @skills/vueuse-functions/references/computedWithControl.md
  • @skills/vueuse-functions/references/createDisposableDirective.md
  • @skills/vueuse-functions/references/createEventHook.md
  • @skills/vueuse-functions/references/createGenericProjection.md
  • @skills/vueuse-functions/references/createGlobalState.md
  • @skills/vueuse-functions/references/createInjectionState.md
  • @skills/vueuse-functions/references/createProjection.md
  • @skills/vueuse-functions/references/createRef.md
  • @skills/vueuse-functions/references/createReusableTemplate.md
  • @skills/vueuse-functions/references/createSharedComposable.md
  • @skills/vueuse-functions/references/createTemplatePromise.md
  • @skills/vueuse-functions/references/createUnrefFn.md
  • @skills/vueuse-functions/references/extendRef.md
  • @skills/vueuse-functions/references/from.md
  • @skills/vueuse-functions/references/get.md
  • @skills/vueuse-functions/references/injectLocal.md
  • @skills/vueuse-functions/references/isDefined.md
  • @skills/vueuse-functions/references/logicAnd.md
  • @skills/vueuse-functions/references/logicNot.md
  • @skills/vueuse-functions/references/logicOr.md
  • @skills/vueuse-functions/references/makeDestructurable.md
  • @skills/vueuse-functions/references/onClickOutside.md
  • @skills/vueuse-functions/references/onElementRemoval.md
  • @skills/vueuse-functions/references/onKeyStroke.md
  • @skills/vueuse-functions/references/onLongPress.md
  • @skills/vueuse-functions/references/onStartTyping.md
  • @skills/vueuse-functions/references/provideLocal.md
  • @skills/vueuse-functions/references/reactify.md
  • @skills/vueuse-functions/references/reactifyObject.md
  • @skills/vueuse-functions/references/reactiveComputed.md
  • @skills/vueuse-functions/references/reactiveOmit.md
  • @skills/vueuse-functions/references/reactivePick.md
  • @skills/vueuse-functions/references/refAutoReset.md
  • @skills/vueuse-functions/references/refDebounced.md
  • @skills/vueuse-functions/references/refDefault.md
  • @skills/vueuse-functions/references/refManualReset.md
  • @skills/vueuse-functions/references/refThrottled.md
  • @skills/vueuse-functions/references/refWithControl.md
  • @skills/vueuse-functions/references/set.md
  • @skills/vueuse-functions/references/syncRef.md
  • @skills/vueuse-functions/references/syncRefs.md
  • @skills/vueuse-functions/references/templateRef.md
  • @skills/vueuse-functions/references/toObserver.md
  • @skills/vueuse-functions/references/toReactive.md
  • @skills/vueuse-functions/references/toRef.md
  • @skills/vueuse-functions/references/toRefs.md
  • @skills/vueuse-functions/references/tryOnBeforeMount.md
  • @skills/vueuse-functions/references/tryOnBeforeUnmount.md
  • @skills/vueuse-functions/references/tryOnMounted.md
  • @skills/vueuse-functions/references/tryOnScopeDispose.md
  • @skills/vueuse-functions/references/tryOnUnmounted.md
  • @skills/vueuse-functions/references/unrefElement.md
  • @skills/vueuse-functions/references/until.md
  • @skills/vueuse-functions/references/useAbs.md
  • @skills/vueuse-functions/references/useActiveElement.md
  • @skills/vueuse-functions/references/useAnimate.md
  • @skills/vueuse-functions/references/useArrayDifference.md
  • @skills/vueuse-functions/references/useArrayEvery.md
  • @skills/vueuse-functions/references/useArrayFilter.md
  • @skills/vueuse-functions/references/useArrayFind.md
  • @skills/vueuse-functions/references/useArrayFindIndex.md
  • @skills/vueuse-functions/references/useArrayFindLast.md
  • @skills/vueuse-functions/references/useArrayIncludes.md
  • @skills/vueuse-functions/references/useArrayJoin.md
  • @skills/vueuse-functions/references/useArrayMap.md
  • @skills/vueuse-functions/references/useArrayReduce.md
  • @skills/vueuse-functions/references/useArraySome.md
  • @skills/vueuse-functions/references/useArrayUnique.md
  • @skills/vueuse-functions/references/useAsyncQueue.md
  • @skills/vueuse-functions/references/useAsyncState.md
  • @skills/vueuse-functions/references/useAsyncValidator.md
  • @skills/vueuse-functions/references/useAuth.md
  • @skills/vueuse-functions/references/useAverage.md
  • @skills/vueuse-functions/references/useAxios.md
  • @skills/vueuse-functions/references/useBase64.md
  • @skills/vueuse-functions/references/useBattery.md
  • @skills/vueuse-functions/references/useBluetooth.md
  • @skills/vueuse-functions/references/useBreakpoints.md
  • @skills/vueuse-functions/references/useBroadcastChannel.md
  • @skills/vueuse-functions/references/useBrowserLocation.md
  • @skills/vueuse-functions/references/useCached.md
  • @skills/vueuse-functions/references/useCeil.md
  • @skills/vueuse-functions/references/useChangeCase.md
  • @skills/vueuse-functions/references/useClamp.md
  • @skills/vueuse-functions/references/useClipboard.md
  • @skills/vueuse-functions/references/useClipboardItems.md
  • @skills/vueuse-functions/references/useCloned.md
  • @skills/vueuse-functions/references/useColorMode.md
  • @skills/vueuse-functions/references/useConfirmDialog.md
  • @skills/vueuse-functions/references/useCookies.md
  • @skills/vueuse-functions/references/useCountdown.md
  • @skills/vueuse-functions/references/useCounter.md
  • @skills/vueuse-functions/references/useCssSupports.md
  • @skills/vueuse-functions/references/useCssVar.md
  • @skills/vueuse-functions/references/useCurrentElement.md
  • @skills/vueuse-functions/references/useCycleList.md
  • @skills/vueuse-functions/references/useDark.md
  • @skills/vueuse-functions/references/useDateFormat.md
  • @skills/vueuse-functions/references/useDebounceFn.md
  • @skills/vueuse-functions/references/useDebouncedRefHistory.md
  • @skills/vueuse-functions/references/useDeviceMotion.md
  • @skills/vueuse-functions/references/useDeviceOrientation.md
  • @skills/vueuse-functions/references/useDevicePixelRatio.md
  • @skills/vueuse-functions/references/useDevicesList.md
  • @skills/vueuse-functions/references/useDisplayMedia.md
  • @skills/vueuse-functions/references/useDocumentVisibility.md
  • @skills/vueuse-functions/references/useDraggable.md
  • @skills/vueuse-functions/references/useDrauu.md
  • @skills/vueuse-functions/references/useDropZone.md
  • @skills/vueuse-functions/references/useElementBounding.md
  • @skills/vueuse-functions/references/useElementByPoint.md
  • @skills/vueuse-functions/references/useElementHover.md
  • @skills/vueuse-functions/references/useElementSize.md
  • @skills/vueuse-functions/references/useElementVisibility.md
  • @skills/vueuse-functions/references/useEventBus.md
  • @skills/vueuse-functions/references/useEventListener.md
  • @skills/vueuse-functions/references/useEventSource.md
  • @skills/vueuse-functions/references/useExtractedObservable.md
  • @skills/vueuse-functions/references/useEyeDropper.md
  • @skills/vueuse-functions/references/useFavicon.md
  • @skills/vueuse-functions/references/useFetch.md
  • @skills/vueuse-functions/references/useFileDialog.md
  • @skills/vueuse-functions/references/useFileSystemAccess.md
  • @skills/vueuse-functions/references/useFirestore.md
  • @skills/vueuse-functions/references/useFloor.md
  • @skills/vueuse-functions/references/useFocus.md
  • @skills/vueuse-functions/references/useFocusTrap.md
  • @skills/vueuse-functions/references/useFocusWithin.md
  • @skills/vueuse-functions/references/useFps.md
  • @skills/vueuse-functions/references/useFullscreen.md
  • @skills/vueuse-functions/references/useFuse.md
  • @skills/vueuse-functions/references/useGamepad.md
  • @skills/vueuse-functions/references/useGeolocation.md
  • @skills/vueuse-functions/references/useIDBKeyval.md
  • @skills/vueuse-functions/references/useIdle.md
  • @skills/vueuse-functions/references/useImage.md
  • @skills/vueuse-functions/references/useInfiniteScroll.md
  • @skills/vueuse-functions/references/useIntersectionObserver.md
  • @skills/vueuse-functions/references/useInterval.md
  • @skills/vueuse-functions/references/useIntervalFn.md
  • @skills/vueuse-functions/references/useIpcRenderer.md
  • @skills/vueuse-functions/references/useIpcRendererInvoke.md
  • @skills/vueuse-functions/references/useIpcRendererOn.md
  • @skills/vueuse-functions/references/useJwt.md
  • @skills/vueuse-functions/references/useKeyModifier.md
  • @skills/vueuse-functions/references/useLastChanged.md
  • @skills/vueuse-functions/references/useLocalStorage.md
  • @skills/vueuse-functions/references/useMagicKeys.md
  • @skills/vueuse-functions/references/useManualRefHistory.md
  • @skills/vueuse-functions/references/useMath.md
  • @skills/vueuse-functions/references/useMax.md
  • @skills/vueuse-functions/references/useMediaControls.md
  • @skills/vueuse-functions/references/useMediaQuery.md
  • @skills/vueuse-functions/references/useMemoize.md
  • @skills/vueuse-functions/references/useMemory.md
  • @skills/vueuse-functions/references/useMin.md
  • @skills/vueuse-functions/references/useMounted.md
  • @skills/vueuse-functions/references/useMouse.md
  • @skills/vueuse-functions/references/useMouseInElement.md
  • @skills/vueuse-functions/references/useMousePressed.md
  • @skills/vueuse-functions/references/useMutationObserver.md
  • @skills/vueuse-functions/references/useNProgress.md
  • @skills/vueuse-functions/references/useNavigatorLanguage.md
  • @skills/vueuse-functions/references/useNetwork.md
  • @skills/vueuse-functions/references/useNow.md
  • @skills/vueuse-functions/references/useObjectUrl.md
  • @skills/vueuse-functions/references/useObservable.md
  • @skills/vueuse-functions/references/useOffsetPagination.md
  • @skills/vueuse-functions/references/useOnline.md
  • @skills/vueuse-functions/references/usePageLeave.md
  • @skills/vueuse-functions/references/useParallax.md
  • @skills/vueuse-functions/references/useParentElement.md
  • @skills/vueuse-functions/references/usePerformanceObserver.md
  • @skills/vueuse-functions/references/usePermission.md
  • @skills/vueuse-functions/references/usePointer.md
  • @skills/vueuse-functions/references/usePointerLock.md
  • @skills/vueuse-functions/references/usePointerSwipe.md
  • @skills/vueuse-functions/references/usePrecision.md
  • @skills/vueuse-functions/references/usePreferredColorScheme.md
  • @skills/vueuse-functions/references/usePreferredContrast.md
  • @skills/vueuse-functions/references/usePreferredDark.md
  • @skills/vueuse-functions/references/usePreferredLanguages.md
  • @skills/vueuse-functions/references/usePreferredReducedMotion.md
  • @skills/vueuse-functions/references/usePreferredReducedTransparency.md
  • @skills/vueuse-functions/references/usePrevious.md
  • @skills/vueuse-functions/references/useProjection.md
  • @skills/vueuse-functions/references/useQRCode.md
  • @skills/vueuse-functions/references/useRTDB.md
  • @skills/vueuse-functions/references/useRafFn.md
  • @skills/vueuse-functions/references/useRefHistory.md
  • @skills/vueuse-functions/references/useResizeObserver.md
  • @skills/vueuse-functions/references/useRound.md
  • @skills/vueuse-functions/references/useRouteHash.md
  • @skills/vueuse-functions/references/useRouteParams.md
  • @skills/vueuse-functions/references/useRouteQuery.md
  • @skills/vueuse-functions/references/useSSRWidth.md
  • @skills/vueuse-functions/references/useScreenOrientation.md
  • @skills/vueuse-functions/references/useScreenSafeArea.md
  • @skills/vueuse-functions/references/useScriptTag.md
  • @skills/vueuse-functions/references/useScroll.md
  • @skills/vueuse-functions/references/useScrollLock.md
  • @skills/vueuse-functions/references/useSessionStorage.md
  • @skills/vueuse-functions/references/useShare.md
  • @skills/vueuse-functions/references/useSortable.md
  • @skills/vueuse-functions/references/useSorted.md
  • @skills/vueuse-functions/references/useSpeechRecognition.md
  • @skills/vueuse-functions/references/useSpeechSynthesis.md
  • @skills/vueuse-functions/references/useStepper.md
  • @skills/vueuse-functions/references/useStorage.md
  • @skills/vueuse-functions/references/useStorageAsync.md
  • @skills/vueuse-functions/references/useStyleTag.md
  • @skills/vueuse-functions/references/useSubject.md
  • @skills/vueuse-functions/references/useSubscription.md
  • @skills/vueuse-functions/references/useSum.md
  • @skills/vueuse-functions/references/useSupported.md
  • @skills/vueuse-functions/references/useSwipe.md
  • @skills/vueuse-functions/references/useTemplateRefsList.md
  • @skills/vueuse-functions/references/useTextDirection.md
  • @skills/vueuse-functions/references/useTextSelection.md
  • @skills/vueuse-functions/references/useTextareaAutosize.md
  • @skills/vueuse-functions/references/useThrottleFn.md
  • @skills/vueuse-functions/references/useThrottledRefHistory.md
  • @skills/vueuse-functions/references/useTimeAgo.md
  • @skills/vueuse-functions/references/useTimeAgoIntl.md
  • @skills/vueuse-functions/references/useTimeout.md
  • @skills/vueuse-functions/references/useTimeoutFn.md
  • @skills/vueuse-functions/references/useTimeoutPoll.md
  • @skills/vueuse-functions/references/useTimestamp.md
  • @skills/vueuse-functions/references/useTitle.md
  • @skills/vueuse-functions/references/useToNumber.md
  • @skills/vueuse-functions/references/useToString.md
  • @skills/vueuse-functions/references/useToggle.md
  • @skills/vueuse-functions/references/useTransition.md
  • @skills/vueuse-functions/references/useTrunc.md
  • @skills/vueuse-functions/references/useUrlSearchParams.md
  • @skills/vueuse-functions/references/useUserMedia.md
  • @skills/vueuse-functions/references/useVModel.md
  • @skills/vueuse-functions/references/useVModels.md
  • @skills/vueuse-functions/references/useVibrate.md
  • @skills/vueuse-functions/references/useVirtualList.md
  • @skills/vueuse-functions/references/useWakeLock.md
  • @skills/vueuse-functions/references/useWebNotification.md
  • @skills/vueuse-functions/references/useWebSocket.md
  • @skills/vueuse-functions/references/useWebWorker.md
  • @skills/vueuse-functions/references/useWebWorkerFn.md
  • @skills/vueuse-functions/references/useWindowFocus.md
  • @skills/vueuse-functions/references/useWindowScroll.md
  • @skills/vueuse-functions/references/useWindowSize.md
  • @skills/vueuse-functions/references/useZoomFactor.md
  • @skills/vueuse-functions/references/useZoomLevel.md
  • @skills/vueuse-functions/references/watchArray.md
  • @skills/vueuse-functions/references/watchAtMost.md
  • @skills/vueuse-functions/references/watchDebounced.md
  • @skills/vueuse-functions/references/watchDeep.md
  • @skills/vueuse-functions/references/watchExtractedObservable.md
  • @skills/vueuse-functions/references/watchIgnorable.md
  • @skills/vueuse-functions/references/watchImmediate.md
  • @skills/vueuse-functions/references/watchOnce.md
  • @skills/vueuse-functions/references/watchPausable.md
  • @skills/vueuse-functions/references/watchThrottled.md
  • @skills/vueuse-functions/references/watchTriggerable.md
  • @skills/vueuse-functions/references/watchWithFilter.md
  • @skills/vueuse-functions/references/whenever.md

VueUse Functions

This skill is a decision-and-implementation guide for VueUse composables in Vue.js / Nuxt projects. It maps requirements to the most suitable VueUse function, applies the correct usage pattern, and prefers composable-based solutions over bespoke code to keep implementations concise, maintainable, and performant.

When to Apply

  • Apply this skill whenever assisting user development work in Vue.js / Nuxt.
  • Always check first whether a VueUse function can implement the requirement.
  • Prefer VueUse composables over custom code to improve readability, maintainability, and performance.
  • Map requirements to the most appropriate VueUse function and follow the function’s invocation rule.
  • Please refer to the Invocation field in the below functions table. For example:
    • AUTO: Use automatically when applicable.
    • EXTERNAL: Use only if the user already installed the required external dependency; otherwise reconsider, and ask to install only if truly needed.
    • EXPLICIT_ONLY: Use only when explicitly requested by the user.
    NOTE User instructions in the prompt or AGENTS.md may override a function’s default Invocation rule.

Functions

All functions listed below are part of the VueUse library, each section categorizes functions based on their functionality.
IMPORTANT: Each function entry includes a short Description and a detailed Reference. When using any function, always consult the corresponding document in ./references for Usage details and Type Declarations.

State

FunctionDescriptionInvocation
createGlobalState [blocked]Keep states in the global scope to be reusable across Vue instancesAUTO
createInjectionState [blocked]Create global state that can be injected into componentsAUTO
createSharedComposable [blocked]Make a composable function usable with multiple Vue instancesAUTO
injectLocal [blocked]Extended inject with ability to call provideLocal to provide the value in the same componentAUTO
provideLocal [blocked]Extended provide with ability to call injectLocal to obtain the value in the same componentAUTO
useAsyncState [blocked]Reactive async stateAUTO
useDebouncedRefHistory [blocked]Shorthand for useRefHistory with debounced filterAUTO
useLastChanged [blocked]Records the timestamp of the last changeAUTO
useLocalStorage [blocked]Reactive LocalStorageAUTO
useManualRefHistory [blocked]Manually track the change history of a ref when the user calls commit()AUTO
useRefHistory [blocked]Track the change history of a refAUTO
useSessionStorage [blocked]Reactive SessionStorageAUTO
useStorage [blocked]Create a reactive ref that can be used to access & modify LocalStorage or SessionStorageAUTO
useStorageAsync [blocked]Reactive Storage with async supportAUTO
useThrottledRefHistory [blocked]Shorthand for useRefHistory with throttled filterAUTO

Elements

FunctionDescriptionInvocation
useActiveElement [blocked]Reactive document.activeElementAUTO
useDocumentVisibility [blocked]Reactively track document.visibilityStateAUTO
useDraggable [blocked]Make elements draggableAUTO
useDropZone [blocked]Create a zone where files can be droppedAUTO
useElementBounding [blocked]Reactive bounding box of an HTML elementAUTO
useElementSize [blocked]Reactive size of an HTML elementAUTO
useElementVisibility [blocked]Tracks the visibility of an element within the viewportAUTO
useIntersectionObserver [blocked]Detects changes to a target element's visibilityAUTO
useMouseInElement [blocked]Reactive mouse position related to an elementAUTO
useMutationObserver [blocked]Watch for changes being made to the DOM treeAUTO
useParentElement [blocked]Get parent element of the given elementAUTO
useResizeObserver [blocked]Reports changes to the dimensions of an Element's content or the border-boxAUTO
useWindowFocus [blocked]Reactively track window focus with window.onfocus and window.onblur eventsAUTO
useWindowScroll [blocked]Reactive window scrollAUTO
useWindowSize [blocked]Reactive window sizeAUTO

Browser

FunctionDescriptionInvocation
useBluetooth [blocked]Reactive Web Bluetooth APIAUTO
useBreakpoints [blocked]Reactive viewport breakpointsAUTO
useBroadcastChannel [blocked]Reactive BroadcastChannel APIAUTO
useBrowserLocation [blocked]Reactive browser locationAUTO
useClipboard [blocked]Reactive Clipboard APIAUTO
useClipboardItems [blocked]Reactive Clipboard APIAUTO
useColorMode [blocked]Reactive color mode (dark / light / customs) with auto data persistenceAUTO
useCssSupports [blocked]SSR compatible and reactive CSS.supportsAUTO
useCssVar [blocked]Manipulate CSS variablesAUTO
useDark [blocked]Reactive dark mode with auto data persistenceAUTO
useEventListener [blocked]Use EventListener with easeAUTO
useEyeDropper [blocked]Reactive EyeDropper APIAUTO
useFavicon [blocked]Reactive faviconAUTO
useFileDialog [blocked]Open file dialog with easeAUTO
useFileSystemAccess [blocked]Create and read and write local files with FileSystemAccessAPIAUTO
useFullscreen [blocked]Reactive Fullscreen APIAUTO
useGamepad [blocked]Provides reactive bindings for the Gamepad APIAUTO
useImage [blocked]Reactive load an image in the browserAUTO
useMediaControls [blocked]Reactive media controls for both audio and video elementsAUTO
useMediaQuery [blocked]Reactive Media QueryAUTO
useMemory [blocked]Reactive Memory InfoAUTO
useObjectUrl [blocked]Reactive URL representing an objectAUTO
usePerformanceObserver [blocked]Observe performance metricsAUTO
usePermission [blocked]Reactive Permissions APIAUTO
usePreferredColorScheme [blocked]Reactive prefers-color-scheme media queryAUTO
usePreferredContrast [blocked]Reactive prefers-contrast media queryAUTO
usePreferredDark [blocked]Reactive dark theme preferenceAUTO
usePreferredLanguages [blocked]Reactive Navigator LanguagesAUTO
usePreferredReducedMotion [blocked]Reactive prefers-reduced-motion media queryAUTO
usePreferredReducedTransparency [blocked]Reactive prefers-reduced-transparency media queryAUTO
useScreenOrientation [blocked]Reactive Screen Orientation APIAUTO
useScreenSafeArea [blocked]Reactive env(safe-area-inset-*)AUTO
useScriptTag [blocked]Creates a script tagAUTO
useShare [blocked]Reactive Web Share APIAUTO
useSSRWidth [blocked]Used to set a global viewport width which will be used when rendering SSR components that rely on the viewport width like useMediaQuery or useBreakpointsAUTO
useStyleTag [blocked]Inject reactive style element in headAUTO
useTextareaAutosize [blocked]Automatically update the height of a textarea depending on the contentAUTO
useTextDirection [blocked]Reactive dir of the element's textAUTO
useTitle [blocked]Reactive document titleAUTO
useUrlSearchParams [blocked]Reactive URLSearchParamsAUTO
useVibrate [blocked]Reactive Vibration APIAUTO
useWakeLock [blocked]Reactive Screen Wake Lock APIAUTO
useWebNotification [blocked]Reactive NotificationAUTO
useWebWorker [blocked]Simple Web Workers registration and communicationAUTO
useWebWorkerFn [blocked]Run expensive functions without blocking the UIAUTO

Sensors

FunctionDescriptionInvocation
onClickOutside [blocked]Listen for clicks outside of an elementAUTO
onElementRemoval [blocked]Fires when the element or any element containing it is removed from the DOMAUTO
onKeyStroke [blocked]Listen for keyboard keystrokesAUTO
onLongPress [blocked]Listen for a long press on an elementAUTO
onStartTyping [blocked]Fires when users start typing on non-editable elementsAUTO
useBattery [blocked]Reactive Battery Status APIAUTO
useDeviceMotion [blocked]Reactive DeviceMotionEventAUTO
useDeviceOrientation [blocked]Reactive DeviceOrientationEventAUTO
useDevicePixelRatio [blocked]Reactively track window.devicePixelRatioAUTO
useDevicesList [blocked]Reactive enumerateDevices listing available input/output devicesAUTO
useDisplayMedia [blocked]Reactive mediaDevices.getDisplayMedia streamingAUTO
useElementByPoint [blocked]Reactive element by pointAUTO
useElementHover [blocked]Reactive element's hover stateAUTO
useFocus [blocked]Reactive utility to track or set the focus state of a DOM elementAUTO
useFocusWithin [blocked]Reactive utility to track if an element or one of its descendants has focusAUTO
useFps [blocked]Reactive FPS (frames per second)AUTO
useGeolocation [blocked]Reactive Geolocation APIAUTO
useIdle [blocked]Tracks whether the user is being inactiveAUTO
useInfiniteScroll [blocked]Infinite scrolling of the elementAUTO
useKeyModifier [blocked]Reactive Modifier StateAUTO
useMagicKeys [blocked]Reactive keys pressed stateAUTO
useMouse [blocked]Reactive mouse positionAUTO
useMousePressed [blocked]Reactive mouse pressing stateAUTO
useNavigatorLanguage [blocked]Reactive navigator.languageAUTO
useNetwork [blocked]Reactive Network statusAUTO
useOnline [blocked]Reactive online stateAUTO
usePageLeave [blocked]Reactive state to show whether the mouse leaves the pageAUTO
useParallax [blocked]Create parallax effect easilyAUTO
usePointer [blocked]Reactive pointer stateAUTO
usePointerLock [blocked]Reactive pointer lockAUTO
usePointerSwipe [blocked]Reactive swipe detection based on PointerEventsAUTO
useScroll [blocked]Reactive scroll position and stateAUTO
useScrollLock [blocked]Lock scrolling of the elementAUTO
useSpeechRecognition [blocked]Reactive SpeechRecognitionAUTO
useSpeechSynthesis [blocked]Reactive SpeechSynthesisAUTO
useSwipe [blocked]Reactive swipe detection based on TouchEventsAUTO
useTextSelection [blocked]Reactively track user text selection based on Window.getSelectionAUTO
useUserMedia [blocked]Reactive mediaDevices.getUserMedia streamingAUTO

Network

FunctionDescriptionInvocation
useEventSource [blocked]An EventSource or Server-Sent-Events instance opens a persistent connection to an HTTP serverAUTO
useFetch [blocked]Reactive Fetch API provides the ability to abort requestsAUTO
useWebSocket [blocked]Reactive WebSocket clientAUTO

Animation

FunctionDescriptionInvocation
useAnimate [blocked]Reactive Web Animations APIAUTO
useInterval [blocked]Reactive counter that increases on every intervalAUTO
useIntervalFn [blocked]Wrapper for setInterval with controlsAUTO
useNow [blocked]Reactive current Date instanceAUTO
useRafFn [blocked]Call function on every requestAnimationFrameAUTO
useTimeout [blocked]Reactive value that becomes true after a given timeAUTO
useTimeoutFn [blocked]Wrapper for setTimeout with controlsAUTO
useTimestamp [blocked]Reactive current timestampAUTO
useTransition [blocked]Transition between valuesAUTO

Component

FunctionDescriptionInvocation
computedInject [blocked]Combine computed and injectAUTO
createReusableTemplate [blocked]Define and reuse template inside the component scopeAUTO
createTemplatePromise [blocked]Template as PromiseAUTO
templateRef [blocked]Shorthand for binding ref to template elementAUTO
tryOnBeforeMount [blocked]Safe onBeforeMountAUTO
tryOnBeforeUnmount [blocked]Safe onBeforeUnmountAUTO
tryOnMounted [blocked]Safe onMountedAUTO
tryOnScopeDispose [blocked]Safe onScopeDisposeAUTO
tryOnUnmounted [blocked]Safe onUnmountedAUTO
unrefElement [blocked]Retrieves the underlying DOM element from a Vue ref or component instanceAUTO
useCurrentElement [blocked]Get the DOM element of current component as a refAUTO
useMounted [blocked]Mounted state in refAUTO
useTemplateRefsList [blocked]Shorthand for binding refs to template elements and components inside v-forAUTO
useVirtualList [blocked]Create virtual lists with easeAUTO
useVModel [blocked]Shorthand for v-model bindingAUTO
useVModels [blocked]Shorthand for props v-model bindingAUTO

Watch

FunctionDescriptionInvocation
until [blocked]Promised one-time watch for changesAUTO
watchArray [blocked]Watch for an array with additions and removalsAUTO
watchAtMost [blocked]watch with the number of times triggeredAUTO
watchDebounced [blocked]Debounced watchAUTO
watchDeep [blocked]Shorthand for watching value with {deep: true}AUTO
watchIgnorable [blocked]Ignorable watchAUTO
watchImmediate [blocked]Shorthand for watching value with {immediate: true}AUTO
watchOnce [blocked]Shorthand for watching value with { once: true }AUTO
watchPausable [blocked]Pausable watchAUTO
watchThrottled [blocked]Throttled watchAUTO
watchTriggerable [blocked]Watch that can be triggered manuallyAUTO
watchWithFilter [blocked]watch with additional EventFilter controlAUTO
whenever [blocked]Shorthand for watching value to be truthyAUTO

Reactivity

FunctionDescriptionInvocation
computedAsync [blocked]Computed for async functionsAUTO
computedEager [blocked]Eager computed without lazy evaluationAUTO
computedWithControl [blocked]Explicitly define the dependencies of computedAUTO
createRef [blocked]Returns a deepRef or shallowRef depending on the deep paramAUTO
extendRef [blocked]Add extra attributes to RefAUTO
reactify [blocked]Converts plain functions into reactive functionsAUTO
reactifyObject [blocked]Apply reactify to an objectAUTO
reactiveComputed [blocked]Computed reactive objectAUTO
reactiveOmit [blocked]Reactively omit fields from a reactive objectAUTO
reactivePick [blocked]Reactively pick fields from a reactive objectAUTO
refAutoReset [blocked]A ref which will be reset to the default value after some timeAUTO
refDebounced [blocked]Debounce execution of a ref valueAUTO
refDefault [blocked]Apply default value to a refAUTO
refManualReset [blocked]Create a ref with manual reset functionalityAUTO
refThrottled [blocked]Throttle changing of a ref valueAUTO
refWithControl [blocked]Fine-grained controls over ref and its reactivityAUTO
syncRef [blocked]Two-way refs synchronizationAUTO
syncRefs [blocked]Keep target refs in sync with a source refAUTO
toReactive [blocked]Converts ref to reactiveAUTO
toRef [blocked]Normalize value/ref/getter to ref or computedEXPLICIT_ONLY
toRefs [blocked]Extended toRefs that also accepts refs of an objectAUTO

Array

FunctionDescriptionInvocation
useArrayDifference [blocked]Reactive get array difference of two arraysAUTO
useArrayEvery [blocked]Reactive Array.everyAUTO
useArrayFilter [blocked]Reactive Array.filterAUTO
useArrayFind [blocked]Reactive Array.findAUTO
useArrayFindIndex [blocked]Reactive Array.findIndexAUTO
useArrayFindLast [blocked]Reactive Array.findLastAUTO
useArrayIncludes [blocked]Reactive Array.includesAUTO
useArrayJoin [blocked]Reactive Array.joinAUTO
useArrayMap [blocked]Reactive Array.mapAUTO
useArrayReduce [blocked]Reactive Array.reduceAUTO
useArraySome [blocked]Reactive Array.someAUTO
useArrayUnique [blocked]Reactive unique arrayAUTO
useSorted [blocked]Reactive sort arrayAUTO

Time

FunctionDescriptionInvocation
useCountdown [blocked]Reactive countdown timer in secondsAUTO
useDateFormat [blocked]Get the formatted date according to the string of tokens passed inAUTO
useTimeAgo [blocked]Reactive time agoAUTO
useTimeAgoIntl [blocked]Reactive time ago with i18n supportedAUTO

Utilities

FunctionDescriptionInvocation
createDisposableDirective [blocked]Utility for authoring disposable directivesAUTO
createEventHook [blocked]Utility for creating event hooksAUTO
createUnrefFn [blocked]Make a plain function accepting ref and raw values as argumentsAUTO
get [blocked]Shorthand for accessing ref.valueEXPLICIT_ONLY
isDefined [blocked]Non-nullish checking type guard for RefAUTO
makeDestructurable [blocked]Make isomorphic destructurable for object and array at the same timeAUTO
set [blocked]Shorthand for ref.value = xEXPLICIT_ONLY
useAsyncQueue [blocked]Executes each asynchronous task sequentially and passes the current task result to the next taskAUTO
useBase64 [blocked]Reactive base64 transformingAUTO
useCached [blocked]Cache a ref with a custom comparatorAUTO
useCloned [blocked]Reactive clone of a refAUTO
useConfirmDialog [blocked]Creates event hooks to support modals and confirmation dialog chainsAUTO
useCounter [blocked]Basic counter with utility functionsAUTO
useCycleList [blocked]Cycle through a list of itemsAUTO
useDebounceFn [blocked]Debounce execution of a functionAUTO
useEventBus [blocked]A basic event busAUTO
useMemoize [blocked]Cache results of functions depending on arguments and keep it reactiveAUTO
useOffsetPagination [blocked]Reactive offset paginationAUTO
usePrevious [blocked]Holds the previous value of a refAUTO
useStepper [blocked]Provides helpers for building a multi-step wizard interfaceAUTO
useSupported [blocked]SSR compatibility isSupportedAUTO
useThrottleFn [blocked]Throttle execution of a functionAUTO
useTimeoutPoll [blocked]Use timeout to poll somethingAUTO
useToggle [blocked]A boolean switcher with utility functionsAUTO
useToNumber [blocked]Reactively convert a string ref to numberAUTO
useToString [blocked]Reactively convert a ref to stringAUTO

@Electron

FunctionDescriptionInvocation
useIpcRenderer [blocked]Provides ipcRenderer and all of its APIs with Vue reactivityEXTERNAL
useIpcRendererInvoke [blocked]Reactive ipcRenderer.invoke API resultEXTERNAL
useIpcRendererOn [blocked]Use ipcRenderer.on with ease and ipcRenderer.removeListener automatically on unmountedEXTERNAL
useZoomFactor [blocked]Reactive WebFrame zoom factorEXTERNAL
useZoomLevel [blocked]Reactive WebFrame zoom levelEXTERNAL

@Firebase

FunctionDescriptionInvocation
useAuth [blocked]Reactive Firebase Auth bindingEXTERNAL
useFirestore [blocked]Reactive Firestore bindingEXTERNAL
useRTDB [blocked]Reactive Firebase Realtime Database bindingEXTERNAL

@Head

FunctionDescriptionInvocation
createHeadCreate the head manager instance.EXTERNAL
useHeadUpdate head meta tags reactively.EXTERNAL

@Integrations

FunctionDescriptionInvocation
useAsyncValidator [blocked]Wrapper for async-validatorEXTERNAL
useAxios [blocked]Wrapper for axiosEXTERNAL
useChangeCase [blocked]Reactive wrapper for change-caseEXTERNAL
useCookies [blocked]Wrapper for universal-cookieEXTERNAL
useDrauu [blocked]Reactive instance for drauuEXTERNAL
useFocusTrap [blocked]Reactive wrapper for focus-trapEXTERNAL
useFuse [blocked]Easily implement fuzzy search using a composable with Fuse.jsEXTERNAL
useIDBKeyval [blocked]Wrapper for idb-keyvalEXTERNAL
useJwt [blocked]Wrapper for jwt-decodeEXTERNAL
useNProgress [blocked]Reactive wrapper for nprogressEXTERNAL
useQRCode [blocked]Wrapper for qrcodeEXTERNAL
useSortable [blocked]Wrapper for sortableEXTERNAL

@Math

FunctionDescriptionInvocation
createGenericProjection [blocked]Generic version of createProjectionEXTERNAL
createProjection [blocked]Reactive numeric projection from one domain to anotherEXTERNAL
logicAnd [blocked]AND condition for refsEXTERNAL
logicNot [blocked]NOT condition for refEXTERNAL
logicOr [blocked]OR conditions for refsEXTERNAL
useAbs [blocked]Reactive Math.absEXTERNAL
useAverage [blocked]Get the average of an array reactivelyEXTERNAL
useCeil [blocked]Reactive Math.ceilEXTERNAL
useClamp [blocked]Reactively clamp a value between two other valuesEXTERNAL
useFloor [blocked]Reactive Math.floorEXTERNAL
useMath [blocked]Reactive Math methodsEXTERNAL
useMax [blocked]Reactive Math.maxEXTERNAL
useMin [blocked]Reactive Math.minEXTERNAL
usePrecision [blocked]Reactively set the precision of a numberEXTERNAL
useProjection [blocked]Reactive numeric projection from one domain to anotherEXTERNAL
useRound [blocked]Reactive Math.roundEXTERNAL
useSum [blocked]Get the sum of an array reactivelyEXTERNAL
useTrunc [blocked]Reactive Math.truncEXTERNAL

@Motion

FunctionDescriptionInvocation
useElementStyleSync a reactive object to a target element CSS stylingEXTERNAL
useElementTransformSync a reactive object to a target element CSS transform.EXTERNAL
useMotionPutting your components in motion.EXTERNAL
useMotionPropertiesAccess Motion Properties for a target element.EXTERNAL
useMotionVariantsHandle the Variants state and selection.EXTERNAL
useSpringSpring animations.EXTERNAL

@Router

FunctionDescriptionInvocation
useRouteHash [blocked]Shorthand for a reactive route.hashEXTERNAL
useRouteParams [blocked]Shorthand for a reactive route.paramsEXTERNAL
useRouteQuery [blocked]Shorthand for a reactive route.queryEXTERNAL

@RxJS

FunctionDescriptionInvocation
from [blocked]Wrappers around RxJS's from() and fromEvent() to allow them to accept refsEXTERNAL
toObserver [blocked]Sugar function to convert a ref into an RxJS ObserverEXTERNAL
useExtractedObservable [blocked]Use an RxJS Observable as extracted from one or more composablesEXTERNAL
useObservable [blocked]Use an RxJS ObservableEXTERNAL
useSubject [blocked]Bind an RxJS Subject to a ref and propagate value changes both waysEXTERNAL
useSubscription [blocked]Use an RxJS Subscription without worrying about unsubscribing from it or creating memory leaksEXTERNAL
watchExtractedObservable [blocked]Watch the values of an RxJS Observable as extracted from one or more composablesEXTERNAL

@SchemaOrg

FunctionDescriptionInvocation
createSchemaOrgCreate the schema.org manager instance.EXTERNAL
useSchemaOrgUpdate schema.org reactively.EXTERNAL

@Sound

FunctionDescriptionInvocation
useSoundPlay sound effects reactively.EXTERNAL
vueuse-functions — Kortix Marketplace | Kortix