Collection of essential Vue Composition API (inspired by react-use)

Please [register the Composition API Plugin]( before other using APIs.

### CDN

<!-- For Vue 3.x -->
<script src="[email protected]"></script> 

<!-- For Vue 2.x -->
<script src=""></script>

It will be exposed to global variable window.VueUse

⚡ Functions

You can checkout the documents and live demos in Storybook.

  • useCounter
  • useIntervalFn
  • useStorage
  • useStoragePlain
  • useNow
  • useRaf
  • useTimeout
  • useTimeoutFn
  • useWindowScroll
  • useWindowSize

More functions to be added. Please keep turned. (PRs are also welcome!)

🔬 Technical Details

The Versioning

For every release, it will release two version of this package. The 3.x.x is used for Vue 3.x and the 2.x.x is used for 2.x. We use the major version number to distinguish the different target version will the minor and patch numbers are shared in both packages.

Different between 3.x and 2.x

Since the Composition API will be available in 3.x. Using it in 2.x require you use a polyfill. For 3.x build, we use the API from @vue/runtime-dom, and for 2.x, it's @vue/composition-api

// 3.x build
import { ref } from '@vue/runtime-dom'

// 2.x build
import { ref } from '@vue/composition-api'