VueUse

Appearance

Return to top
On this page

useStorage

Category
Last Changed
3 years ago
Related

Reactive LocalStorage/SessionStorage

TIP

When using with Nuxt 3, this functions will NOT be auto imported in favor of Nitro's built-in useStorage(). Use explicit import if you want to use the function from VueUse.

Demo

source

name: 'Banana'
color: 'Yellow'
size: 'Medium'
count: 0

Usage 

import { useStorage } from '@vueuse/core'

// bind object
const state = useStorage('my-store', { hello: 'hi', greeting: 'Hello' })

// bind boolean
const flag = useStorage('my-flag', true) // returns Ref<boolean>

// bind number
const count = useStorage('my-count', 0) // returns Ref<number>

// bind string with SessionStorage
const id = useStorage('my-id', 'some-string-id', sessionStorage) // returns Ref<string>

// delete data from storage
state.value = null

import { useStorage } from '@vueuse/core'

// bind object
const state = useStorage('my-store', { hello: 'hi', greeting: 'Hello' })

// bind boolean
const flag = useStorage('my-flag', true) // returns Ref<boolean>

// bind number
const count = useStorage('my-count', 0) // returns Ref<number>

// bind string with SessionStorage
const id = useStorage('my-id', 'some-string-id', sessionStorage) // returns Ref<string>

// delete data from storage
state.value = null

Custom Serialization

By default, useStoragewill smartly use the corresponding serializer based on the data type of provided default value. For example, JSON.stringify / JSON.parse will be used for objects, Number.toString / parseFloat for numbers, etc.

You can also provide your own serialization function to useStorage

import { useStorage } from '@vueuse/core'

useStorage(
  'key',
  {},
  undefined,
  {
    serializer: {
      read: (v: any) => v ? JSON.parse(v) : null,
      write: (v: any) => JSON.stringify(v),
    },
  },
)

import { useStorage } from '@vueuse/core'

useStorage(
  'key',
  {},
  undefined,
  {
    serializer: {
      read: (v: any) => v ? JSON.parse(v) : null,
      write: (v: any) => JSON.stringify(v),
    },
  },
)

Please note when you provide null as the default value, useStoragecan't assume the data type from it. In this case, you can provide a custom serializer or reuse the built-in ones explicitly.

import { StorageSerializers, useStorage } from '@vueuse/core'

const objectLike = useStorage('key', null, undefined, { serializer: StorageSerializers.object })
objectLike.value = { foo: 'bar' }

import { StorageSerializers, useStorage } from '@vueuse/core'

const objectLike = useStorage('key', null, undefined, { serializer: StorageSerializers.object })
objectLike.value = { foo: 'bar' }

Type Declarations

Show Type Declarations
export interface Serializer<T> {
  read(raw: string): T
  write(value: T): string
}
export interface SerializerAsync<T> {
  read(raw: string): Awaitable<T>
  write(value: T): Awaitable<string>
}
export declare const StorageSerializers: Record<
  "boolean" | "object" | "number" | "any" | "string" | "map" | "set" | "date",
  Serializer<any>
>
export interface StorageOptions<T>
  extends ConfigurableEventFilter,
    ConfigurableWindow,
    ConfigurableFlush {
  /**
   * Watch for deep changes
   *
   * @default true
   */
  deep?: boolean
  /**
   * Listen to storage changes, useful for multiple tabs application
   *
   * @default true
   */
  listenToStorageChanges?: boolean
  /**
   * Write the default value to the storage when it does not exist
   *
   * @default true
   */
  writeDefaults?: boolean
  /**
   * Custom data serialization
   */
  serializer?: Serializer<T>
  /**
   * On error callback
   *
   * Default log error to `console.error`
   */
  onError?: (error: unknown) => void
  /**
   * Use shallow ref as reference
   *
   * @default false
   */
  shallow?: boolean
}
export declare function useStorage(
  key: string,
  initialValue: MaybeRef<string>,
  storage?: StorageLike,
  options?: StorageOptions<string>
): RemovableRef<string>
export declare function useStorage(
  key: string,
  initialValue: MaybeRef<boolean>,
  storage?: StorageLike,
  options?: StorageOptions<boolean>
): RemovableRef<boolean>
export declare function useStorage(
  key: string,
  initialValue: MaybeRef<number>,
  storage?: StorageLike,
  options?: StorageOptions<number>
): RemovableRef<number>
export declare function useStorage<T>(
  key: string,
  initialValue: MaybeRef<T>,
  storage?: StorageLike,
  options?: StorageOptions<T>
): RemovableRef<T>
export declare function useStorage<T = unknown>(
  key: string,
  initialValue: MaybeRef<null>,
  storage?: StorageLike,
  options?: StorageOptions<T>
): RemovableRef<T>

export interface Serializer<T> {
  read(raw: string): T
  write(value: T): string
}
export interface SerializerAsync<T> {
  read(raw: string): Awaitable<T>
  write(value: T): Awaitable<string>
}
export declare const StorageSerializers: Record<
  "boolean" | "object" | "number" | "any" | "string" | "map" | "set" | "date",
  Serializer<any>
>
export interface StorageOptions<T>
  extends ConfigurableEventFilter,
    ConfigurableWindow,
    ConfigurableFlush {
  /**
   * Watch for deep changes
   *
   * @default true
   */
  deep?: boolean
  /**
   * Listen to storage changes, useful for multiple tabs application
   *
   * @default true
   */
  listenToStorageChanges?: boolean
  /**
   * Write the default value to the storage when it does not exist
   *
   * @default true
   */
  writeDefaults?: boolean
  /**
   * Custom data serialization
   */
  serializer?: Serializer<T>
  /**
   * On error callback
   *
   * Default log error to `console.error`
   */
  onError?: (error: unknown) => void
  /**
   * Use shallow ref as reference
   *
   * @default false
   */
  shallow?: boolean
}
export declare function useStorage(
  key: string,
  initialValue: MaybeRef<string>,
  storage?: StorageLike,
  options?: StorageOptions<string>
): RemovableRef<string>
export declare function useStorage(
  key: string,
  initialValue: MaybeRef<boolean>,
  storage?: StorageLike,
  options?: StorageOptions<boolean>
): RemovableRef<boolean>
export declare function useStorage(
  key: string,
  initialValue: MaybeRef<number>,
  storage?: StorageLike,
  options?: StorageOptions<number>
): RemovableRef<number>
export declare function useStorage<T>(
  key: string,
  initialValue: MaybeRef<T>,
  storage?: StorageLike,
  options?: StorageOptions<T>
): RemovableRef<T>
export declare function useStorage<T = unknown>(
  key: string,
  initialValue: MaybeRef<null>,
  storage?: StorageLike,
  options?: StorageOptions<T>
): RemovableRef<T>

Source

Source • Demo • Docs

Contributors

Anthony Fu
Jeffrey Li
spking11
Maurici Abad Gutierrez
Jelf
Guillaume Chau
Denis Blazhkun
Andreas Weber
Le Minh Tri
Jamie Warburton
Shinigami
Sasan Farrokh
Pig Fang
wheat
Alex Kozack
Nurettin Kaya
Pine
Antério Vieira
Ivan Demchuk

Changelog

v8.2.4 on 4/3/2022
9b238 - fix: fix Set serialize error (#1475)
v8.2.2 on 3/31/2022
f5f6a - feat: support serializing Date (#1471)
71105 - fix: update on same tick (#1472)
v8.2.0 on 3/25/2022
1ae32 - fix: fix sync racing and shreding (#1459)
v8.1.1 on 3/16/2022
27d1b - fix(useStroage): synced timing
v8.1.0 on 3/16/2022
1ee0a - fix: useStorage sync race condition, closes #808 (#1430)
v7.5.3 on 1/5/2022
77fe0 - fix(storage): caught DOMException accessing storage (#1124)
v7.4.1 on 12/23/2021
3aa49 - feat: ssr handlers (#1060)
v7.3.0 on 12/12/2021
169b0 - feat(useStorageAsync): new function
v6.9.2 on 11/19/2021
80409 - fix: interface typos (#938)
v6.6.2 on 10/18/2021
c6435 - fix: macro task for listening to storage change
bdce1 - feat: new writeDefaults option
bc223 - feat: support Map and Set
v6.6.0 on 10/16/2021
ad5d5 - feat: support shallow ref (#805)
v6.3.3 on 9/12/2021
d6dd1 - feat: support writing null value to storage, close #452
8a9c4 - feat: support pass ref to useStorage
v6.1.0 on 9/2/2021
dee2f - fix: support TypeScript 4.4