Functions

useNetwork-响应式 Network status。网络状态 API 可以获取到系统的网络连接信息，比如说连接方式是 WiFi 还是蜂窝。应用程序可以根据此信息为用户展现不同清晰度的内容。该 API 是由 NetworkInformation 接口和 Navigator 接口上新增的一个 connection 属性组成的。

useOnline-响应式在线状态，useNetwork的包装器

usePageLeave-响应式获取鼠标是否离开页面。

useParallax-轻松创建视差效果。如果不支持旋转，它会使用 useDeviceOrientation 并回退到 useMouse

usePointer-响应式指针状态

usePointerLock-响应式指针锁定

usePointerSwipe-基于PointerEvents的响应式滑动检测

useScroll-响应式获取滚动位置和状态。

useScrollLock-锁定元素的滚动。

useSpeechRecognition-响应式SpeechRecognition。

useSpeechSynthesis-响应式 SpeechSynthesis

useSwipe-基于 TouchEvents的响应式滑动检测

useTextSelection-基于 Window.getSelection 响应式跟踪用户文本选择

useUserMedia-响应式 mediaDevices.getUserMedia流

Network

useEventSource-使用EventSource 或 Server-Sent-Events 实例会对 HTTP 服务开启一个持久化的连接，以 text/event-stream 格式发送事件。

useFetch-响应式 Fetch API，提供中止请求、在请求被触发之前拦截请求、在 url 更改时自动重新获取请求以及使用预定义选项创建您自己的 useFetch。

useWebSocket-响应式 WebSocket

Animation

useInterval-每隔一段时间响应式增加计数

useIntervalFn-带控件的 setInterval 包装器

useNow-响应式获取当前 Date 实例。

useRafFn-在每个 requestAnimationFrame 上调用函数。可控制暂停和恢复。

useTimeout-在给定时间后更新值。

useTimeoutFn-带控件的 setTimeout 包装器。

useTimestamp-响应式获取当前时间戳

useTransition-值之间的过度

Component

computedInject-combine computed and inject

templateRef-将 ref 绑定到模板元素的简写。

tryOnBeforeMount-安全执行 onBeforeMount。如果在组件生命周期内就调用 onBeforeMount()，如果不在就调用函数

tryOnBeforeUnmount-安全执行 onBeforeUnmount。如果在组件生命周期内，则调用 onBeforeUnmount()，如果不在，则什么都不做

tryOnMounted-安全执行 onMounted。如果在组件生命周期内，则调用 onMounted()，如果不在，则调用该函数

tryOnScopeDispose-安全执行 onScopeDispose。如果它在effect作用域生命周期内，则调用 onScopeDispose()，如果不在，则什么都不做

tryOnUnmounted-安全执行 onUnmounted。如果在组件生命周期内，则调用 onUnmounted()，如果不在，则什么都不做

unrefElement-取消对 dom 元素的引用。

useCurrentElement-获取当前组件的元素作为 ref。

useMounted-使用ref记录挂载状态

useTemplateRefsList-将 refs 绑定到 v-for 中的模板元素和组件的简写。

useVirtualList-轻松创建虚拟列表。虚拟列表（有时称为virtual scrollers）允许您高效地呈现大量的项。通过使用 wrapper 元素来模拟容器的完整高度，只呈现最少数量的DOM节点来显示 container 元素中的项。

useVModel-v-model 简写，props + emit -> ref

useVModels-props v-model 简写。可以把它想象成 toRefs(props)，但变化也会触发更新。

Watch

until-监听一次Promise后的变化

watchArray-监听数组的添加和删除

watchAtMost-指定 watch 触发的次数。

watchDebounced-防抖 watch

watchIgnorable-可忽略的 watch

watchOnce-watch 只触发一次。

watchPausable-可暂停的 watch

watchThrottled-节流 watch

watchTriggerable-可以手动触发的 watch

watchWithFilter-带事件过滤器的 watch 控件

whenever-监听真值的简写

Reactivity

computedAsync-computed for async functions

computedEager-eager computed without lazy evaluation

computedWithControl-explicitly define the dependencies of computed

extendRef-add extra attributes to Ref

reactify-converts plain functions into reactive functions

reactifyObject-apply reactify to an object

reactiveComputed-computed reactive object

reactiveOmit-reactively omit fields from a reactive object

reactivePick-reactively pick fields from a reactive object

refAutoReset-a ref which will be reset to the default value after some time

refDebounced-debounce execution of a ref value

refDefault-apply default value to a ref

refThrottled-throttle changing of a ref value

refWithControl-fine-grained controls over ref and its reactivity

resolveRef-normalize value/ref/getter to ref or computed

resolveUnref-get the value of value/ref/getter

syncRef-two-way refs synchronization

syncRefs-keep target refs in sync with a source ref

toReactive-converts ref to reactive

toRefs-extended toRefs that also accepts refs of an object

Array

useArrayEvery-响应式 Array.every

useArrayFilter-reactive Array.filter

useArrayFind-reactive Array.find

useArrayFindIndex-reactive Array.findIndex

useArrayFindLast-reactive Array.findLast

useArrayJoin-reactive Array.join

useArrayMap-reactive Array.map

useArrayReduce-reactive Array.reduce

useArraySome-reactive Array.some

useArrayUnique-reactive unique array

useSorted-reactive sort array

Time

useDateFormat-get the formatted date according to the string of tokens passed in

useTimeAgo-reactive time ago

Utilities

createEventHook-utility for creating event hooks

createUnrefFn-make a plain function accepting ref and raw values as arguments

get-shorthand for accessing ref.value

isDefined-non-nullish checking type guard for Ref

makeDestructurable-make isomorphic destructurable for object and array at the same time

set-shorthand for ref.value = x

useAsyncQueue-executes each asynchronous task sequentially and passes the current task result to the next task

useBase64-reactive base64 transforming

useCached-cache a ref with a custom comparator

useCloned-reactive clone of a ref

useConfirmDialog-creates event hooks to support modals and confirmation dialog chains

useCounter-basic counter with utility functions

useCycleList-cycle through a list of items

useDebounceFn-debounce execution of a function

useEventBus-a basic event bus

useMemoize-cache results of functions depending on arguments and keep it reactive

useOffsetPagination-reactive offset pagination

usePrevious-holds the previous value of a ref

useStepper-provides helpers for building a multi-step wizard interface

useSupported-sSR compatibility isSupported

useThrottleFn-throttle execution of a function

useTimeoutPoll-use timeout to poll something

useToggle-a boolean switcher with utility functions

useToNumber-reactively convert a string ref to number

useToString-reactively convert a ref to string

@Electron

useIpcRenderer-provides ipcRenderer and all of its APIs

useIpcRendererInvoke-reactive ipcRenderer.invoke API result

useIpcRendererOn-use ipcRenderer.on with ease and ipcRenderer.removeListener automatically on unmounted

useZoomFactor-reactive WebFrame zoom factor

useZoomLevel-reactive WebFrame zoom level

@Firebase

useAuth-reactive Firebase Auth binding

useFirestore-reactive Firestore binding

useRTDB-reactive Firebase Realtime Database binding

@Head

createHead-create the head manager instance.

useHead-update head meta tags reactively.

@Integrations

useAsyncValidator-wrapper for async-validator

useAxios-wrapper for axios

useChangeCase-reactive wrapper for change-case

useCookies-wrapper for universal-cookie

useDrauu-reactive instance for drauu

useFocusTrap-reactive wrapper for focus-trap

useFuse-easily implement fuzzy search using a composable with Fuse.js

useIDBKeyval-wrapper for idb-keyval

useJwt-wrapper for jwt-decode

useNProgress-reactive wrapper for nprogress

useQRCode-wrapper for qrcode

@Math

createGenericProjection-generic version of createProjection

createProjection-reactive numeric projection from one domain to another

logicAnd-AND condition for refs

logicNot-NOT condition for ref

logicOr-OR conditions for refs

useAbs-reactive Math.abs

useAverage-get the average of an array reactively

useCeil-reactive Math.ceil

useClamp-reactively clamp a value between two other values

useFloor-reactive Math.floor

useMath-reactive Math methods

useMax-reactive Math.max

useMin-reactive Math.min

usePrecision-reactively set the precision of a number

useProjection-reactive numeric projection from one domain to another

useRound-reactive Math.round

useSum-get the sum of an array reactively

useToFixed-reactive toFixed

useTrunc-reactive Math.trunc

@Motion

useElementStyle-sync a reactive object to a target element CSS styling

useElementTransform-sync a reactive object to a target element CSS transform.

useMotion-putting your components in motion.

useMotionProperties-access Motion Properties for a target element.

useMotionVariants-handle the Variants state and selection.

useSpring-spring animations.

@Router

useRouteHash-shorthand for a reactive route.hash

useRouteParams-shorthand for a reactive route.params

useRouteQuery-shorthand for a reactive route.query

@RxJS

from-/ fromEvent

toObserver-sugar function to convert a ref into an RxJS Observer

useObservable-use an RxJS Observable

useSubject-bind an RxJS Subject to a ref and propagate value changes both ways

useSubscription-use an RxJS Subscription without worrying about unsubscribing from it or creating memory leaks

@SchemaOrg

createSchemaOrg-create the schema.org manager instance.

useSchemaOrg-update schema.org reactively.

@Sound

useSound-play sound effects reactively.

Functions #

State

Elements

Browser

Sensors