@vueuse/core
    TypeScript icon, indicating that this package has built-in type declarations

    7.5.3 • Public • Published

    VueUse - Collection of essential Vue Composition Utilities
    Collection of essential Vue Composition Utilities

    NPM version NPM Downloads Docs & Demos Function Count
    GitHub stars

    🚀 Features

    • 🎪 Interactive docs & demos
    • 🕶 Seamless migration: Works for both Vue 3 and 2
    • Fully tree shakable: Only take what you want, bundle size
    • 🦾 Type Strong: Written in Typescript, with TS Docs
    • 🔋 SSR Friendly
    • 🌎 No bundler required: Usable via CDN
    • 🔩 Flexible: Configurable event filters and targets
    • 🔌 Optional Add-ons: Router, Firebase, RxJS, etc.

    🦄 Usage

    import { useMouse, usePreferredDark, useLocalStorage } from '@vueuse/core'
    
    export default {
      setup() {
        // tracks mouse position
        const { x, y } = useMouse()
    
        // is user prefers dark theme
        const isDark = usePreferredDark()
    
        // persist state in localStorage
        const store = useLocalStorage(
          'my-storage',
          {
            name: 'Apple',
            color: 'red',
          },
        )
    
        return { x, y, isDark, store }
      }
    }

    Refer to functions list or documentations for more details.

    📦 Install

    🎩 From v4.0, it works for Vue 2 & 3 within a single package by the power of vue-demi!

    npm i @vueuse/core

    Add ons | Nuxt Module

    From v6.0, VueUse requires vue >= v3.2 or @vue/composition-api >= v1.1

    Demos

    CDN

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

    It will be exposed to global as window.VueUse

    🪴 Project Activity

    Alt

    🧱 Contribute

    See the Contributing Guide

    🌸 Thanks

    This project is heavily inspired by the following awesome projects.

    And thanks to all the contributors on GitHub!

    👨‍🚀 Contributors

    Financial Contributors on Open Collective

    📄 License

    MIT License © 2019-PRESENT Anthony Fu

    Install

    npm i @vueuse/core

    DownloadsWeekly Downloads

    99,513

    Version

    7.5.3

    License

    MIT

    Unpacked Size

    724 kB

    Total Files

    12

    Last publish

    Collaborators

    • antfu
    • egoist
    • tahul