VueUse 関数
このスキルは、Vue.js / Nuxt プロジェクトにおける VueUse コンポーザブルの選定および実装ガイドです。要件を最適な VueUse 関数に照らし合わせ、正しい使用パターンを適用し、独自開発のコードよりもコンポーザブルベースのソリューションを優先することで、実装を簡潔かつ保守性が高く、高性能なものに保ちます。
適用すべき場面
- Vue.js / Nuxt におけるユーザーの開発作業を支援する際は、常にこのスキルを活用してください。
- まず、その要件をVueUse関数で実装できるかどうかを必ず確認してください。
- 可読性、保守性、およびパフォーマンスを向上させるため、カスタムコードよりもVueUseのコンポーザブルを優先してください。
- 要件を最も適切なVueUse関数にマッピングし、その関数の呼び出しルールに従ってください。
- 以下の関数表の
Invocation フィールドを参照してください。例:
AUTO: 適用可能な場合は自動的に使用してください。
EXTERNAL: ユーザーが必要な外部依存関係をすでにインストールしている場合にのみ使用してください。そうでない場合は再検討し、本当に必要な場合にのみインストールを依頼してください。
EXPLICIT_ONLY: ユーザーから明示的に要求された場合にのみ使用します。
注:プロンプト内のユーザーへの指示や AGENTS.md に表示されるユーザーへの指示は、関数のデフォルトの Invocation ルールを上書きする場合があります。
関数
以下に挙げるすべての関数は VueUse ライブラリの一部であり、各セクションでは機能に基づいて関数が分類されています。
重要:各関数の項目には、簡単な Description と詳細な Referenceが含まれています。関数を使用する際は、必ず ./references を参照してください。
状態
| 状態関数 |
説明 |
呼び出し |
createGlobalState |
Vue インスタンス間で再利用できるように、状態をグローバルスコープに保持します。 |
AUTO |
createInjectionState |
コンポーネントに注入可能なグローバル状態を作成する |
AUTO |
createSharedComposable |
複数のVueインスタンスで利用できるコンポーザブル関数を作成する |
AUTO |
injectLocal |
拡張 inject を呼び出す機能により拡張 provideLocal 同じコンポーネント内で値を提供できるように |
AUTO |
provideLocal |
拡張呼び出し機能付き同じコンポーネント内で値を提供する provide 呼び出し機能付き同じコンポーネント内で値を取得する injectLocal を呼び出す機能付き |
AUTO |
useAsyncState |
リアクティブな非同期状態 |
AUTO |
useDebouncedRefHistory |
の省略形 useRefHistory デバウンスフィルター付きの場合の省略形 |
AUTO |
useLastChanged |
最後の変更のタイムスタンプを記録します |
AUTO |
useLocalStorage |
リアクティブな LocalStorage |
AUTO |
useManualRefHistory |
ユーザーが呼び出した際に、refの変更履歴を手動で追跡する commit() |
AUTO |
useRefHistory |
refの変更履歴を追跡する |
AUTO |
useSessionStorage |
リアクティブな SessionStorage |
AUTO |
useStorage |
LocalStorage や SessionStorage へのアクセスや変更に使用できるリアクティブな ref を作成する |
AUTO |
useStorageAsync |
非同期対応のリアクティブ・ストレージ |
AUTO |
useThrottledRefHistory |
の省略形 useRefHistory スロットリングフィルター付き |
AUTO |
要素
| 機能 |
説明 |
呼び出し |
useActiveElement |
リアクティブ document.activeElement |
AUTO |
useDocumentVisibility |
リアクティブに追跡する document.visibilityState |
AUTO |
useDraggable |
要素をドラッグ可能にする |
AUTO |
useDropZone |
ファイルをドロップできるゾーンを作成する |
AUTO |
useElementBounding |
HTML要素のリアクティブなバウンディングボックス |
AUTO |
useElementSize |
HTML要素のリアクティブなサイズ |
AUTO |
useElementVisibility |
ビューポート内の要素の可視性を追跡する |
AUTO |
useIntersectionObserver |
対象要素の表示状態の変化を検出します |
AUTO |
useMouseInElement |
要素に関連するリアクティブなマウス位置 |
AUTO |
useMutationObserver |
DOMツリーへの変更を監視する |
AUTO |
useParentElement |
指定された要素の親要素を取得する |
AUTO |
useResizeObserver |
要素のコンテンツまたはボーダーボックスの寸法に変更があったことを報告する |
AUTO |
useWindowFocus |
ウィンドウのフォーカスをリアクティブに追跡する window.onfocus および window.onblur イベント |
AUTO |
useWindowScroll |
リアクティブなウィンドウスクロール |
AUTO |
useWindowSize |
ウィンドウサイズの自動調整 |
AUTO |
ブラウザ
| 機能 |
説明 |
呼び出し |
useBluetooth |
リアクティブ Web Bluetooth API |
AUTO |
useBreakpoints |
リアクティブ・ビューポート・ブレークポイント |
AUTO |
useBroadcastChannel |
リアクティブ BroadcastChannel API |
AUTO |
useBrowserLocation |
リアクティブなブラウザのロケーション |
AUTO |
useClipboard |
リアクティブ・クリップボード API |
AUTO |
useClipboardItems |
リアクティブ・クリップボードAPI |
AUTO |
useColorMode |
データの自動永続化機能を備えたリアクティブカラーモード(ダーク/ライト/カスタム) |
AUTO |
useCssSupports |
SSR 対応かつリアクティブ CSS.supports |
AUTO |
useCssVar |
CSS変数の操作 |
AUTO |
useDark |
データの自動永続化機能を備えたリアクティブなダークモード |
AUTO |
useEventListener |
EventListenerを簡単に使用 |
AUTO |
useEyeDropper |
リアクティブなカラーピッカー API |
AUTO |
useFavicon |
リアクティブなファビコン |
AUTO |
useFileDialog |
ファイルダイアログを簡単に開く |
AUTO |
useFileSystemAccess |
FileSystemAccessAPI を使用してローカルファイルを作成・読み取り・書き込みを行う |
AUTO |
useFullscreen |
リアクティブなフルスクリーンAPI |
AUTO |
useGamepad |
Gamepad API 向けのリアクティブ・バインディングを提供します |
AUTO |
useImage |
ブラウザで画像をリアクティブに読み込む |
AUTO |
useMediaControls |
両方のためのリアクティブなメディアコントロール audio および video 要素 |
AUTO |
useMediaQuery |
リアクティブ・メディアクエリ |
AUTO |
useMemory |
リアクティブメモリ情報 |
AUTO |
useObjectUrl |
オブジェクトを表すリアクティブURL |
AUTO |
usePerformanceObserver |
パフォーマンス指標の監視 |
AUTO |
usePermission |
リアクティブな権限API |
AUTO |
usePreferredColorScheme |
Reactive の「prefer-color-scheme」メディアクエリ |
AUTO |
usePreferredContrast |
Reactive の prefers-contrast メディアクエリ |
AUTO |
usePreferredDark |
リアクティブなダークテーマ設定 |
AUTO |
usePreferredLanguages |
リアクティブ・ナビゲーターの言語設定 |
AUTO |
usePreferredReducedMotion |
Reactive の「動きを最小限に抑える」メディアクエリ |
AUTO |
usePreferredReducedTransparency |
Reactive の「prefer-reduced-transparency」メディアクエリ |
AUTO |
useScreenOrientation |
リアクティブ Screen Orientation API |
AUTO |
useScreenSafeArea |
リアクティブ env(safe-area-inset-*) |
AUTO |
useScriptTag |
スクリプトタグを作成します |
AUTO |
useShare |
リアクティブWeb Share API |
AUTO |
useSSRWidth |
ビューポート幅に依存するSSRコンポーネント(例: useMediaQuery または useBreakpoints |
AUTO |
useStyleTag |
head要素内にリアクティブな style 要素をheadに挿入する |
AUTO |
useTextareaAutosize |
コンテンツに応じてtextareaの高さを自動的に更新する |
AUTO |
useTextDirection |
要素のテキストのリアクティブディレクトリ |
AUTO |
useTitle |
ドキュメントのタイトルをリアクティブに更新する |
AUTO |
useUrlSearchParams |
Reactive URLSearchParams |
AUTO |
useVibrate |
リアクティブ振動API |
AUTO |
useWakeLock |
リアクティブ・スクリーン・ウェイクロック API |
AUTO |
useWebNotification |
リアクティブ通知 |
AUTO |
useWebWorker |
Web Workersの簡単な登録と通信 |
AUTO |
useWebWorkerFn |
UIをブロックせずに負荷の高い関数を実行する |
AUTO |
センサー
| 関数 |
説明 |
呼び出し |
onClickOutside |
要素の外側でのクリックを監視する |
AUTO |
onElementRemoval |
その要素、またはそれを含む任意の要素がDOMから削除されたときに発火します。 |
AUTO |
onKeyStroke |
キーボードのキー入力を監視する |
AUTO |
onLongPress |
要素の長押しをリッスンする |
AUTO |
onStartTyping |
ユーザーが編集不可の要素で入力を開始したときに発火する |
AUTO |
useBattery |
リアクティブ・バッテリー・ステータス API |
AUTO |
useDeviceMotion |
リアクティブな DeviceMotionEvent |
AUTO |
useDeviceOrientation |
リアクティブ DeviceOrientationEventAUTO |
AUTO |
useDevicePixelRatio |
リアクティブに追跡 window.devicePixelRatio |
AUTO |
useDevicesList |
リアクティブな enumerateDevices:利用可能な入出力デバイスの一覧表示 |
AUTO |
useDisplayMedia |
リアクティブ mediaDevices.getDisplayMedia ストリーミング |
AUTO |
useElementByPoint |
リアクティブ要素ごとのポイント単位 |
AUTO |
useElementHover |
リアクティブ要素のホバー状態 |
AUTO |
useFocus |
DOM要素のフォーカス状態を追跡または設定するためのリアクティブユーティリティ |
AUTO |
useFocusWithin |
要素またはその子要素のいずれかがフォーカスされているかどうかを追跡するリアクティブユーティリティ |
AUTO |
useFps |
リアクティブなFPS(1秒あたりのフレーム数) |
AUTO |
useGeolocation |
リアクティブな位置情報API |
AUTO |
useIdle |
ユーザーが非アクティブ状態にあるかどうかを追跡します |
AUTO |
useInfiniteScroll |
要素の無限スクロール |
AUTO |
useKeyModifier |
リアクティブ修飾子の状態 |
AUTO |
useMagicKeys |
リアクティブなキー押下状態 |
AUTO |
useMouse |
リアクティブマウス位置 |
AUTO |
useMousePressed |
リアクティブマウス押下状態 |
AUTO |
useNavigatorLanguage |
ナビゲーターの言語への反応 |
AUTO |
useNetwork |
リアクティブ マウス押下状態 |
AUTO |
useOnline |
リアクティブ オンライン状態 |
AUTO |
usePageLeave |
マウスがページから離れたかどうかを示すリアクティブ状態 |
AUTO |
useParallax |
パララックス効果を簡単に作成 |
AUTO |
usePointer |
リアクティブなポインタの状態 |
AUTO |
usePointerLock |
ポインタのロックを動的に反映 |
AUTO |
usePointerSwipe |
PointerEvents に基づくリアクティブなスワイプ検出 |
AUTO |
useScroll |
リアクティブなスクロール位置と状態 |
AUTO |
useScrollLock |
要素のスクロールをロックする |
AUTO |
useSpeechRecognition |
リアクティブな音声認識 |
AUTO |
useSpeechSynthesis |
リアクティブな音声合成 |
AUTO |
useSwipe |
以下に基づくリアクティブ・スワイプ検出 TouchEvents |
AUTO |
useTextSelection |
以下に基づいてユーザーのテキスト選択を動的に追跡 Window.getSelection |
AUTO |
useUserMedia |
リアクティブ mediaDevices.getUserMedia ストリーミング |
AUTO |
ネットワーク
| 関数 |
説明 |
呼び出し |
useEventSource |
EventSource または Server-Sent-Events インスタンスが、HTTP サーバーへの永続的な接続を開きます。 |
AUTO |
useFetch |
Reactive Fetch API は、リクエストを中止する機能を提供します。 |
AUTOReactive Fetch API には、リクエストを中止する機能があります。 |
useWebSocket |
リアクティブWebSocketクライアント |
AUTO |
アニメーション
| 関数 |
説明 |
呼び出し |
useAnimate |
リアクティブWebアニメーションAPI |
AUTO |
useInterval |
各インターバルごとに値が増加するリアクティブカウンター |
AUTO |
useIntervalFn |
用ラッパー setInterval 用ラッパー(コントロール付き) |
AUTO |
useNow |
リアクティブ電流 Date インスタンス |
AUTO |
useRafFn |
毎回の呼び出しで関数を実行 requestAnimationFrame |
AUTO |
useTimeout |
リアクティブ値が true 指定された時間経過後に |
AUTO |
useTimeoutFn |
以下のためのラッパー setTimeout 制御機能付き |
AUTO |
useTimestamp |
リアクティブ電流のタイムスタンプ |
AUTO |
useTransition |
値間の遷移 |
AUTO |
コンポーネント
| Function |
説明 |
呼び出し |
computedInject |
結合 computed および inject |
AUTO |
createReusableTemplate |
コンポーネントスコープ内でテンプレートを定義し、再利用する |
AUTO |
createTemplatePromise |
Promise としてのテンプレート |
AUTO |
templateRef |
ref をテンプレート要素にバインドするための短縮表記 |
AUTO |
tryOnBeforeMount |
安全 onBeforeMount |
AUTO |
tryOnBeforeUnmount |
安全 onBeforeUnmount |
AUTO |
tryOnMounted |
安全 onMounted |
AUTO |
tryOnScopeDispose |
安全 onScopeDispose |
AUTO |
tryOnUnmounted |
安全 onUnmounted |
AUTO |
unrefElement |
Vueのrefまたはコンポーネントインスタンスから、基になるDOM要素を取得します |
AUTO |
useCurrentElement |
現在のコンポーネントのDOM要素をrefとして取得する |
AUTO |
useMounted |
ref 内のマウント済み状態 |
AUTO |
useTemplateRefsList |
ref をテンプレート要素や内部のコンポーネントにバインドするための短縮表記 v-for |
AUTO |
useVirtualList |
仮想リストを簡単に作成 |
AUTO |
useVModel |
v-modelバインディングの省略形 |
AUTO |
useVModels |
propsのv-modelバインディングの省略形 |
AUTO |
Watch
| 関数 |
説明 |
呼び出し |
until |
変更に対するワンタイム監視の約束 |
AUTO |
watchArray |
追加・削除がある配列を監視する |
AUTO |
watchAtMost |
watch トリガーされた回数付き |
AUTO |
watchDebounced |
デバウンス処理済みの監視 |
AUTO |
watchDeep |
値の監視の省略形、以下の条件付きで {deep: true} |
AUTO |
watchIgnorable |
無視可能な監視 |
AUTO |
watchImmediate |
値の監視を行うための省略形。 {immediate: true} |
AUTO |
watchOnce |
値の監視を行う際の省略形 { once: true } |
AUTO |
watchPausable |
一時停止可能なウォッチ |
AUTO |
watchThrottled |
スロットリングされたウォッチ |
AUTO |
watchTriggerable |
手動で起動できるウォッチ |
AUTO |
watchWithFilter |
watch EventFilter コントロールが追加されたもの |
AUTO |
whenever |
値が真となることを監視する略記法 |
AUTO |
リアクティブ性
| 関数 |
説明 |
呼び出し |
computedAsync |
非同期関数に対して計算される |
AUTO |
computedEager |
遅延評価を行わずに即時計算される |
AUTO |
computedWithControl |
computed の依存関係を明示的に定義する |
AUTO |
createRef |
を返す deepRef または shallowRef を返します。 deep param |
AUTO |
extendRef |
Refに追加の属性を追加する |
AUTORefに追加の属性を追加します。 |
reactify |
プレーンな関数をリアクティブ関数に変換する |
AUTO |
reactifyObject |
適用 reactify をオブジェクトに適用する |
AUTO |
reactiveComputed |
計算済みリアクティブオブジェクト |
AUTO |
reactiveOmit |
リアクティブオブジェクトからフィールドをリアクティブに除外する |
AUTO |
reactivePick |
リアクティブオブジェクトからフィールドをリアクティブに選択する |
AUTO |
refAutoReset |
一定時間が経過するとデフォルト値にリセットされる参照 |
AUTO |
refDebounced |
ref値の実行をデバウンスする |
AUTO |
refDefault |
refにデフォルト値を適用する |
AUTO |
refManualReset |
手動リセット機能を持つrefを作成する |
AUTO |
refThrottled |
リファレンス値の変更を制限する |
AUTO |
refWithControl |
基準値とその反応性に対するきめ細かな制御 |
AUTO |
syncRef |
リファレンスの双方向同期 |
AUTO |
syncRefs |
ターゲット参照をソース参照と同期させる |
AUTO |
toReactive |
リファレンスをリアクティブに変換する |
AUTO |
toRef |
値/参照/ゲッターを次のように正規化する ref または computed |
EXPLICIT_ONLY |
toRefs |
拡張 toRefs オブジェクトの参照も受け入れる |
AUTO |
配列
| 関数 |
説明 |
呼び出し |
useArrayDifference |
リアクティブに 2 つの配列の差分を取得する |
AUTO |
useArrayEvery |
リアクティブ Array.every |
AUTO |
useArrayFilter |
リアクティブ Array.filter |
AUTO |
useArrayFind |
リアクティブ Array.find |
AUTO |
useArrayFindIndex |
リアクティブ Array.findIndex |
AUTO |
useArrayFindLast |
リアクティブ Array.findLast |
AUTO |
useArrayIncludes |
リアクティブ Array.includes |
AUTO |
useArrayJoin |
リアクティブ Array.join |
AUTO |
useArrayMap |
リアクティブ Array.map |
AUTO |
useArrayReduce |
リアクティブ Array.reduce |
AUTO |
useArraySome |
リアクティブ Array.some |
AUTO |
useArrayUnique |
リアクティブ・ユニーク・アレイ |
AUTO |
useSorted |
リアクティブ・ソート配列 |
AUTO |
時間
| 関数 |
説明 |
呼び出し |
useCountdown |
秒単位のリアクティブ・カウントダウンタイマー |
AUTO |
useDateFormat |
渡されたトークンの文字列に基づいて、フォーマット済みの日付を取得する |
AUTO |
useTimeAgo |
リアクティブな「経過時間」 |
AUTO |
useTimeAgoIntl |
i18n 対応の「Reactive time ago」 |
AUTO |
ユーティリティ
| 関数 |
説明 |
呼び出し |
createDisposableDirective |
使い捨てディレクティブを作成するためのユーティリティ |
AUTO |
createEventHook |
イベントフックを作成するためのユーティリティ |
AUTO |
createUnrefFn |
参照値および生値を引数として受け取る単純な関数を作成する |
AUTO |
get |
にアクセスするための短縮表記 ref.value |
EXPLICIT_ONLY |
isDefined |
Ref に対する nullish チェックを行わない型ガード |
AUTO |
makeDestructurable |
オブジェクトと配列に対して、同時に同型かつ破棄可能にする |
AUTO |
set |
の省略形 ref.value = x |
EXPLICIT_ONLY |
useAsyncQueue |
各非同期タスクを順次実行し、現在のタスクの結果を次のタスクに渡す |
AUTO |
useBase64 |
リアクティブな base64 変換 |
AUTO |
useCached |
カスタム比較子を使用した参照のキャッシュ |
AUTO |
useCloned |
refのリアクティブクローン |
AUTO |
useConfirmDialog |
モーダルや確認ダイアログの連鎖をサポートするためのイベントフックを作成する |
AUTO |
useCounter |
ユーティリティ関数を備えた基本的なカウンター |
AUTO |
useCycleList |
項目のリストを順に処理する |
AUTO |
useDebounceFn |
関数の実行におけるデバウンス |
AUTO |
useEventBus |
基本的なイベントバス |
AUTO |
useMemoize |
引数に応じて関数の結果をキャッシュし、リアクティブ性を維持する |
AUTO |
useOffsetPagination |
リアクティブなオフセットページネーション |
AUTO |
usePrevious |
refの前の値を保持する |
AUTO |
useStepper |
多段階ウィザードインターフェースを構築するためのヘルパーを提供する |
AUTO |
useSupported |
SSRとの互換性 isSupported |
AUTO |
useThrottleFn |
関数の実行をスロットルする |
AUTO |
useTimeoutPoll |
タイムアウトを使用して何かをポーリングする |
AUTO |
useToggle |
ユーティリティ関数を備えたブール値切り替え機能 |
AUTO |
useToNumber |
文字列参照をリアクティブに数値に変換する |
AUTO |
useToString |
参照をリアクティブに文字列に変換する |
AUTO |
@Electron
| 関数 |
説明 |
呼び出し |
useIpcRenderer |
ipcRenderer およびそのすべての API に Vue のリアクティブ性を提供します |
EXTERNAL |
useIpcRendererInvoke |
リアクティブな ipcRenderer.invoke API の結果 |
EXTERNAL |
useIpcRendererOn |
ipcRenderer.on を簡単に使用でき、アンマウント時には ipcRenderer.removeListener が自動的に実行されます |
外部 |
useZoomFactor |
リアクティブな WebFrame のズーム倍率 |
EXTERNAL |
useZoomLevel |
Reactive WebFrame のズームレベル |
EXTERNAL |
@Firebase
| 関数 |
説明 |
呼び出し |
useAuth |
リアクティブ Firebase Auth バインディング |
EXTERNAL |
useFirestore |
リアクティブ Firestore バインディング |
EXTERNAL |
useRTDB |
リアクティブ Firebase リアルタイムデータベース バインディング |
外部 |
@Head
| 関数 |
説明 |
呼び出し |
createHead |
ヘッド・マネージャのインスタンスを作成します。 |
EXTERNAL |
useHead |
ヘッドのメタタグをリアクティブに更新します。 |
EXTERNAL |
@Integrations
| 関数 |
説明 |
呼び出し |
useAsyncValidator |
のラッパー async-validator |
EXTERNAL |
useAxios |
のラッパーEXTERNAL axios |
EXTERNAL |
useChangeCase |
リアクティブ・ラッパー(対象: change-case |
EXTERNAL |
useCookies |
用ラッパー universal-cookie |
EXTERNAL |
useDrauu |
drauu用のリアクティブインスタンス |
EXTERNAL |
useFocusTrap |
のリアクティブ・ラッパー focus-trap |
EXTERNAL |
useFuse |
Fuse.js を使用したコンポーザブルでファジー検索を簡単に実装 |
EXTERNAL |
useIDBKeyval |
用ラッパー idb-keyval |
EXTERNAL |
useJwt |
のラッパー jwt-decode |
EXTERNAL |
useNProgress |
用リアクティブ・ラッパー nprogress |
EXTERNAL |
useQRCode |
用ラッパー qrcode |
EXTERNAL |
useSortable |
用ラッパー sortable |
EXTERNAL |
@Math
| 関数 |
説明 |
呼び出し |
createGenericProjection |
の汎用バージョン createProjection |
EXTERNAL |
createProjection |
ある領域から別の領域への反応型数値投影 |
EXTERNAL |
logicAnd |
AND 参照の条件 |
EXTERNAL |
logicNot |
NOT refの条件 |
EXTERNAL |
logicOr |
OR 参照の条件 |
EXTERNAL |
useAbs |
リアクティブ Math.abs |
EXTERNAL |
useAverage |
配列の平均値をリアクティブに取得する |
外部 |
useCeil |
リアクティブ Math.ceil |
EXTERNAL |
useClamp |
ある値を他の2つの値の間にリアクティブにクリップする |
外部 |
useFloor |
リアクティブ Math.floor |
EXTERNAL |
useMath |
リアクティブ Math メソッド |
外部 |
useMax |
リアクティブ Math.max |
外部 |
useMin |
リアクティブ Math.min |
外部 |
usePrecision |
数値の精度をリアクティブに設定する |
EXTERNAL |
useProjection |
ある領域から別の領域へのリアクティブな数値投影 |
EXTERNAL |
useRound |
リアクティブ Math.round |
EXTERNAL |
useSum |
配列の合計値をリアクティブに取得する |
EXTERNAL |
useTrunc |
リアクティブ Math.trunc |
EXTERNAL |
@Motion
| 関数 |
説明 |
呼び出し |
useElementStyle |
リアクティブオブジェクトをターゲット要素の CSS スタイルと同期させる |
EXTERNAL |
useElementTransform |
リアクティブオブジェクトを、ターゲット要素の CSS トランスフォームに同期させます。 |
外部 |
useMotion |
コンポーネントに動きを与える。 |
外部 |
useMotionProperties |
ターゲット要素のモーションプロパティにアクセスします。 |
外部 |
useMotionVariants |
バリアントの状態と選択を処理します。 |
EXTERNAL |
useSpring |
アニメーションをスプリング効果で再生します。 |
EXTERNAL |
@Router
| 関数 |
説明 |
呼び出し |
useRouteHash |
リアクティブの省略形 route.hash |
EXTERNAL |
useRouteParams |
リアクティブの省略形 route.params |
EXTERNAL |
useRouteQuery |
リアクティブの省略形 route.query |
EXTERNAL |
@RxJS
| 関数 |
説明 |
呼び出し |
from |
RxJSの from() および fromEvent() をラップし、 refs |
外部 |
toObserver |
Sugar関数を使用して、 ref をRxJSのオブザーバーに変換する |
EXTERNAL |
useExtractedObservable |
RxJSの Observable 1つ以上のコンポーザブルから抽出された |
外部 |
useObservable |
RxJSを使用する Observable |
外部 |
useSubject |
RxJSをバインドする Subject を ref にバインドし、値の変更を双方向に伝播する |
EXTERNAL |
useSubscription |
RxJSを使用する Subscription を、購読解除やメモリリークの発生を心配することなく利用する |
EXTERNAL |
watchExtractedObservable |
1つ以上のコンポーザブルから抽出されたRxJSの値を監視する Observable 1つ以上のコンポーザブルから抽出された |
外部 |
@SchemaOrg
| 関数 |
説明 |
呼び出し |
createSchemaOrg |
schema.org マネージャーのインスタンスを作成します。 |
EXTERNAL |
useSchemaOrg |
schema.org をリアクティブに更新します。 |
EXTERNAL |
@Sound
| 関数 |
説明 |
呼び出し |
useSound |
効果音をリアクティブに再生します。 |
EXTERNAL |
GitHubで見る
---
name: vueuse-functions
description: Map requirements to the most suitable VueUse composable and apply correct usage patterns for concise, maintainable Vue.js/Nuxt features.
license: MIT
---
# 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](https://vueuse.org/) 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
| Function | Description | Invocation |
|----------|-------------|------------|
| [`createGlobalState`](references/createGlobalState.md) | Keep states in the global scope to be reusable across Vue instances | AUTO |
| [`createInjectionState`](references/createInjectionState.md) | Create global state that can be injected into components | AUTO |
| [`createSharedComposable`](references/createSharedComposable.md) | Make a composable function usable with multiple Vue instances | AUTO |
| [`injectLocal`](references/injectLocal.md) | Extended `inject` with ability to call `provideLocal` to provide the value in the same component | AUTO |
| [`provideLocal`](references/provideLocal.md) | Extended `provide` with ability to call `injectLocal` to obtain the value in the same component | AUTO |
| [`useAsyncState`](references/useAsyncState.md) | Reactive async state | AUTO |
| [`useDebouncedRefHistory`](references/useDebouncedRefHistory.md) | Shorthand for `useRefHistory` with debounced filter | AUTO |
| [`useLastChanged`](references/useLastChanged.md) | Records the timestamp of the last change | AUTO |
| [`useLocalStorage`](references/useLocalStorage.md) | Reactive [LocalStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) | AUTO |
| [`useManualRefHistory`](references/useManualRefHistory.md) | Manually track the change history of a ref when the user calls `commit()` | AUTO |
| [`useRefHistory`](references/useRefHistory.md) | Track the change history of a ref | AUTO |
| [`useSessionStorage`](references/useSessionStorage.md) | Reactive [SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage) | AUTO |
| [`useStorage`](references/useStorage.md) | Create a reactive ref that can be used to access & modify [LocalStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) or [SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage) | AUTO |
| [`useStorageAsync`](references/useStorageAsync.md) | Reactive Storage with async support | AUTO |
| [`useThrottledRefHistory`](references/useThrottledRefHistory.md) | Shorthand for `useRefHistory` with throttled filter | AUTO |
### Elements
| Function | Description | Invocation |
|----------|-------------|------------|
| [`useActiveElement`](references/useActiveElement.md) | Reactive `document.activeElement` | AUTO |
| [`useDocumentVisibility`](references/useDocumentVisibility.md) | Reactively track [`document.visibilityState`](https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilityState) | AUTO |
| [`useDraggable`](references/useDraggable.md) | Make elements draggable | AUTO |
| [`useDropZone`](references/useDropZone.md) | Create a zone where files can be dropped | AUTO |
| [`useElementBounding`](references/useElementBounding.md) | Reactive [bounding box](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect) of an HTML element | AUTO |
| [`useElementSize`](references/useElementSize.md) | Reactive size of an HTML element | AUTO |
| [`useElementVisibility`](references/useElementVisibility.md) | Tracks the visibility of an element within the viewport | AUTO |
| [`useIntersectionObserver`](references/useIntersectionObserver.md) | Detects changes to a target element's visibility | AUTO |
| [`useMouseInElement`](references/useMouseInElement.md) | Reactive mouse position related to an element | AUTO |
| [`useMutationObserver`](references/useMutationObserver.md) | Watch for changes being made to the DOM tree | AUTO |
| [`useParentElement`](references/useParentElement.md) | Get parent element of the given element | AUTO |
| [`useResizeObserver`](references/useResizeObserver.md) | Reports changes to the dimensions of an Element's content or the border-box | AUTO |
| [`useWindowFocus`](references/useWindowFocus.md) | Reactively track window focus with `window.onfocus` and `window.onblur` events | AUTO |
| [`useWindowScroll`](references/useWindowScroll.md) | Reactive window scroll | AUTO |
| [`useWindowSize`](references/useWindowSize.md) | Reactive window size | AUTO |
### Browser
| Function | Description | Invocation |
|----------|-------------|------------|
| [`useBluetooth`](references/useBluetooth.md) | Reactive [Web Bluetooth API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Bluetooth_API) | AUTO |
| [`useBreakpoints`](references/useBreakpoints.md) | Reactive viewport breakpoints | AUTO |
| [`useBroadcastChannel`](references/useBroadcastChannel.md) | Reactive [BroadcastChannel API](https://developer.mozilla.org/en-US/docs/Web/API/BroadcastChannel) | AUTO |
| [`useBrowserLocation`](references/useBrowserLocation.md) | Reactive browser location | AUTO |
| [`useClipboard`](references/useClipboard.md) | Reactive [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API) | AUTO |
| [`useClipboardItems`](references/useClipboardItems.md) | Reactive [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API) | AUTO |
| [`useColorMode`](references/useColorMode.md) | Reactive color mode (dark / light / customs) with auto data persistence | AUTO |
| [`useCssSupports`](references/useCssSupports.md) | SSR compatible and reactive [`CSS.supports`](https://developer.mozilla.org/docs/Web/API/CSS/supports_static) | AUTO |
| [`useCssVar`](references/useCssVar.md) | Manipulate CSS variables | AUTO |
| [`useDark`](references/useDark.md) | Reactive dark mode with auto data persistence | AUTO |
| [`useEventListener`](references/useEventListener.md) | Use EventListener with ease | AUTO |
| [`useEyeDropper`](references/useEyeDropper.md) | Reactive [EyeDropper API](https://developer.mozilla.org/en-US/docs/Web/API/EyeDropper_API) | AUTO |
| [`useFavicon`](references/useFavicon.md) | Reactive favicon | AUTO |
| [`useFileDialog`](references/useFileDialog.md) | Open file dialog with ease | AUTO |
| [`useFileSystemAccess`](references/useFileSystemAccess.md) | Create and read and write local files with [FileSystemAccessAPI](https://developer.mozilla.org/en-US/docs/Web/API/File_System_Access_API) | AUTO |
| [`useFullscreen`](references/useFullscreen.md) | Reactive [Fullscreen API](https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API) | AUTO |
| [`useGamepad`](references/useGamepad.md) | Provides reactive bindings for the [Gamepad API](https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API) | AUTO |
| [`useImage`](references/useImage.md) | Reactive load an image in the browser | AUTO |
| [`useMediaControls`](references/useMediaControls.md) | Reactive media controls for both `audio` and `video` elements | AUTO |
| [`useMediaQuery`](references/useMediaQuery.md) | Reactive [Media Query](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries/Testing_media_queries) | AUTO |
| [`useMemory`](references/useMemory.md) | Reactive Memory Info | AUTO |
| [`useObjectUrl`](references/useObjectUrl.md) | Reactive URL representing an object | AUTO |
| [`usePerformanceObserver`](references/usePerformanceObserver.md) | Observe performance metrics | AUTO |
| [`usePermission`](references/usePermission.md) | Reactive [Permissions API](https://developer.mozilla.org/en-US/docs/Web/API/Permissions_API) | AUTO |
| [`usePreferredColorScheme`](references/usePreferredColorScheme.md) | Reactive [prefers-color-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme) media query | AUTO |
| [`usePreferredContrast`](references/usePreferredContrast.md) | Reactive [prefers-contrast](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-contrast) media query | AUTO |
| [`usePreferredDark`](references/usePreferredDark.md) | Reactive dark theme preference | AUTO |
| [`usePreferredLanguages`](references/usePreferredLanguages.md) | Reactive [Navigator Languages](https://developer.mozilla.org/en-US/docs/Web/API/NavigatorLanguage/languages) | AUTO |
| [`usePreferredReducedMotion`](references/usePreferredReducedMotion.md) | Reactive [prefers-reduced-motion](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-motion) media query | AUTO |
| [`usePreferredReducedTransparency`](references/usePreferredReducedTransparency.md) | Reactive [prefers-reduced-transparency](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-transparency) media query | AUTO |
| [`useScreenOrientation`](references/useScreenOrientation.md) | Reactive [Screen Orientation API](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Orientation_API) | AUTO |
| [`useScreenSafeArea`](references/useScreenSafeArea.md) | Reactive `env(safe-area-inset-*)` | AUTO |
| [`useScriptTag`](references/useScriptTag.md) | Creates a script tag | AUTO |
| [`useShare`](references/useShare.md) | Reactive [Web Share API](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/share) | AUTO |
| [`useSSRWidth`](references/useSSRWidth.md) | Used to set a global viewport width which will be used when rendering SSR components that rely on the viewport width like [`useMediaQuery`](../useMediaQuery/index.md) or [`useBreakpoints`](../useBreakpoints/index.md) | AUTO |
| [`useStyleTag`](references/useStyleTag.md) | Inject reactive `style` element in head | AUTO |
| [`useTextareaAutosize`](references/useTextareaAutosize.md) | Automatically update the height of a textarea depending on the content | AUTO |
| [`useTextDirection`](references/useTextDirection.md) | Reactive [dir](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir) of the element's text | AUTO |
| [`useTitle`](references/useTitle.md) | Reactive document title | AUTO |
| [`useUrlSearchParams`](references/useUrlSearchParams.md) | Reactive [URLSearchParams](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams) | AUTO |
| [`useVibrate`](references/useVibrate.md) | Reactive [Vibration API](https://developer.mozilla.org/en-US/docs/Web/API/Vibration_API) | AUTO |
| [`useWakeLock`](references/useWakeLock.md) | Reactive [Screen Wake Lock API](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API) | AUTO |
| [`useWebNotification`](references/useWebNotification.md) | Reactive [Notification](https://developer.mozilla.org/en-US/docs/Web/API/notification) | AUTO |
| [`useWebWorker`](references/useWebWorker.md) | Simple [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers) registration and communication | AUTO |
| [`useWebWorkerFn`](references/useWebWorkerFn.md) | Run expensive functions without blocking the UI | AUTO |
### Sensors
| Function | Description | Invocation |
|----------|-------------|------------|
| [`onClickOutside`](references/onClickOutside.md) | Listen for clicks outside of an element | AUTO |
| [`onElementRemoval`](references/onElementRemoval.md) | Fires when the element or any element containing it is removed from the DOM | AUTO |
| [`onKeyStroke`](references/onKeyStroke.md) | Listen for keyboard keystrokes | AUTO |
| [`onLongPress`](references/onLongPress.md) | Listen for a long press on an element | AUTO |
| [`onStartTyping`](references/onStartTyping.md) | Fires when users start typing on non-editable elements | AUTO |
| [`useBattery`](references/useBattery.md) | Reactive [Battery Status API](https://developer.mozilla.org/en-US/docs/Web/API/Battery_Status_API) | AUTO |
| [`useDeviceMotion`](references/useDeviceMotion.md) | Reactive [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent) | AUTO |
| [`useDeviceOrientation`](references/useDeviceOrientation.md) | Reactive [DeviceOrientationEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent) | AUTO |
| [`useDevicePixelRatio`](references/useDevicePixelRatio.md) | Reactively track [`window.devicePixelRatio`](https://developer.mozilla.org/docs/Web/API/Window/devicePixelRatio) | AUTO |
| [`useDevicesList`](references/useDevicesList.md) | Reactive [enumerateDevices](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/enumerateDevices) listing available input/output devices | AUTO |
| [`useDisplayMedia`](references/useDisplayMedia.md) | Reactive [`mediaDevices.getDisplayMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia) streaming | AUTO |
| [`useElementByPoint`](references/useElementByPoint.md) | Reactive element by point | AUTO |
| [`useElementHover`](references/useElementHover.md) | Reactive element's hover state | AUTO |
| [`useFocus`](references/useFocus.md) | Reactive utility to track or set the focus state of a DOM element | AUTO |
| [`useFocusWithin`](references/useFocusWithin.md) | Reactive utility to track if an element or one of its descendants has focus | AUTO |
| [`useFps`](references/useFps.md) | Reactive FPS (frames per second) | AUTO |
| [`useGeolocation`](references/useGeolocation.md) | Reactive [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API) | AUTO |
| [`useIdle`](references/useIdle.md) | Tracks whether the user is being inactive | AUTO |
| [`useInfiniteScroll`](references/useInfiniteScroll.md) | Infinite scrolling of the element | AUTO |
| [`useKeyModifier`](references/useKeyModifier.md) | Reactive [Modifier State](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/getModifierState) | AUTO |
| [`useMagicKeys`](references/useMagicKeys.md) | Reactive keys pressed state | AUTO |
| [`useMouse`](references/useMouse.md) | Reactive mouse position | AUTO |
| [`useMousePressed`](references/useMousePressed.md) | Reactive mouse pressing state | AUTO |
| [`useNavigatorLanguage`](references/useNavigatorLanguage.md) | Reactive [navigator.language](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/language) | AUTO |
| [`useNetwork`](references/useNetwork.md) | Reactive [Network status](https://developer.mozilla.org/en-US/docs/Web/API/Network_Information_API) | AUTO |
| [`useOnline`](references/useOnline.md) | Reactive online state | AUTO |
| [`usePageLeave`](references/usePageLeave.md) | Reactive state to show whether the mouse leaves the page | AUTO |
| [`useParallax`](references/useParallax.md) | Create parallax effect easily | AUTO |
| [`usePointer`](references/usePointer.md) | Reactive [pointer state](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_events) | AUTO |
| [`usePointerLock`](references/usePointerLock.md) | Reactive [pointer lock](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API) | AUTO |
| [`usePointerSwipe`](references/usePointerSwipe.md) | Reactive swipe detection based on [PointerEvents](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent) | AUTO |
| [`useScroll`](references/useScroll.md) | Reactive scroll position and state | AUTO |
| [`useScrollLock`](references/useScrollLock.md) | Lock scrolling of the element | AUTO |
| [`useSpeechRecognition`](references/useSpeechRecognition.md) | Reactive [SpeechRecognition](https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition) | AUTO |
| [`useSpeechSynthesis`](references/useSpeechSynthesis.md) | Reactive [SpeechSynthesis](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis) | AUTO |
| [`useSwipe`](references/useSwipe.md) | Reactive swipe detection based on [`TouchEvents`](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent) | AUTO |
| [`useTextSelection`](references/useTextSelection.md) | Reactively track user text selection based on [`Window.getSelection`](https://developer.mozilla.org/en-US/docs/Web/API/Window/getSelection) | AUTO |
| [`useUserMedia`](references/useUserMedia.md) | Reactive [`mediaDevices.getUserMedia`](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia) streaming | AUTO |
### Network
| Function | Description | Invocation |
|----------|-------------|------------|
| [`useEventSource`](references/useEventSource.md) | An [EventSource](https://developer.mozilla.org/en-US/docs/Web/API/EventSource) or [Server-Sent-Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events) instance opens a persistent connection to an HTTP server | AUTO |
| [`useFetch`](references/useFetch.md) | Reactive [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) provides the ability to abort requests | AUTO |
| [`useWebSocket`](references/useWebSocket.md) | Reactive [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/WebSocket) client | AUTO |
### Animation
| Function | Description | Invocation |
|----------|-------------|------------|
| [`useAnimate`](references/useAnimate.md) | Reactive [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API) | AUTO |
| [`useInterval`](references/useInterval.md) | Reactive counter that increases on every interval | AUTO |
| [`useIntervalFn`](references/useIntervalFn.md) | Wrapper for `setInterval` with controls | AUTO |
| [`useNow`](references/useNow.md) | Reactive current Date instance | AUTO |
| [`useRafFn`](references/useRafFn.md) | Call function on every `requestAnimationFrame` | AUTO |
| [`useTimeout`](references/useTimeout.md) | Reactive value that becomes `true` after a given time | AUTO |
| [`useTimeoutFn`](references/useTimeoutFn.md) | Wrapper for `setTimeout` with controls | AUTO |
| [`useTimestamp`](references/useTimestamp.md) | Reactive current timestamp | AUTO |
| [`useTransition`](references/useTransition.md) | Transition between values | AUTO |
### Component
| Function | Description | Invocation |
|----------|-------------|------------|
| [`computedInject`](references/computedInject.md) | Combine `computed` and `inject` | AUTO |
| [`createReusableTemplate`](references/createReusableTemplate.md) | Define and reuse template inside the component scope | AUTO |
| [`createTemplatePromise`](references/createTemplatePromise.md) | Template as Promise | AUTO |
| [`templateRef`](references/templateRef.md) | Shorthand for binding ref to template element | AUTO |
| [`tryOnBeforeMount`](references/tryOnBeforeMount.md) | Safe `onBeforeMount` | AUTO |
| [`tryOnBeforeUnmount`](references/tryOnBeforeUnmount.md) | Safe `onBeforeUnmount` | AUTO |
| [`tryOnMounted`](references/tryOnMounted.md) | Safe `onMounted` | AUTO |
| [`tryOnScopeDispose`](references/tryOnScopeDispose.md) | Safe `onScopeDispose` | AUTO |
| [`tryOnUnmounted`](references/tryOnUnmounted.md) | Safe `onUnmounted` | AUTO |
| [`unrefElement`](references/unrefElement.md) | Retrieves the underlying DOM element from a Vue ref or component instance | AUTO |
| [`useCurrentElement`](references/useCurrentElement.md) | Get the DOM element of current component as a ref | AUTO |
| [`useMounted`](references/useMounted.md) | Mounted state in ref | AUTO |
| [`useTemplateRefsList`](references/useTemplateRefsList.md) | Shorthand for binding refs to template elements and components inside `v-for` | AUTO |
| [`useVirtualList`](references/useVirtualList.md) | Create virtual lists with ease | AUTO |
| [`useVModel`](references/useVModel.md) | Shorthand for v-model binding | AUTO |
| [`useVModels`](references/useVModels.md) | Shorthand for props v-model binding | AUTO |
### Watch
| Function | Description | Invocation |
|----------|-------------|------------|
| [`until`](references/until.md) | Promised one-time watch for changes | AUTO |
| [`watchArray`](references/watchArray.md) | Watch for an array with additions and removals | AUTO |
| [`watchAtMost`](references/watchAtMost.md) | `watch` with the number of times triggered | AUTO |
| [`watchDebounced`](references/watchDebounced.md) | Debounced watch | AUTO |
| [`watchDeep`](references/watchDeep.md) | Shorthand for watching value with `{deep: true}` | AUTO |
| [`watchIgnorable`](references/watchIgnorable.md) | Ignorable watch | AUTO |
| [`watchImmediate`](references/watchImmediate.md) | Shorthand for watching value with `{immediate: true}` | AUTO |
| [`watchOnce`](references/watchOnce.md) | Shorthand for watching value with `{ once: true }` | AUTO |
| [`watchPausable`](references/watchPausable.md) | Pausable watch | AUTO |
| [`watchThrottled`](references/watchThrottled.md) | Throttled watch | AUTO |
| [`watchTriggerable`](references/watchTriggerable.md) | Watch that can be triggered manually | AUTO |
| [`watchWithFilter`](references/watchWithFilter.md) | `watch` with additional EventFilter control | AUTO |
| [`whenever`](references/whenever.md) | Shorthand for watching value to be truthy | AUTO |
### Reactivity
| Function | Description | Invocation |
|----------|-------------|------------|
| [`computedAsync`](references/computedAsync.md) | Computed for async functions | AUTO |
| [`computedEager`](references/computedEager.md) | Eager computed without lazy evaluation | AUTO |
| [`computedWithControl`](references/computedWithControl.md) | Explicitly define the dependencies of computed | AUTO |
| [`createRef`](references/createRef.md) | Returns a `deepRef` or `shallowRef` depending on the `deep` param | AUTO |
| [`extendRef`](references/extendRef.md) | Add extra attributes to Ref | AUTO |
| [`reactify`](references/reactify.md) | Converts plain functions into reactive functions | AUTO |
| [`reactifyObject`](references/reactifyObject.md) | Apply `reactify` to an object | AUTO |
| [`reactiveComputed`](references/reactiveComputed.md) | Computed reactive object | AUTO |
| [`reactiveOmit`](references/reactiveOmit.md) | Reactively omit fields from a reactive object | AUTO |
| [`reactivePick`](references/reactivePick.md) | Reactively pick fields from a reactive object | AUTO |
| [`refAutoReset`](references/refAutoReset.md) | A ref which will be reset to the default value after some time | AUTO |
| [`refDebounced`](references/refDebounced.md) | Debounce execution of a ref value | AUTO |
| [`refDefault`](references/refDefault.md) | Apply default value to a ref | AUTO |
| [`refManualReset`](references/refManualReset.md) | Create a ref with manual reset functionality | AUTO |
| [`refThrottled`](references/refThrottled.md) | Throttle changing of a ref value | AUTO |
| [`refWithControl`](references/refWithControl.md) | Fine-grained controls over ref and its reactivity | AUTO |
| [`syncRef`](references/syncRef.md) | Two-way refs synchronization | AUTO |
| [`syncRefs`](references/syncRefs.md) | Keep target refs in sync with a source ref | AUTO |
| [`toReactive`](references/toReactive.md) | Converts ref to reactive | AUTO |
| [`toRef`](references/toRef.md) | Normalize value/ref/getter to `ref` or `computed` | EXPLICIT_ONLY |
| [`toRefs`](references/toRefs.md) | Extended [`toRefs`](https://vuejs.org/api/reactivity-utilities.html#torefs) that also accepts refs of an object | AUTO |
### Array
| Function | Description | Invocation |
|----------|-------------|------------|
| [`useArrayDifference`](references/useArrayDifference.md) | Reactive get array difference of two arrays | AUTO |
| [`useArrayEvery`](references/useArrayEvery.md) | Reactive `Array.every` | AUTO |
| [`useArrayFilter`](references/useArrayFilter.md) | Reactive `Array.filter` | AUTO |
| [`useArrayFind`](references/useArrayFind.md) | Reactive `Array.find` | AUTO |
| [`useArrayFindIndex`](references/useArrayFindIndex.md) | Reactive `Array.findIndex` | AUTO |
| [`useArrayFindLast`](references/useArrayFindLast.md) | Reactive `Array.findLast` | AUTO |
| [`useArrayIncludes`](references/useArrayIncludes.md) | Reactive `Array.includes` | AUTO |
| [`useArrayJoin`](references/useArrayJoin.md) | Reactive `Array.join` | AUTO |
| [`useArrayMap`](references/useArrayMap.md) | Reactive `Array.map` | AUTO |
| [`useArrayReduce`](references/useArrayReduce.md) | Reactive `Array.reduce` | AUTO |
| [`useArraySome`](references/useArraySome.md) | Reactive `Array.some` | AUTO |
| [`useArrayUnique`](references/useArrayUnique.md) | Reactive unique array | AUTO |
| [`useSorted`](references/useSorted.md) | Reactive sort array | AUTO |
### Time
| Function | Description | Invocation |
|----------|-------------|------------|
| [`useCountdown`](references/useCountdown.md) | Reactive countdown timer in seconds | AUTO |
| [`useDateFormat`](references/useDateFormat.md) | Get the formatted date according to the string of tokens passed in | AUTO |
| [`useTimeAgo`](references/useTimeAgo.md) | Reactive time ago | AUTO |
| [`useTimeAgoIntl`](references/useTimeAgoIntl.md) | Reactive time ago with i18n supported | AUTO |
### Utilities
| Function | Description | Invocation |
|----------|-------------|------------|
| [`createDisposableDirective`](references/createDisposableDirective.md) | Utility for authoring disposable directives | AUTO |
| [`createEventHook`](references/createEventHook.md) | Utility for creating event hooks | AUTO |
| [`createUnrefFn`](references/createUnrefFn.md) | Make a plain function accepting ref and raw values as arguments | AUTO |
| [`get`](references/get.md) | Shorthand for accessing `ref.value` | EXPLICIT_ONLY |
| [`isDefined`](references/isDefined.md) | Non-nullish checking type guard for Ref | AUTO |
| [`makeDestructurable`](references/makeDestructurable.md) | Make isomorphic destructurable for object and array at the same time | AUTO |
| [`set`](references/set.md) | Shorthand for `ref.value = x` | EXPLICIT_ONLY |
| [`useAsyncQueue`](references/useAsyncQueue.md) | Executes each asynchronous task sequentially and passes the current task result to the next task | AUTO |
| [`useBase64`](references/useBase64.md) | Reactive base64 transforming | AUTO |
| [`useCached`](references/useCached.md) | Cache a ref with a custom comparator | AUTO |
| [`useCloned`](references/useCloned.md) | Reactive clone of a ref | AUTO |
| [`useConfirmDialog`](references/useConfirmDialog.md) | Creates event hooks to support modals and confirmation dialog chains | AUTO |
| [`useCounter`](references/useCounter.md) | Basic counter with utility functions | AUTO |
| [`useCycleList`](references/useCycleList.md) | Cycle through a list of items | AUTO |
| [`useDebounceFn`](references/useDebounceFn.md) | Debounce execution of a function | AUTO |
| [`useEventBus`](references/useEventBus.md) | A basic event bus | AUTO |
| [`useMemoize`](references/useMemoize.md) | Cache results of functions depending on arguments and keep it reactive | AUTO |
| [`useOffsetPagination`](references/useOffsetPagination.md) | Reactive offset pagination | AUTO |
| [`usePrevious`](references/usePrevious.md) | Holds the previous value of a ref | AUTO |
| [`useStepper`](references/useStepper.md) | Provides helpers for building a multi-step wizard interface | AUTO |
| [`useSupported`](references/useSupported.md) | SSR compatibility `isSupported` | AUTO |
| [`useThrottleFn`](references/useThrottleFn.md) | Throttle execution of a function | AUTO |
| [`useTimeoutPoll`](references/useTimeoutPoll.md) | Use timeout to poll something | AUTO |
| [`useToggle`](references/useToggle.md) | A boolean switcher with utility functions | AUTO |
| [`useToNumber`](references/useToNumber.md) | Reactively convert a string ref to number | AUTO |
| [`useToString`](references/useToString.md) | Reactively convert a ref to string | AUTO |
### @Electron
| Function | Description | Invocation |
|----------|-------------|------------|
| [`useIpcRenderer`](references/useIpcRenderer.md) | Provides [ipcRenderer](https://www.electronjs.org/docs/api/ipc-renderer) and all of its APIs with Vue reactivity | EXTERNAL |
| [`useIpcRendererInvoke`](references/useIpcRendererInvoke.md) | Reactive [ipcRenderer.invoke API](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererinvokechannel-args) result | EXTERNAL |
| [`useIpcRendererOn`](references/useIpcRendererOn.md) | Use [ipcRenderer.on](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendereronchannel-listener) with ease and [ipcRenderer.removeListener](https://www.electronjs.org/docs/api/ipc-renderer#ipcrendererremovelistenerchannel-listener) automatically on unmounted | EXTERNAL |
| [`useZoomFactor`](references/useZoomFactor.md) | Reactive [WebFrame](https://www.electronjs.org/docs/api/web-frame#webframe) zoom factor | EXTERNAL |
| [`useZoomLevel`](references/useZoomLevel.md) | Reactive [WebFrame](https://www.electronjs.org/docs/api/web-frame#webframe) zoom level | EXTERNAL |
### @Firebase
| Function | Description | Invocation |
|----------|-------------|------------|
| [`useAuth`](references/useAuth.md) | Reactive [Firebase Auth](https://firebase.google.com/docs/auth) binding | EXTERNAL |
| [`useFirestore`](references/useFirestore.md) | Reactive [Firestore](https://firebase.google.com/docs/firestore) binding | EXTERNAL |
| [`useRTDB`](references/useRTDB.md) | Reactive [Firebase Realtime Database](https://firebase.google.com/docs/database) binding | EXTERNAL |
### @Head
| Function | Description | Invocation |
|----------|-------------|------------|
| [`createHead`](https://github.com/vueuse/head#api) | Create the head manager instance. | EXTERNAL |
| [`useHead`](https://github.com/vueuse/head#api) | Update head meta tags reactively. | EXTERNAL |
### @Integrations
| Function | Description | Invocation |
|----------|-------------|------------|
| [`useAsyncValidator`](references/useAsyncValidator.md) | Wrapper for [`async-validator`](https://github.com/yiminghe/async-validator) | EXTERNAL |
| [`useAxios`](references/useAxios.md) | Wrapper for [`axios`](https://github.com/axios/axios) | EXTERNAL |
| [`useChangeCase`](references/useChangeCase.md) | Reactive wrapper for [`change-case`](https://github.com/blakeembrey/change-case) | EXTERNAL |
| [`useCookies`](references/useCookies.md) | Wrapper for [`universal-cookie`](https://www.npmjs.com/package/universal-cookie) | EXTERNAL |
| [`useDrauu`](references/useDrauu.md) | Reactive instance for [drauu](https://github.com/antfu/drauu) | EXTERNAL |
| [`useFocusTrap`](references/useFocusTrap.md) | Reactive wrapper for [`focus-trap`](https://github.com/focus-trap/focus-trap) | EXTERNAL |
| [`useFuse`](references/useFuse.md) | Easily implement fuzzy search using a composable with [Fuse.js](https://github.com/krisk/fuse) | EXTERNAL |
| [`useIDBKeyval`](references/useIDBKeyval.md) | Wrapper for [`idb-keyval`](https://www.npmjs.com/package/idb-keyval) | EXTERNAL |
| [`useJwt`](references/useJwt.md) | Wrapper for [`jwt-decode`](https://github.com/auth0/jwt-decode) | EXTERNAL |
| [`useNProgress`](references/useNProgress.md) | Reactive wrapper for [`nprogress`](https://github.com/rstacruz/nprogress) | EXTERNAL |
| [`useQRCode`](references/useQRCode.md) | Wrapper for [`qrcode`](https://github.com/soldair/node-qrcode) | EXTERNAL |
| [`useSortable`](references/useSortable.md) | Wrapper for [`sortable`](https://github.com/SortableJS/Sortable) | EXTERNAL |
### @Math
| Function | Description | Invocation |
|----------|-------------|------------|
| [`createGenericProjection`](references/createGenericProjection.md) | Generic version of `createProjection` | EXTERNAL |
| [`createProjection`](references/createProjection.md) | Reactive numeric projection from one domain to another | EXTERNAL |
| [`logicAnd`](references/logicAnd.md) | `AND` condition for refs | EXTERNAL |
| [`logicNot`](references/logicNot.md) | `NOT` condition for ref | EXTERNAL |
| [`logicOr`](references/logicOr.md) | `OR` conditions for refs | EXTERNAL |
| [`useAbs`](references/useAbs.md) | Reactive `Math.abs` | EXTERNAL |
| [`useAverage`](references/useAverage.md) | Get the average of an array reactively | EXTERNAL |
| [`useCeil`](references/useCeil.md) | Reactive `Math.ceil` | EXTERNAL |
| [`useClamp`](references/useClamp.md) | Reactively clamp a value between two other values | EXTERNAL |
| [`useFloor`](references/useFloor.md) | Reactive `Math.floor` | EXTERNAL |
| [`useMath`](references/useMath.md) | Reactive `Math` methods | EXTERNAL |
| [`useMax`](references/useMax.md) | Reactive `Math.max` | EXTERNAL |
| [`useMin`](references/useMin.md) | Reactive `Math.min` | EXTERNAL |
| [`usePrecision`](references/usePrecision.md) | Reactively set the precision of a number | EXTERNAL |
| [`useProjection`](references/useProjection.md) | Reactive numeric projection from one domain to another | EXTERNAL |
| [`useRound`](references/useRound.md) | Reactive `Math.round` | EXTERNAL |
| [`useSum`](references/useSum.md) | Get the sum of an array reactively | EXTERNAL |
| [`useTrunc`](references/useTrunc.md) | Reactive `Math.trunc` | EXTERNAL |
### @Motion
| Function | Description | Invocation |
|----------|-------------|------------|
| [`useElementStyle`](https://motion.vueuse.org/api/use-element-style) | Sync a reactive object to a target element CSS styling | EXTERNAL |
| [`useElementTransform`](https://motion.vueuse.org/api/use-element-transform) | Sync a reactive object to a target element CSS transform. | EXTERNAL |
| [`useMotion`](https://motion.vueuse.org/api/use-motion) | Putting your components in motion. | EXTERNAL |
| [`useMotionProperties`](https://motion.vueuse.org/api/use-motion-properties) | Access Motion Properties for a target element. | EXTERNAL |
| [`useMotionVariants`](https://motion.vueuse.org/api/use-motion-variants) | Handle the Variants state and selection. | EXTERNAL |
| [`useSpring`](https://motion.vueuse.org/api/use-spring) | Spring animations. | EXTERNAL |
### @Router
| Function | Description | Invocation |
|----------|-------------|------------|
| [`useRouteHash`](references/useRouteHash.md) | Shorthand for a reactive `route.hash` | EXTERNAL |
| [`useRouteParams`](references/useRouteParams.md) | Shorthand for a reactive `route.params` | EXTERNAL |
| [`useRouteQuery`](references/useRouteQuery.md) | Shorthand for a reactive `route.query` | EXTERNAL |
### @RxJS
| Function | Description | Invocation |
|----------|-------------|------------|
| [`from`](references/from.md) | Wrappers around RxJS's [`from()`](https://rxjs.dev/api/index/function/from) and [`fromEvent()`](https://rxjs.dev/api/index/function/fromEvent) to allow them to accept `ref`s | EXTERNAL |
| [`toObserver`](references/toObserver.md) | Sugar function to convert a `ref` into an RxJS [Observer](https://rxjs.dev/guide/observer) | EXTERNAL |
| [`useExtractedObservable`](references/useExtractedObservable.md) | Use an RxJS [`Observable`](https://rxjs.dev/guide/observable) as extracted from one or more composables | EXTERNAL |
| [`useObservable`](references/useObservable.md) | Use an RxJS [`Observable`](https://rxjs.dev/guide/observable) | EXTERNAL |
| [`useSubject`](references/useSubject.md) | Bind an RxJS [`Subject`](https://rxjs.dev/guide/subject) to a `ref` and propagate value changes both ways | EXTERNAL |
| [`useSubscription`](references/useSubscription.md) | Use an RxJS [`Subscription`](https://rxjs.dev/guide/subscription) without worrying about unsubscribing from it or creating memory leaks | EXTERNAL |
| [`watchExtractedObservable`](references/watchExtractedObservable.md) | Watch the values of an RxJS [`Observable`](https://rxjs.dev/guide/observable) as extracted from one or more composables | EXTERNAL |
### @SchemaOrg
| Function | Description | Invocation |
|----------|-------------|------------|
| [`createSchemaOrg`](https://vue-schema-org.netlify.app/api/core/create-schema-org.html) | Create the schema.org manager instance. | EXTERNAL |
| [`useSchemaOrg`](https://vue-schema-org.netlify.app/api/core/use-schema-org.html) | Update schema.org reactively. | EXTERNAL |
### @Sound
| Function | Description | Invocation |
|----------|-------------|------------|
| [`useSound`](https://github.com/vueuse/sound#examples) | Play sound effects reactively. | EXTERNAL |