@vueuse/core
Advanced tools
Package description
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.
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)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 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
import { useLocalStorage, useMouse, usePreferredDark } from '@vueuse/core'
export default {
setup() {
// tracks mouse position
const { x, y } = useMouse()
// if 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.
🎩 From v4.0, it works for Vue 2 & 3 within a single package by the power of vue-demi!
npm i @vueuse/core
From v6.0, VueUse requires
vue>= v3.2 or@vue/composition-api>= v1.1
<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
See the Contributing Guide
This project is heavily inspired by the following awesome projects.
And thanks to all the contributors on GitHub!
MIT License © 2019-PRESENT Anthony Fu
FAQs
Collection of essential Vue Composition Utilities
The npm package @vueuse/core receives a total of 1,123,504 weekly downloads. As such, @vueuse/core popularity was classified as popular.
We found that @vueuse/core demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.