Fonctions VueUse
Cette compétence est un guide de décision et de mise en œuvre des composables VueUse dans les projets Vue.js / Nuxt. Elle met en correspondance les besoins avec la fonction VueUse la plus adaptée, applique le modèle d'utilisation approprié et privilégie les solutions basées sur des composables plutôt que le code sur mesure afin de garantir des implémentations concises, faciles à maintenir et performantes.
Quand l'appliquer
- Appliquez cette compétence chaque fois que vous assistez un utilisateur dans son travail de développement sous Vue.js / Nuxt.
- Vérifiez toujours en premier lieu si une fonction VueUse permet de répondre à l’exigence.
- Privilégiez les composables VueUse au code sur mesure afin d’améliorer la lisibilité, la maintenabilité et les performances.
- Associez les exigences à la fonction VueUse la plus appropriée et respectez la règle d’appel de cette fonction.
- Veuillez vous reporter au
Invocation colonne du tableau des fonctions ci-dessous. Par exemple :
AUTO: À utiliser automatiquement lorsque cela s’applique.
EXTERNAL: À utiliser uniquement si l’utilisateur a déjà installé la dépendance externe requise ; sinon, réévaluez la situation et ne demandez l’installation que si cela est vraiment nécessaire.
EXPLICIT_ONLY: À utiliser uniquement lorsque l’utilisateur en fait la demande explicite.
REMARQUE : les instructions destinées à l’utilisateur dans l’invite de commande ou AGENTS.md peuvent prévaloir sur la règle par défaut Invocation .
Fonctions
Toutes les fonctions répertoriées ci-dessous font partie de la bibliothèque VueUse ; chaque section classe les fonctions en fonction de leur fonctionnalité.
IMPORTANT : chaque entrée de fonction comprend une brève Description et une description détaillée Reference. Lorsque vous utilisez une fonction, consultez toujours le document correspondant dans ./references pour connaître les détails d’utilisation et les déclarations de types.
État
| Fonction |
Description |
Appel |
createGlobalState |
Conservez les états dans la portée globale afin qu’ils soient réutilisables entre les instances Vue |
AUTO |
createInjectionState |
Créer un état global pouvant être injecté dans les composants |
AUTO |
createSharedComposable |
Rendre une fonction composable utilisable avec plusieurs instances Vue |
AUTO |
injectLocal |
Fonction étendue inject avec la possibilité d’appeler provideLocal pour fournir la valeur dans le même composant |
AUTO |
provideLocal |
Étendu provide avec la possibilité d’appeler injectLocal pour obtenir la valeur dans le même composant |
AUTO |
useAsyncState |
État asynchrone réactif |
AUTO |
useDebouncedRefHistory |
Abréviation de useRefHistory avec filtre anti-rebond |
AUTO |
useLastChanged |
Enregistre l'horodatage de la dernière modification |
AUTO |
useLocalStorage |
LocalStorage réactif |
AUTO |
useManualRefHistory |
Suivi manuel de l'historique des modifications d'une référence lorsque l'utilisateur appelle commit() |
AUTO |
useRefHistory |
Suivre l'historique des modifications d'une référence |
AUTO |
useSessionStorage |
SessionStorage réactif |
AUTO |
useStorage |
Créer une référence réactive permettant d’accéder à LocalStorage ou SessionStorage et de les modifier |
AUTO |
useStorageAsync |
Stockage réactif avec prise en charge asynchrone |
AUTO |
useThrottledRefHistory |
Syntaxe abrégée pour useRefHistory avec filtre à débit limité |
AUTO |
Éléments
| Fonction |
Description |
Appel |
useActiveElement |
Réactif document.activeElement |
AUTO |
useDocumentVisibility |
Suivi réactif document.visibilityState |
AUTO |
useDraggable |
Rendre les éléments déplaçables |
AUTO |
useDropZone |
Créer une zone où les fichiers peuvent être déposés |
AUTO |
useElementBounding |
Boîte englobante réactive d’un élément HTML |
AUTO |
useElementSize |
Taille réactive d’un élément HTML |
AUTO |
useElementVisibility |
Suivi de la visibilité d’un élément dans la fenêtre d’affichage |
AUTO |
useIntersectionObserver |
Détecte les changements de visibilité d’un élément cible |
AUTO |
useMouseInElement |
Position réactive de la souris par rapport à un élément |
AUTO |
useMutationObserver |
Surveille les modifications apportées à l'arborescence DOM |
AUTO |
useParentElement |
Récupérer l'élément parent de l'élément donné |
AUTO |
useResizeObserver |
Signale les modifications apportées aux dimensions du contenu d’un élément ou de la border-box |
AUTO |
useWindowFocus |
Suivi réactif du focus de la fenêtre avec window.onfocus et window.onblur événements |
AUTO |
useWindowScroll |
Défilement réactif de la fenêtre |
AUTO |
useWindowSize |
Taille réactive de la fenêtre |
AUTO |
Navigateur
| Fonction |
Description |
Appel |
useBluetooth |
API Web Bluetooth réactive |
AUTO |
useBreakpoints |
Points de rupture réactifs de la fenêtre d'affichage |
AUTO |
useBroadcastChannel |
API BroadcastChannel réactive |
AUTO |
useBrowserLocation |
Emplacement du navigateur réactif |
AUTO |
useClipboard |
API réactive du presse-papiers |
AUTO |
useClipboardItems |
API réactive du presse-papiers |
AUTO |
useColorMode |
Mode couleur réactif (sombre / clair / personnalisé) avec persistance automatique des données |
AUTO |
useCssSupports |
Compatible SSR et réactif CSS.supports |
AUTO |
useCssVar |
Manipulation des variables CSS |
AUTO |
useDark |
Mode sombre réactif avec persistance automatique des données |
AUTO |
useEventListener |
Utilisation simplifiée d'EventListener |
AUTO |
useEyeDropper |
API EyeDropper réactive |
AUTO |
useFavicon |
Favicon réactif |
AUTO |
useFileDialog |
Ouvrir facilement la boîte de dialogue de sélection de fichier |
AUTO |
useFileSystemAccess |
Créer, lire et écrire des fichiers locaux avec FileSystemAccessAPI |
AUTO |
useFullscreen |
API réactive pour le plein écran |
AUTO |
useGamepad |
Fournit des liaisons réactives pour l’API Gamepad |
AUTO |
useImage |
Chargement réactif d’une image dans le navigateur |
AUTO |
useMediaControls |
Commandes multimédia réactives pour les deux audio et video éléments |
AUTO |
useMediaQuery |
Requête média réactive |
AUTO |
useMemory |
Informations sur la mémoire réactive |
AUTO |
useObjectUrl |
URL réactive représentant un objet |
AUTO |
usePerformanceObserver |
Observer les indicateurs de performance |
AUTO |
usePermission |
API d'autorisations réactive |
AUTO |
usePreferredColorScheme |
Requête média « prefers-color-scheme » de Reactive |
AUTO |
usePreferredContrast |
Requête média « prefers-contrast » de Reactive |
AUTO |
usePreferredDark |
Préférence pour le thème sombre réactif |
AUTO |
usePreferredLanguages |
Langues du navigateur réactif |
AUTO |
usePreferredReducedMotion |
Requête média « prefers-reduced-motion » de Reactive |
AUTO |
usePreferredReducedTransparency |
Requête média « prefers-reduced-transparency » de Reactive |
AUTO |
useScreenOrientation |
API d'orientation d'écran réactive |
AUTO |
useScreenSafeArea |
Réactif env(safe-area-inset-*) |
AUTO |
useScriptTag |
Crée une balise de script |
AUTO |
useShare |
API Web Share réactive |
AUTO |
useSSRWidth |
Permet de définir une largeur globale de la fenêtre d’affichage qui sera utilisée lors du rendu des composants SSR dépendant de la largeur de la fenêtre d’affichage, tels que useMediaQuery ou useBreakpoints |
AUTO |
useStyleTag |
Insérer l’élément réactif style dans la balise <head> |
AUTO |
useTextareaAutosize |
Mettre à jour automatiquement la hauteur d'une zone de texte en fonction de son contenu |
AUTO |
useTextDirection |
Direction réactive du texte de l’élément |
AUTO |
useTitle |
Titre du document réactif |
AUTO |
useUrlSearchParams |
Paramètres de recherche URL réactifs |
AUTO |
useVibrate |
API de vibration réactive |
AUTO |
useWakeLock |
API Screen Wake Lock réactive |
AUTO |
useWebNotification |
Notification réactive |
AUTO |
useWebWorker |
Enregistrement et communication simples des Web Workers |
AUTO |
useWebWorkerFn |
Exécution de fonctions gourmandes en ressources sans bloquer l'interface utilisateur |
AUTO |
Capteurs
| Fonction |
Description |
Appel |
onClickOutside |
Détecte les clics en dehors d’un élément |
AUTO |
onElementRemoval |
Se déclenche lorsque l'élément ou tout élément le contenant est supprimé du DOM |
AUTO |
onKeyStroke |
Écouter les frappes au clavier |
AUTO |
onLongPress |
Détecte un appui long sur un élément |
AUTO |
onStartTyping |
Se déclenche lorsque l'utilisateur commence à saisir du texte sur des éléments non modifiables |
AUTO |
useBattery |
API réactive d'état de la batterie |
AUTO |
useDeviceMotion |
Événement DeviceMotion réactif |
AUTO |
useDeviceOrientation |
Événement DeviceOrientation réactif |
AUTO |
useDevicePixelRatio |
Suivi réactif window.devicePixelRatio |
AUTO |
useDevicesList |
énumération réactive des périphériques d'entrée/sortie disponibles |
AUTO |
useDisplayMedia |
Réactif mediaDevices.getDisplayMedia diffusion en continu |
AUTO |
useElementByPoint |
Réactif élément par élément |
AUTO |
useElementHover |
État de survol de l'élément réactif |
AUTO |
useFocus |
Utilitaire réactif permettant de suivre ou de définir l'état de focus d'un élément DOM |
AUTO |
useFocusWithin |
Utilitaire réactif permettant de vérifier si un élément ou l'un de ses descendants a le focus |
AUTO |
useFps |
FPS (images par seconde) réactif |
AUTO |
useGeolocation |
API de géolocalisation réactive |
AUTO |
useIdle |
Détecte si l'utilisateur est inactif |
AUTO |
useInfiniteScroll |
Défilement infini de l'élément |
AUTO |
useKeyModifier |
État du modificateur réactif |
AUTO |
useMagicKeys |
État réactif des touches enfoncées |
AUTO |
useMouse |
Position de la souris réactive |
AUTO |
useMousePressed |
État de pression de la souris réactive |
AUTO |
useNavigatorLanguage |
Langue du navigateur réactive |
AUTO |
useNetwork |
État du réseau réactif |
AUTO |
useOnline |
État en ligne réactif |
AUTO |
usePageLeave |
État réactif indiquant si la souris quitte la page |
AUTO |
useParallax |
Créer facilement un effet de parallaxe |
AUTO |
usePointer |
État réactif du pointeur |
AUTO |
usePointerLock |
Verrouillage réactif du pointeur |
AUTO |
usePointerSwipe |
Détection réactive du glissement basée sur les PointerEvents |
AUTO |
useScroll |
Position et état de défilement réactifs |
AUTO |
useScrollLock |
Verrouillage du défilement de l’élément |
AUTO |
useSpeechRecognition |
Reconnaissance vocale réactive |
AUTO |
useSpeechSynthesis |
Synthèse vocale réactive |
AUTO |
useSwipe |
Détection réactive des glissements basée sur TouchEvents |
AUTO |
useTextSelection |
Suivi réactif de la sélection de texte par l'utilisateur basé sur Window.getSelection |
AUTO |
useUserMedia |
Réactif mediaDevices.getUserMedia en continu |
AUTO |
Réseau
| Fonction |
Description |
Appel |
useEventSource |
Une instance EventSource ou Server-Sent-Events ouvre une connexion persistante vers un serveur HTTP |
AUTO |
useFetch |
L'API Reactive Fetch permet d'interrompre les requêtes |
AUTO |
useWebSocket |
Client WebSocket réactif |
AUTO |
Animation
| Fonction |
Description |
Appel |
useAnimate |
API d'animations Web réactives |
AUTO |
useInterval |
Compteur réactif qui s'incrémente à chaque intervalle |
AUTO |
useIntervalFn |
Enveloppe pour setInterval avec des commandes de contrôle |
AUTO |
useNow |
Courant réactif Instance Date |
AUTO |
useRafFn |
Appeler la fonction à chaque requestAnimationFrame |
AUTO |
useTimeout |
Valeur réactive qui devient true après un délai donné |
AUTO |
useTimeoutFn |
Enveloppe pour les setTimeout avec des commandes |
AUTO |
useTimestamp |
Horodatage du courant réactif |
AUTO |
useTransition |
Transition entre les valeurs |
AUTO |
Composant
| Fonction |
Description |
Appel |
computedInject |
Combiner computed et inject |
AUTO |
createReusableTemplate |
Définir et réutiliser un modèle dans la portée du composant |
AUTO |
createTemplatePromise |
Modèle sous forme de Promise |
AUTO |
templateRef |
Syntaxe abrégée pour lier une référence à un élément de modèle |
AUTO |
tryOnBeforeMount |
Sécurisé onBeforeMount |
AUTO |
tryOnBeforeUnmount |
Sécurisé onBeforeUnmount |
AUTO |
tryOnMounted |
Sécurisé onMounted |
AUTO |
tryOnScopeDispose |
Sécurisé onScopeDispose |
AUTO |
tryOnUnmounted |
Sécurisé onUnmounted |
AUTO |
unrefElement |
Récupère l'élément DOM sous-jacent à partir d'une référence Vue ou d'une instance de composant |
AUTO |
useCurrentElement |
Récupère l’élément DOM du composant actuel sous forme de ref |
AUTO |
useMounted |
État monté dans la référence |
AUTO |
useTemplateRefsList |
Syntaxe abrégée pour lier des refs à des éléments de modèle et à des composants à l'intérieur de v-for |
AUTO |
useVirtualList |
Créez facilement des listes virtuelles |
AUTO |
useVModel |
Syntaxe abrégée pour la liaison au modèle virtuel |
AUTO |
useVModels |
Abréviation pour la liaison au modèle V des props |
AUTO |
Surveiller
| Fonction |
Description |
Invocation |
until |
Surveillance ponctuelle des modifications |
AUTO |
watchArray |
Surveiller un tableau avec des ajouts et des suppressions |
AUTO |
watchAtMost |
watch avec le nombre de déclenchements |
AUTO |
watchDebounced |
Surveillance anti-rebond |
AUTO |
watchDeep |
Abréviation pour surveiller une valeur avec {deep: true} |
AUTO |
watchIgnorable |
Surveillance ignorable |
AUTO |
watchImmediate |
Syntaxe abrégée pour surveiller une valeur avec {immediate: true} |
AUTO |
watchOnce |
Abréviation pour la valeur de surveillance avec { once: true } |
AUTO |
watchPausable |
Surveillance pouvant être mise en pause |
AUTO |
watchThrottled |
Surveillance à débit limité |
AUTO |
watchTriggerable |
Montre pouvant être déclenchée manuellement |
AUTO |
watchWithFilter |
watch avec contrôle EventFilter supplémentaire |
AUTO |
whenever |
Abréviation pour indiquer que la valeur à surveiller doit être vraie |
AUTO |
Réactivité
| Fonction |
Description |
Invocation |
computedAsync |
Calculée pour les fonctions asynchrones |
AUTO |
computedEager |
Calcul anticipé sans évaluation paresseuse |
AUTO |
computedWithControl |
Définit explicitement les dépendances de la fonction calculée |
AUTO |
createRef |
Renvoie un deepRef ou shallowRef en fonction du deep paramètre |
AUTO |
extendRef |
Ajouter des attributs supplémentaires à Ref |
AUTO |
reactify |
Convertit les fonctions simples en fonctions réactives |
AUTO |
reactifyObject |
Appliquer reactify à un objet |
AUTO |
reactiveComputed |
Objet réactif calculé |
AUTO |
reactiveOmit |
Omettre de manière réactive des champs d’un objet réactif |
AUTO |
reactivePick |
Sélectionner de manière réactive des champs d'un objet réactif |
AUTO |
refAutoReset |
Une référence qui sera réinitialisée à sa valeur par défaut après un certain temps |
AUTO |
refDebounced |
Supprimer le rebond lors de l'exécution d'une valeur de référence |
AUTO |
refDefault |
Appliquer la valeur par défaut à une référence |
AUTO |
refManualReset |
Créer une référence avec fonctionnalité de réinitialisation manuelle |
AUTO |
refThrottled |
Limiter la modification de la valeur d'une référence |
AUTO |
refWithControl |
Contrôles précis de la valeur de référence et de sa réactivité |
AUTO |
syncRef |
Synchronisation bidirectionnelle des valeurs de référence |
AUTO |
syncRefs |
Synchronisation des références cibles avec une référence source |
AUTO |
toReactive |
Convertit la référence en référence réactive |
AUTO |
toRef |
Normaliser la valeur/référence/méthode d'accès en ref ou computed |
EXPLICIT_ONLY |
toRefs |
Extended toRefs qui accepte également les références à un objet |
AUTO |
Tableau
| Fonction |
Description |
Appel |
useArrayDifference |
Récupère de manière réactive la différence entre deux tableaux |
AUTO |
useArrayEvery |
Réactif Array.every |
AUTO |
useArrayFilter |
Réactif Array.filter |
AUTO |
useArrayFind |
Réactif Array.find |
AUTO |
useArrayFindIndex |
Réactif Array.findIndex |
AUTO |
useArrayFindLast |
Réactif Array.findLast |
AUTO |
useArrayIncludes |
Réactif Array.includes |
AUTO |
useArrayJoin |
Réactif Array.join |
AUTO |
useArrayMap |
Réactif Array.map |
AUTO |
useArrayReduce |
Réactif Array.reduce |
AUTO |
useArraySome |
Réactif Array.some |
AUTO |
useArrayUnique |
Tableau unique réactif |
AUTO |
useSorted |
Tableau de tri réactif |
AUTO |
Temps
| Fonction |
Description |
Appel |
useCountdown |
Compte à rebours réactif en secondes |
AUTO |
useDateFormat |
Récupère la date formatée selon la chaîne de tokens transmise |
AUTO |
useTimeAgo |
Temps écoulé (réactif) |
AUTO |
useTimeAgoIntl |
Temps écoulé de manière réactive avec prise en charge de l'i18n |
AUTO |
Utilitaires
| Fonction |
Description |
Appel |
createDisposableDirective |
Utilitaire permettant de créer des directives jetables |
AUTO |
createEventHook |
Utilitaire permettant de créer des hooks d'événements |
AUTO |
createUnrefFn |
Créer une fonction simple acceptant des valeurs de référence et des valeurs brutes comme arguments |
AUTO |
get |
Syntaxe abrégée pour accéder à ref.value |
EXPLICIT_ONLY |
isDefined |
Contrôle de type pour Ref garantissant l'absence de valeur nulle |
AUTO |
makeDestructurable |
Rend la destruction isomorphe possible à la fois pour les objets et les tableaux |
AUTO |
set |
Syntaxe abrégée pour ref.value = x |
EXPLICIT_ONLY |
useAsyncQueue |
Exécute chaque tâche asynchrone de manière séquentielle et transmet le résultat de la tâche en cours à la tâche suivante |
AUTO |
useBase64 |
Transformation Base64 réactive |
AUTO |
useCached |
Mise en cache d’une référence avec un comparateur personnalisé |
AUTO |
useCloned |
Clonage réactif d’une référence |
AUTO |
useConfirmDialog |
Crée des hooks d'événements pour prendre en charge les fenêtres modales et les chaînes de boîtes de dialogue de confirmation |
AUTO |
useCounter |
Compteur de base avec fonctions utilitaires |
AUTO |
useCycleList |
Parcourir une liste d'éléments |
AUTO |
useDebounceFn |
Supprimer le rebond lors de l'exécution d'une fonction |
AUTO |
useEventBus |
Un bus d'événements de base |
AUTO |
useMemoize |
Mise en cache des résultats des fonctions en fonction des arguments tout en conservant la réactivité |
AUTO |
useOffsetPagination |
Pagination réactive avec décalage |
AUTO |
usePrevious |
Conserve la valeur précédente d’une référence |
AUTO |
useStepper |
Fournit des aides à la création d'une interface d'assistant en plusieurs étapes |
AUTO |
useSupported |
Compatibilité SSR isSupported |
AUTO |
useThrottleFn |
Limitation de l'exécution d'une fonction |
AUTO |
useTimeoutPoll |
Utilisation d'un délai d'attente pour interroger quelque chose |
AUTO |
useToggle |
Un commutateur booléen avec des fonctions utilitaires |
AUTO |
useToNumber |
Convertir de manière réactive une référence de chaîne en nombre |
AUTO |
useToString |
Convertir de manière réactive une référence en chaîne de caractères |
AUTO |
@Electron
| Fonction |
Description |
Appel |
useIpcRenderer |
Fournit à ipcRenderer et à toutes ses API la réactivité Vue |
EXTERNE |
useIpcRendererInvoke |
Résultat de l'API réactive ipcRenderer.invoke |
EXTERNE |
useIpcRendererOn |
Utilisez facilement ipcRenderer.on et ipcRenderer.removeListener s'exécute automatiquement lors du démontage |
EXTERNE |
useZoomFactor |
Facteur de zoom réactif de WebFrame |
EXTERNE |
useZoomLevel |
Niveau de zoom de Reactive WebFrame |
EXTERNE |
@Firebase
| Fonction |
Description |
Appel |
useAuth |
Liaison réactive Firebase Auth |
EXTERNE |
useFirestore |
Liaison réactive Firestore |
EXTERNE |
useRTDB |
Liaison réactive avec la base de données en temps réel Firebase |
EXTERNE |
@Head
| Fonction |
Description |
Appel |
createHead |
Crée l'instance du gestionnaire de tête. |
EXTERNAL |
useHead |
Mettre à jour les balises méta du gestionnaire principal de manière réactive. |
EXTERNAL |
@Intégrations
| Fonction |
Description |
Appel |
useAsyncValidator |
Enveloppe pour async-validator |
EXTERNAL |
useAxios |
Enveloppe pour axios |
EXTERNAL |
useChangeCase |
Enveloppe réactive pour change-case |
EXTERNAL |
useCookies |
Enveloppe pour universal-cookie |
EXTERNAL |
useDrauu |
Instance réactive pour drauu |
EXTERNAL |
useFocusTrap |
Enveloppe réactive pour focus-trap |
EXTERNAL |
useFuse |
Implémentez facilement la recherche floue à l’aide d’un composable avec Fuse.js |
EXTERNE |
useIDBKeyval |
Enveloppe pour idb-keyval |
EXTERNAL |
useJwt |
Enveloppe pour jwt-decode |
EXTERNE |
useNProgress |
Enveloppe réactive pour nprogress |
EXTERNAL |
useQRCode |
Enveloppe pour qrcode |
EXTERNAL |
useSortable |
Enveloppe pour sortable |
EXTERNAL |
@Math
| Fonction |
Description |
Appel |
createGenericProjection |
Version générique de createProjection |
EXTERNAL |
createProjection |
Projection numérique réactive d'un domaine à un autre |
EXTERNAL |
logicAnd |
AND condition pour les références |
EXTERNAL |
logicNot |
NOT condition pour ref |
EXTERNE |
logicOr |
OR conditions pour les références |
EXTERNE |
useAbs |
Réactif Math.abs |
EXTERNAL |
useAverage |
Calculer la moyenne d'un tableau de manière réactive |
EXTERNE |
useCeil |
Réactif Math.ceil |
EXTERNE |
useClamp |
Limiter de manière réactive une valeur entre deux autres valeurs |
EXTERNE |
useFloor |
Réactif Math.floor |
EXTERNE |
useMath |
Réactif Math méthodes |
EXTERNE |
useMax |
Réactif Math.max |
EXTERNE |
useMin |
Réactif Math.min |
EXTERNE |
usePrecision |
Définir de manière réactive la précision d'un nombre |
EXTERNE |
useProjection |
Projection numérique réactive d'un domaine à un autre |
EXTERNE |
useRound |
Réactif Math.round |
EXTERNE |
useSum |
Obtenir la somme d'un tableau de manière réactive |
EXTERNE |
useTrunc |
Réactif Math.trunc |
EXTERNE |
@Motion
| Fonction |
Description |
Appel |
useElementStyle |
Synchronise un objet réactif avec le style CSS d'un élément cible |
EXTERNAL |
useElementTransform |
Synchroniser un objet réactif avec la transformation CSS d’un élément cible. |
EXTERNE |
useMotion |
Donner vie à vos composants. |
EXTERNE |
useMotionProperties |
Accéder aux propriétés de mouvement d’un élément cible. |
EXTERNE |
useMotionVariants |
Gérer l'état et la sélection des variantes. |
EXTERNE |
useSpring |
Animations Spring. |
EXTERNE |
@Router
| Fonction |
Description |
Appel |
useRouteHash |
Syntaxe abrégée pour un routeur réactif route.hash |
EXTERNAL |
useRouteParams |
Syntaxe abrégée pour un réactif route.params |
EXTERNAL |
useRouteQuery |
Synonyme de « réactif » route.query |
EXTERNAL |
@RxJS
| Fonction |
Description |
Invocation |
from |
Enveloppes autour des méthodes from() et fromEvent() de RxJS afin de leur permettre d’accepter refs |
EXTERNES |
toObserver |
fonction Sugar permettant de convertir un ref en un observateur RxJS |
EXTERNE |
useExtractedObservable |
Utiliser un RxJS Observable extrait d’un ou plusieurs composables |
EXTERNE |
useObservable |
Utiliser un RxJS Observable |
EXTERNE |
useSubject |
Lier un RxJS Subject à un ref et propager les changements de valeur dans les deux sens |
EXTERNE |
useSubscription |
Utiliser un RxJS Subscription sans vous soucier de vous désabonner ou de créer des fuites de mémoire |
EXTERNE |
watchExtractedObservable |
Surveillez les valeurs d’un RxJS Observable telles qu’elles sont extraites d’un ou plusieurs composables |
EXTERNE |
@SchemaOrg
| Fonction |
Description |
Appel |
createSchemaOrg |
Crée l'instance du gestionnaire schema.org. |
EXTERNAL |
useSchemaOrg |
Mettre à jour schema.org de manière réactive. |
EXTERNAL |
@Sound
| Fonction |
Description |
Appel |
useSound |
Lire des effets sonores de manière réactive. |
EXTERNAL |
Voir sur 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 |