Functions

useNetwork-响应式地获取网络状态。网络信息 API 提供了有关系统连接的信息，例如一般连接类型 (例如，“wifi”，“cellular” 等)。这可以用于根据用户的连接选择高清晰度内容或低清晰度内容。整个 API 由 NetworkInformation 接口的添加和 Navigator 接口的单个属性组成：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

useAnimate-响应式的 Web Animations API。

useInterval-在每个间隔上增加的响应式计数器

useIntervalFn-带有控制功能的 setInterval 包装器

useNow-响应式的当前日期实例。

useRafFn-在每次 requestAnimationFrame 上调用函数。具有暂停和恢复控制。

useTimeout-在一定时间后更新值，并带有控制功能。

useTimeoutFn-带有控制选项的 setTimeout 函数的封装

useTimestamp-响应式的当前时间戳

useTransition-值之间的过渡效果

Component

computedInject-结合 computed 和 inject 使用

createReusableTemplate-在组件作用域内定义并复用模板。

createTemplatePromise-将模板作为 Promise。适用于构建自定义对话框、模态框、提示框等。

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

tryOnBeforeMount-安全的 onBeforeMount。如果在组件生命周期内，调用 onBeforeMount()，如果不是，直接调用函数。

tryOnBeforeUnmount-安全的 onBeforeUnmount。如果在组件生命周期内，调用 onBeforeUnmount()，如果不是，不执行任何操作。

tryOnMounted-安全的 onMounted。如果在组件生命周期内，调用 onMounted()，如果不是，直接调用函数。

tryOnScopeDispose-安全的 onScopeDispose。如果在效果范围生命周期内，调用 onScopeDispose()，如果不是，不执行任何操作。

tryOnUnmounted-安全的 onUnmounted。如果在组件生命周期内，调用 onUnmounted()，如果不是，不执行任何操作。

unrefElement-从 ref 或 Vue 组件实例中检索基础 DOM 元素。

useCurrentElement-将当前组件的 DOM 元素作为 ref 返回。

useMounted-在 ref 中表示组件是否已挂载。

useTemplateRefsList-用于将 refs 绑定到 v-for 内的模板元素和组件的快捷方式。

useVirtualList-轻松创建虚拟列表。虚拟列表 (有时称为 _virtual scrollers_) 允许你高效地渲染大量项目。它们只渲染必要的最小数量的 DOM 节点，以通过使用 wrapper 元素模拟容器元素的完整高度来显示 container 元素中的项目。

useVModel-简化 v-model 绑定的简写方式，将 props + emit 转换为 ref

useVModels-props 的 v-model 绑定的简写方式。可以将其视为 toRefs(props)，但是对属性的更改也会触发 emit。

Watch

until-等待变化的一次性 Promise

watchArray-监视数组的添加和移除。

watchAtMost-watch 监听器带有触发次数限制。

watchDebounced-延迟触发的监听器

watchDeep-使用 { deep: true } 监听值的简写形式。

watchIgnorable-可忽略的监听器

watchImmediate-使用 { immediate: true } 监听值的简写形式。

watchOnce-仅触发一次的 watch。

watchPausable-可暂停的 watch

watchThrottled-节流式监视。

watchTriggerable-可手动触发的 Watch

watchWithFilter-带有额外 EventFilter 控制的 watch。

whenever-监视值为真的简写形式。

Reactivity

computedAsync-用于异步函数的计算属性

computedEager-即时计算的计算属性，没有延迟评估。

computedWithControl-显式定义计算属性的依赖关系。

extendRef-向 Ref 添加额外属性。

reactify-将普通函数转换为响应式函数。转换后的函数接受引用作为其参数，并返回一个 ComputedRef，具有正确的类型。

reactifyObject-将 reactify 应用于对象

reactiveComputed-响应式计算对象。与 computed 返回 ref 不同，reactiveComputed 返回一个响应式对象。

reactiveOmit-从响应式对象中动态地排除字段。

reactivePick-从响应式对象中动态地选择字段。

refAutoReset-一个在一段时间后将重置为默认值的 ref。

refDebounced-对 ref 的更新进行防抖。

refDefault-将默认值应用于 ref。

refThrottled-限制 ref 值的变化频率。

refWithControl-对 ref 及其响应性进行细粒度控制。

syncRef-双向引用同步。

syncRefs-将目标引用与源引用保持同步

toReactive-将 ref 转换为响应式对象。还可以创建一个 “可交换” 的响应式对象。

toRef-将值、ref 或 getter 规范化为 ref 或 computed。

toRefs-扩展了 toRefs，还接受对象引用的 refs。

toValue-获取值、ref 或 getter 的值。

Array

useArrayDifference-获取两个数组的差集的响应式结果

useArrayEvery-响应式 Array.every

useArrayFilter-reactive Array.filter

useArrayFind-响应式 Array.find。

useArrayFindIndex-响应式 Array.findIndex

useArrayFindLast-响应式 Array.findLast。

useArrayIncludes-响应式 Array.includes。

useArrayJoin-响应式 Array.join。

useArrayMap-响应式 Array.map。

useArrayReduce-响应式 Array.reduce。

useArraySome-响应式 Array.some。

useArrayUnique-响应式唯一数组。

useSorted-响应式排序数组

Time

useDateFormat-根据传入的令牌字符串获取格式化日期，灵感来自 dayjs。

useTimeAgo-响应式的相对时间。当时间发生变化时，自动更新相对时间字符串。

Utilities

createEventHook-用于创建事件钩子的实用工具

createUnrefFn-创建一个普通函数，接受 ref 和原始值作为参数。

get-用于访问 ref.value 的简写方式

isDefined-用于 Ref 的非空检查类型守卫。

makeDestructurable-使对象和数组具有等价的解构性能。详见这篇博文获取更多详情。

set-ref.value = x 的简写。

useAsyncQueue-依次执行每个异步任务，并将当前任务的结果传递给下一个任务

useBase64-响应式的 Base64 转换。支持 plain text，buffer，files，canvas，objects，maps，sets 和 images。

useCached-使用自定义比较器缓存一个 ref。

useCloned-对 ref 进行响应式克隆。默认情况下，它使用 JSON.parse(JSON.stringify()) 进行克隆。

useConfirmDialog-创建事件钩子以支持模态框和确认对话框链。

useCounter-基础计数器，带有工具函数。

useCycleList-循环遍历一个项目列表。

useDebounceFn-延迟执行函数。

useEventBus-一个基本的事件总线。

useMemoize-缓存依赖于参数的函数结果，并保持其响应性。它还可以用于异步函数，并将重用现有的 promises 来避免同时获取相同的数据。

useOffsetPagination-响应式的偏移分页。

usePrevious-保存 ref 的先前值。

useStepper-提供构建多步骤向导界面的辅助工具。

useSupported-sSR 兼容性检测 isSupported

useThrottleFn-节流执行函数。特别适用于限制事件处理程序在调整大小和滚动等事件上的执行频率。

useTimeoutPoll-使用超时来轮询某些内容。在最后一个任务完成后触发回调。

useToggle-一个带有实用功能的布尔切换器。

useToNumber-将字符串 ref 转换为数字。

useToString-将 ref 转换为字符串。

@Electron

useIpcRenderer-提供 ipcRenderer 及其所有 API。

useIpcRendererInvoke-响应式的 ipcRenderer.invoke API 结果。使异步操作看起来像同步的。

useIpcRendererOn-轻松使用 ipcRenderer.on，并在组件卸载时自动移除监听器 ipcRenderer.removeListener。

useZoomFactor-响应式的 WebFrame 缩放因子。

useZoomLevel-响应式的 WebFrame 缩放级别。

@Firebase

useAuth-响应式的 Firebase Auth 绑定。它提供了一个响应式的 user 和 isAuthenticated，因此你可以轻松地对用户的身份验证状态变化做出反应。

useFirestore-响应式的 Firestore 绑定。使得始终将本地数据与远程数据库同步变得简单直观。

useRTDB-响应式的 Firebase 实时数据库绑定。使得始终将本地数据与远程数据库同步变得简单直观。

@Head

createHead-create the head manager instance.

useHead-update head meta tags reactively.

@Integrations

useAsyncValidator-对 async-validator 的封装。

useAxios-对 axios 的封装。

useChangeCase-对 change-case 的响应式封装。

useCookies-对 universal-cookie 的包装。

useDrauu-这是 drauu 的响应式实例。

useFocusTrap-这是 focus-trap 的响应式封装。

useFuse-使用 Fuse.js 组合式轻松实现模糊搜索。

useIDBKeyval-idb-keyval 的封装。

useJwt-jwt-decode 的封装。

useNProgress-nprogress 的响应式封装。

useQRCode-qrcode 的封装。

useSortable-sortable 的封装。

@Math

createGenericProjection-createGenericProjection 是 createProjection 的通用版本。它接受一个自定义的投影函数，用于映射任意类型的域。

createProjection-从一个域映射到另一个域的响应式数值投影。

logicAnd-AND 条件的响应式封装。

logicNot-NOT 条件的响应式封装。

logicOr-OR 条件的响应式封装。

useAbs-响应式 Math.abs。

useAverage-响应式地获取数组的平均值。

useCeil-响应式 Math.ceil

useClamp-在两个其他值之间响应式地夹取一个值。

useFloor-响应式 Math.floor

useMath-响应式 Math 方法

useMax-响应式 Math.max。

useMin-响应式 Math.min。

usePrecision-在数字上响应式的设置精度。

useProjection-从一个域映射到另一个域的响应式数值投影。

useRound-响应式 Math.round。

useSum-响应式地获取数组的总和。

useTrunc-响应式 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-对响应式的 route.hash 的简写。

useRouteParams-对响应式的 route.params 的简写。

useRouteQuery-对响应式的 route.query 的简写。

@RxJS

from-rxJS 的 from() 和 fromEvent() 的包装器，使它们能够接受 ref。

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

useExtractedObservable-从一个或多个组合式中提取并使用 RxJS Observable，返回一个 ref，并在组件卸载时自动取消订阅。

useObservable-使用 RxJS Observable，返回一个 ref，并在组件卸载时自动取消订阅。

useSubject-将 RxJS Subject 绑定到一个 ref 上，并在两者之间传播值变化。

useSubscription-使用 RxJS Subscription，无需担心取消订阅或创建内存泄漏。

watchExtractedObservable-监视从一个或多个组合式中提取的 RxJS Observable 的值。

@SchemaOrg

createSchemaOrg-create the schema.org manager instance.

useSchemaOrg-update schema.org reactively.

@Sound

useSound-play sound effects reactively.

Functions ​

State

Elements

Browser

Sensors