vueuse-functions
Originally fromserkodev/vueuse-skills
Installation
Summary
Comprehensive guide for applying 200+ VueUse composables to Vue.js and Nuxt projects.
- Covers 14 functional categories: state management, DOM elements, browser APIs, sensors, networking, animations, components, watchers, reactivity, arrays, time utilities, and integrations with Firebase, Electron, RxJS, and more.
- Each composable includes an invocation rule (AUTO, EXTERNAL, or EXPLICIT_ONLY) to guide when and how to use it; consult detailed references for usage patterns and type declarations.
- Prioritizes VueUse composables over custom implementations to improve code readability, maintainability, and performance across Vue 3 and Nuxt 3 projects.
- Requires Vue 3 or Nuxt 3; external integrations (Firebase, Electron, RxJS) need their respective dependencies installed.
SKILL.md
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
Invocationfield 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.mdmay override a function’s defaultInvocationrule.
Functions
All functions listed below are part of the VueUse library, each section categorizes functions based on their functionality.