-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
useLocalStorage.ts
49 lines (44 loc) 路 1.58 KB
/
useLocalStorage.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
import { useState } from 'react';
/**
*
* @example
```jsx
const [isDarkModeStorage, setIsDarkMode] = useLocalStorage('darkMode', isDarkModeDefault);
```
based on https://usehooks.com/useLocalStorage/
@category Hooks
*/
const useLocalStorage = <V>(key: string, initialValue: V) => {
// State to store our value
// Pass initial state function to useState so logic is only executed once
const [storedValue, setStoredValue] = useState(() => {
try {
// Get from local storage by key
const item = window.localStorage.getItem(key);
// Parse stored json or if none return initialValue
return item ? JSON.parse(item) : initialValue;
} catch (error: any) {
// If error also return initialValue
// eslint-disable-next-line no-console
console.error('An error occurred getting a sessionStorage key', error);
return initialValue;
}
});
// Return a wrapped version of useState's setter function that ...
// ... persists the new value to localStorage.
const setValue = (value: V) => {
try {
// Allow value to be a function so we have same API as useState
const valueToStore = value instanceof Function ? value(storedValue) : value;
// Save state
setStoredValue(valueToStore);
// Save to local storage
window.localStorage.setItem(key, JSON.stringify(valueToStore));
} catch (error: any) {
// eslint-disable-next-line no-console
console.error('An error occurred writing to sessionStorage', error);
}
};
return [storedValue, setValue];
};
export default useLocalStorage;