useLocalStorage

Category

State

Export Size

2.02 kB

Last Changed

last year

Related

useStorage

Reactive LocalStorage.

Usage

Please refer to useStorage.

Type Declarations

export declare function useLocalStorage(
  key: MaybeRefOrGetter<string>,
  initialValue: MaybeRefOrGetter<string>,
  options?: UseStorageOptions<string>,
): RemovableRef<string>
export declare function useLocalStorage(
  key: MaybeRefOrGetter<string>,
  initialValue: MaybeRefOrGetter<boolean>,
  options?: UseStorageOptions<boolean>,
): RemovableRef<boolean>
export declare function useLocalStorage(
  key: MaybeRefOrGetter<string>,
  initialValue: MaybeRefOrGetter<number>,
  options?: UseStorageOptions<number>,
): RemovableRef<number>
export declare function useLocalStorage<T>(
  key: MaybeRefOrGetter<string>,
  initialValue: MaybeRefOrGetter<T>,
  options?: UseStorageOptions<T>,
): RemovableRef<T>
export declare function useLocalStorage<T = unknown>(
  key: MaybeRefOrGetter<string>,
  initialValue: MaybeRefOrGetter<null>,
  options?: UseStorageOptions<T>,
): RemovableRef<T>

Source

Source • Docs

Contributors

Anthony Fu

Antério Vieira

RYGRIT

Yauheni Vasiukevich

Anthony Fu

ntnyq

Jelf

Shinigami

Pig Fang

Alex Kozack

Changelog

v13.6.0 on

2d179 - fix(types): use Vue's native MaybeRef and MaybeRefOrGetter instead (#4913)

v12.4.0 on

eb679 - feat(useStorage): make storage key reactive (#4464)