Skip to content

VueUseCollection of Vue Composition Utilities

Collection of Essential Vue Composition Utilities

useSessionStorage

Category
Export Size
2.03 kB
Last Changed
5 months 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

SourceDocs

Contributors

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

Changelog

v12.8.0 on
7432f - feat(types): deprecate MaybeRef and MaybeRefOrGetter in favor of Vue's native (#4636)
v12.4.0 on
eb679 - feat(useStorage): make storage key reactive (#4464)
v10.0.0-beta.4 on
4d757 - feat(types)!: rename MaybeComputedRef to MaybeRefOrGetter

Released under the MIT License.

Build faster with AI
New Masterclass to help you leverage AI in your Vue workflow
Get Early Access