Functions

Core

Add-ons

Sort by

Filters

Has ComponentHas Directive

State

createGlobalState-在全域範圍中保持狀態，以便在 Vue 實例之間重複使用

createInjectionState-建立可以注入到組件中的全域狀態

createSharedComposable-使可組合函式可與多個 Vue 實例一起使用

injectLocal-擴展了 inject，使其能夠調用 provideLocal 以在同一組件中提供值

provideLocal-擴展了 provide，使其能夠調用 injectLocal 以在同一組件中獲取值

useAsyncState-響應式非同步狀態

useDebouncedRefHistory-帶有防抖過濾器的 useRefHistory 的簡寫

useLastChanged-記錄上次更改的時間戳記

useLocalStorage-響應式 LocalStorage

useManualRefHistory-當使用者調用 commit() 時，手動追蹤 ref 的更改歷史記錄

useRefHistory-追蹤 ref 的更改歷史記錄

useSessionStorage-響應式 SessionStorage

useStorage-建立一個響應式 ref，可用於訪問和修改 LocalStorage 或 SessionStorage

useStorageAsync-具有非同步支援的響應式儲存

useThrottledRefHistory-帶有節流過濾器的 useRefHistory 的簡寫

Elements

useActiveElement-響應式 document.activeElement

useDocumentVisibility-響應式追蹤 document.visibilityState

useDraggable-使元素可拖曳

useDropZone-建立一個可以放置檔案的區域

useElementBounding-HTML 元素的響應式 邊界框

useElementSize-HTML 元素的響應式大小

useElementVisibility-追蹤元素在視窗中的可見性

useIntersectionObserver-偵測目標元素的可見性

useMouseInElement-與元素相關的響應式滑鼠位置

useMutationObserver-監看對 DOM 樹所做的更改

useParentElement-獲取給定元素的父元素

useResizeObserver-報告元素內容或邊框盒尺寸的更改

useWindowFocus-使用 window.onfocus 和 window.onblur 事件響應式追蹤視窗焦點

useWindowScroll-響應式視窗滾動

useWindowSize-響應式視窗大小

Browser

useBluetooth-響應式 Web Bluetooth API

useBreakpoints-響應式視窗斷點

useBroadcastChannel-響應式 BroadcastChannel API

useBrowserLocation-響應式瀏覽器位置

useClipboard-響應式 Clipboard API

useClipboardItems-響應式 Clipboard API

useColorMode-具有自動資料持久性的響應式色彩模式（深色/淺色/自訂）

useCssVar-操作 CSS 變數

useDark-具有自動資料持久性的響應式深色模式

useEventListener-輕鬆使用 EventListener

useEyeDropper-響應式 EyeDropper API

useFavicon-響應式網站圖示

useFileDialog-輕鬆開啟檔案對話方塊

useFileSystemAccess-使用 FileSystemAccessAPI 建立、讀取和寫入本機檔案

useFullscreen-響應式 Fullscreen API

useGamepad-為 Gamepad API 提供響應式綁定

useImage-在瀏覽器中響應式載入圖片

useMediaControls-用於 audio 和 video 元素的響應式媒體控制

useMediaQuery-響應式 Media Query

useMemory-響應式記憶體資訊

useObjectUrl-表示物件的響應式 URL

usePerformanceObserver-觀察效能指標

usePermission-響應式 Permissions API

usePreferredColorScheme-響應式 prefers-color-scheme 媒體查詢

usePreferredContrast-響應式 prefers-contrast 媒體查詢

usePreferredDark-響應式深色主題偏好設定

usePreferredLanguages-響應式 Navigator Languages

usePreferredReducedMotion-響應式 prefers-reduced-motion 媒體查詢

usePreferredReducedTransparency-響應式 prefers-reduced-transparency 媒體查詢

useScreenOrientation-響應式 Screen Orientation API

useScreenSafeArea-響應式 env(safe-area-inset-*)

useScriptTag-建立 script 標籤

useShare-響應式 Web Share API

useSSRWidth-用於設定全域視窗寬度，該寬度將在呈現依賴於視窗寬度的 SSR 組件時使用，例如 useMediaQuery 或 useBreakpoints

useStyleTag-在 head 中注入響應式 style 元素

useTextareaAutosize-根據內容自動更新 textarea 的高度

useTextDirection-元素文字的響應式 dir

useTitle-響應式文件標題

useUrlSearchParams-響應式 URLSearchParams

useVibrate-響應式 Vibration API

useWakeLock-響應式 Screen Wake Lock API

useWebNotification-響應式 Notification

useWebWorker-簡單的 Web Workers 註冊和通訊

useWebWorkerFn-執行耗時的函式，而不會阻塞 UI

Sensors

onClickOutside-監聽元素外部的點擊

onElementRemoval-當元素或任何包含它的元素被移除時觸發

onKeyStroke-監聽鍵盤按鍵

onLongPress-監聽元素上的長按

onStartTyping-當使用者開始在不可編輯的元素上輸入時觸發

useBattery-響應式 Battery Status API

useDeviceMotion-響應式 DeviceMotionEvent

useDeviceOrientation-響應式 DeviceOrientationEvent

useDevicePixelRatio-響應式追蹤 window.devicePixelRatio

useDevicesList-響應式 enumerateDevices 列出可用的輸入/輸出裝置

useDisplayMedia-響應式 mediaDevices.getDisplayMedia 串流

useElementByPoint-依點擊位置的響應式元素

useElementHover-響應式元素的懸停狀態

useFocus-用於追蹤或設定 DOM 元素焦點狀態的響應式工具

useFocusWithin-用於追蹤元素或其後代之一是否具有焦點的響應式工具

useFps-響應式 FPS（每秒幀數）

useGeolocation-響應式 Geolocation API

useIdle-追蹤使用者是否處於非活動狀態

useInfiniteScroll-元素的無限滾動

useKeyModifier-響應式 Modifier State

useMagicKeys-響應式按鍵按下狀態

useMouse-響應式滑鼠位置

useMousePressed-響應式滑鼠按下狀態

useNavigatorLanguage-響應式 navigator.language

useNetwork-響應式 網路狀態

useOnline-響應式線上狀態

usePageLeave-響應式狀態，顯示滑鼠是否離開頁面

useParallax-輕鬆建立視差效果

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 伺服器的持久連線

useFetch-響應式 Fetch API 提供中止請求的能力

useWebSocket-響應式 WebSocket 客戶端

Animation

useAnimate-響應式 Web Animations API

useInterval-響應式計數器在每個間隔遞增

useIntervalFn-帶有控制項的 setInterval 包裝器

useNow-響應式目前 Date 實例

useRafFn-在每個 requestAnimationFrame 上調用函式

useTimeout-在給定時間後使用控制項更新值

useTimeoutFn-帶有控制項的 setTimeout 包裝器

useTimestamp-響應式目前時間戳記

useTransition-值之間的轉換

Component

computedInject-合併 computed 和 inject

createReusableTemplate-在組件範圍內定義和重複使用模板

createTemplatePromise-作為 Promise 的模板

templateRef-用於將 ref 綁定到模板元素的簡寫

tryOnBeforeMount-安全的 onBeforeMount

tryOnBeforeUnmount-安全的 onBeforeUnmount

tryOnMounted-安全的 onMounted

tryOnScopeDispose-安全的 onScopeDispose

tryOnUnmounted-安全的 onUnmounted

unrefElement-從 Vue ref 或組件實例中檢索底層 DOM 元素

useCurrentElement-將目前組件的 DOM 元素作為 ref 獲取

useMounted-ref 中的掛載狀態

useTemplateRefsList-用於將 ref 綁定到 v-for 內部的模板元素和組件的簡寫

useVirtualList-輕鬆建立虛擬列表

useVModel-v-model 綁定的簡寫

useVModels-props v-model 綁定的簡寫

Watch

until-承諾的一次性監看更改

watchArray-監看具有新增和移除的陣列

watchAtMost-觸發次數的 watch

watchDebounced-防抖監看

watchDeep-使用 {deep: true} 監看值的簡寫

watchIgnorable-可忽略的監看

watchImmediate-使用 {immediate: true} 監看值的簡寫

watchOnce-僅觸發一次的 watch

watchPausable-可暫停的監看

watchThrottled-節流監看

watchTriggerable-可以手動觸發的監看

watchWithFilter-具有額外 EventFilter 控制項的 watch

whenever-用於監看值是否為真值的簡寫

Reactivity

computedAsync-用於非同步函式的 computed

computedEager-沒有延遲評估的迫切 computed

computedWithControl-明確定義 computed 的依賴項

createRef-根據 deep 參數傳回 deepRef 或 shallowRef

extendRef-向 Ref 新增額外屬性

reactify-將純函式轉換為響應式函式

reactifyObject-將 reactify 應用於物件

reactiveComputed-computed 響應式物件

reactiveOmit-從響應式物件中響應式省略欄位

reactivePick-從響應式物件中響應式選取欄位

refAutoReset-一個 ref，在一段時間後將重置為預設值

refDebounced-防抖 ref 值的執行

refDefault-將預設值應用於 ref

refThrottled-節流 ref 值的更改

refWithControl-對 ref 及其響應性進行精細控制

syncRef-雙向 ref 同步

syncRefs-保持目標 ref 與來源 ref 同步

toReactive-將 ref 轉換為響應式

toRef-將 value/ref/getter 正規化為 ref 或 computed

toRefs-擴展的 toRefs，也接受物件的 ref

toValue-獲取 value/ref/getter 的值

Array

useArrayDifference-響應式獲取兩個陣列的陣列差異

useArrayEvery-響應式 Array.every

useArrayFilter-響應式 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

useCountdown-useIntervalFn 的封裝器，提供倒數計時器

useDateFormat-根據傳入的符記字串取得格式化的日期

useTimeAgo-響應式時間差

Utilities

createEventHook-用於建立事件鉤子的工具

createUnrefFn-建立接受 ref 和原始值作為參數的純函式

get-用於存取 ref.value 的簡寫

isDefined-Ref 的非空值檢查型別保護

makeDestructurable-同時為物件和陣列建立同構解構

set-ref.value = x 的簡寫

useAsyncQueue-依序執行每個非同步任務，並將當前任務結果傳遞給下一個任務

useBase64-響應式 base64 轉換

useCached-使用自訂比較器快取 ref

useCloned-ref 的響應式複製

useConfirmDialog-建立事件鉤子以支援模組和確認對話框鏈

useCounter-具有實用函式的基本計數器

useCycleList-循環瀏覽項目列表

useDebounceFn-延遲函式的執行

useEventBus-基本事件總線

useMemoize-根據參數快取函式結果並保持響應式

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 綁定

useFirestore-響應式 Firestore 綁定

useRTDB-響應式 Firebase Realtime Database 綁定

@Head

createHead-建立 head 管理器實例。

useHead-響應式地更新 head 標籤。

@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-createProjection 的通用版本

createProjection-從一個域到另一個域的響應式數值投影

logicAnd-refs 的 AND 條件

logicNot-ref 的 NOT 條件

logicOr-refs 的 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-將響應式物件同步到目標元素的 CSS 樣式

useElementTransform-將響應式物件同步到目標元素的 CSS 轉換。

useMotion-讓您的組件動起來。

useMotionProperties-存取目標元素的 Motion Properties。

useMotionVariants-處理 Variants 狀態和選取。

useSpring-彈簧動畫。

@Router

useRouteHash-響應式 route.hash 的簡寫

useRouteParams-響應式 route.params 的簡寫

useRouteQuery-響應式 route.query 的簡寫

@RxJS

from-RxJS 的 from() 和 fromEvent() 的封裝器，使其可以接受 ref

toObserver-將 ref 轉換為 RxJS Observer 的 sugar 函式

useExtractedObservable-使用從一個或多個組合式函式中提取的 RxJS Observable

useObservable-使用 RxJS Observable

useSubject-將 RxJS Subject 綁定到 ref，並雙向傳播值變更

useSubscription-使用 RxJS Subscription，無需擔心取消訂閱或產生記憶體洩漏

watchExtractedObservable-監看從一個或多個組合式函式中提取的 RxJS Observable 的值

@SchemaOrg

createSchemaOrg-建立 schema.org 管理器實例。

useSchemaOrg-響應式地更新 schema.org。

@Sound

useSound-響應式地播放音效。