@vueuse/core

What is @vueuse/core?

The @vueuse/core package is a collection of essential Vue Composition API utilities that help with a wide range of common application needs, from state management to utilities for handling side effects. It's designed to work seamlessly with Vue 3, leveraging the Composition API to make building and managing Vue applications easier and more intuitive.

What are @vueuse/core's main functionalities?

State Management

This feature allows you to easily synchronize a reactive state with localStorage, enabling persistent state across page reloads. The example demonstrates how to store and retrieve user settings.

import { ref } from 'vue'
import { useLocalStorage } from '@vueuse/core'

const userSettings = useLocalStorage('user-settings', { theme: 'dark', notifications: true })

Sensor Utilities

Sensor utilities provide reactive access to browser sensors like mouse position. The example shows how to track the mouse position on the screen.

import { useMouse } from '@vueuse/core'

const { x, y } = useMouse()

Animation

This feature enables easy setup of interval-based side effects, useful for animations or regular data fetching. The code sample demonstrates setting up a simple interval that logs a message every second.

import { useIntervalFn } from '@vueuse/core'

const { pause, resume } = useIntervalFn(() => console.log('Tick'), 1000)

Other packages similar to @vueuse/core

vue-composable

Vue-composable is similar to @vueuse/core, offering a set of composable utilities for Vue. While it covers many of the same areas as @vueuse/core, such as state management and sensor utilities, it has its own unique set of composables and might be preferred for certain use cases.

vuelidate

Vuelidate provides Vue applications with model-based validation. While it focuses specifically on form validation, rather than a broad range of utilities like @vueuse/core, it's a powerful tool for ensuring data integrity in user inputs.

README

Collection of essential Vue Composition Utilities

🚀 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

Vue 3 Demo: Vite, Webpack / Vue 2 Demo: Vue CLI

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

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

🧱 Contribute

See the Contributing Guide

🌸 Thanks

This project is heavily inspired by the following awesome projects.

• streamich/react-use
• u3u/vue-hooks
• shuidi-fed/vue-composition-toolkit
• logaretm/vue-use-web
• kripod/react-hooks

And thanks to all the contributors on GitHub!

👨‍🚀 Contributors

Financial Contributors on Open Collective

📄 License

MIT License © 2019-PRESENT Anthony Fu