Socket
Socket
Sign inDemoInstall

@vueuse/core

Package Overview
Dependencies
0
Maintainers
1
Versions
346
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @vueuse/core

Collection of essential Vue Composition API


Version published
Weekly downloads
1.4M
increased by13.51%
Maintainers
1
Created
Weekly downloads
 

Package description

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

Readme

Source

logo

NPM version Storybook Demos GitHub last commit GitHub issues GitHub stars

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

🚧 Working in progress...

📦 Install

We supports both Vue 3.x and Vue 2.x, you can seamlessly upgrade it when you migrate from Vue 2.x to 3.x.

Vue 3.x (vue-next)

npm i @vueuse/core@next

Vue 2.x with composition-api polyfill

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

Register the Composition API Plugin before other APIs.

⚡ Functions

You can checkout the documents and live demos in Storybook.

  • useNow
  • useCounter
  • useRaf
  • useTimeout
  • useTimeoutFn

More functions to be added. Please keep turned.

📄 License

MIT License © 2019-2020 Anthony Fu

Keywords

FAQs

Last updated on 24 Dec 2019

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc