Repository files navigation

Collection of essential Vue Composition Utilities

• 🎪Interactive docs & demos
• ⚡Fully tree shakeable: Only take what you want,bundle size
• 🦾Type Strong: Written inTypeScript, withTS Docs
• 🔋SSR Friendly
• 🌎No bundler required: Usable via CDN
• 🔩Flexible: Configurable event filters and targets
• 🔌OptionalAdd-ons: Router, Firebase, RxJS, etc.

import{useLocalStorage,useMouse,usePreferredDark}from'@vueuse/core'const{ x, y}=useMouse()// if user prefers dark themeconstisDark=usePreferredDark()// persist state in localStorageconststore=useLocalStorage('my-storage',{name:'Apple',color:'red',},)

Refer tofunctions list ordocumentations for more details.

From v14.0, VueUse requires Vue v3.5+From v13.0, VueUse requires Vue v3.3+From v12.0, VueUse no longer supports Vue 2. Please use v11.x for Vue 2 support.

npm i @vueuse/core

Add ons |Nuxt Module

• Vite + Vue 3
• Nuxt 3 + Vue 3
• Webpack + Vue 3

<script src="https://unpkg.com/@vueuse/shared"></script><script src="https://unpkg.com/@vueuse/core"></script>

It will be exposed to global aswindow.VueUse

See theContributing Guide

This project is heavily inspired by the following awesome projects.

• streamich/react-use
• u3u/vue-hooks
• logaretm/vue-use-web
• kripod/react-hooks

And thanks toall the contributors on GitHub!

MIT License © 2019-PRESENTAnthony Fu