JSPM – @vueuse/core@2.0.0-alpha.17

Package Exports

@vueuse/core

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@vueuse/core) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Dependencies

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

🚧 Working in progress...

🚀 Features

0 dependencies ⚡ No worry about your bundle size
Fully tree shakable 🌴 Only take what you want
Seamless migration 🕶 Use it now! Works for both Vue 3.x and 2.x
Browser compatible 🌐 No need to setup build tools
Intractive docs & demos 🎪 Check out Storybook out!

📦 Install

for Vue 3.x (vue-next)

npm i @vueuse/core@next

for Vue 2.x with composition-api polyfill

npm i @vue/composition-api
npm i @vueuse/core

Please register the Composition API Plugin before other using APIs.

CDN

<!-- For Vue 3.x -->
<script src="https://unpkg.com/@vueuse/core@next"></script> 

<!-- For Vue 2.x -->
<script src="https://unpkg.com/@vueuse/core"></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'

🌸 Thanks

This project is heavily inspired by following awesome projects.

Thanks!

@vueuse/core