mirror of
https://github.com/streamich/react-use.git
synced 2025-12-08 18:02:14 +00:00
36 lines
799 B
Markdown
36 lines
799 B
Markdown
# `useSessionStorage`
|
|
|
|
React side-effect hook that manages a single `sessionStorage` key.
|
|
|
|
|
|
## Usage
|
|
|
|
```jsx
|
|
import {useSessionStorage} from 'react-use';
|
|
|
|
const Demo = () => {
|
|
const [value, setValue] = useSessionStorage('my-key', 'foo');
|
|
|
|
return (
|
|
<div>
|
|
<div>Value: {value}</div>
|
|
<button onClick={() => setValue('bar')}>bar</button>
|
|
<button onClick={() => setValue('baz')}>baz</button>
|
|
</div>
|
|
);
|
|
};
|
|
```
|
|
|
|
|
|
## Reference
|
|
|
|
```js
|
|
useSessionStorage(key);
|
|
useSessionStorage(key, initialValue);
|
|
useSessionStorage(key, initialValue, raw);
|
|
```
|
|
|
|
- `key` — `sessionStorage` key to manage.
|
|
- `initialValue` — initial value to set, if value in `sessionStorage` is empty.
|
|
- `raw` — boolean, if set to `true`, hook will not attempt to JSON serialize stored values.
|