Skip to content

useSessionStorage ​

Category
Export Size
2.02 kB
Last Changed
2 years ago
Related

Reactive SessionStorage.

Usage ​

Please refer to useStorage.

Type Declarations ​

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

Source ​

Source • Docs

Contributors ​

Anthony Fu
Antério Vieira
IlyaL
Yauheni Vasiukevich
Anthony Fu
ntnyq
Jelf
Shinigami
Pig Fang
Alex Kozack

Changelog ​

7432f - feat(types): deprecate MaybeRef and MaybeRefOrGetter in favor of Vue's native (#4636)
eb679 - feat(useStorage): make storage key reactive (#4464)

Released under the MIT License.