@oaviv/vueuse-chrome-storage
v1.0.0
Published
A VueUse storage provider using Chrome Storage
Downloads
17
Maintainers
Readme
vueuse-chrome-storage
A custom storage provider for VueUse's useStorage
composable that allows seamless integration with Chrome's chrome.storage.local
API. Easily store and sync reactive state across your Vue 3 application using Chrome Storage.
Features
- Drop-in replacement for VueUse’s
localStorage
provider. - Uses Chrome's
chrome.storage.local
API for persistent storage. - Supports the same API as
useStorage
, making it simple to integrate. - Automatically syncs state changes with Chrome Storage.
- Compatible with Vue 3 and VueUse composables.
Installation
First, ensure you have @vueuse/core
installed in your project. If not, you can install both vueuse-chrome-storage
and @vueuse/core
with the following command:
npm install vueuse-chrome-storage @vueuse/core
If @vueuse/core
is already installed:
npm install vueuse-chrome-storage
Usage
This package provides a chromeStorage
provider that can be passed to VueUse’s useStorage
composable, which will then use Chrome's storage API instead of localStorage
.
Example:
import { useStorage } from '@vueuse/core'
import chromeStorage from 'vueuse-chrome-storage'
// Create a reactive state synced with Chrome's storage
const myState = useStorage('my-key', 'defaultValue', chromeStorage)
Detailed Example:
Here is an example of how you can use vueuse-chrome-storage
inside a Vue 3 component:
import { ref } from 'vue'
import { useStorage } from '@vueuse/core'
import chromeStorage from 'vueuse-chrome-storage'
export default {
setup() {
// The value of `message` will persist in Chrome storage under the key 'my-message'
const message = useStorage('my-message', 'Hello, World!', chromeStorage)
return {
message
}
}
}
In this example, the state message
is synced with Chrome storage under the key my-message
. Any changes to message
will be persisted, and the state will be restored from Chrome storage when the component is reloaded.
How It Works
vueuse-chrome-storage
uses Chrome’s chrome.storage.local
API, which is asynchronous. The provider exposes the required getItem
, setItem
, and removeItem
methods that VueUse's useStorage
composable requires to function.
Under the hood, it wraps Chrome's storage API calls with Promises to handle the asynchronous nature of the Chrome API.
License
This project is licensed under the MIT License. See the LICENSE file for more details.
Author
Developed and maintained by Ohad Aviv.
Keywords
- vue
- vueuse
- chrome-storage
- chrome-extension
- useStorage