Created
February 12, 2023 04:50
-
-
Save Tim-W-James/4762d3f5f234c4e01c0f145b882c3153 to your computer and use it in GitHub Desktop.
React useLocalStorage Custom Hook #hooks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| // Adapted from: https://usehooks.com/useLocalStorage/ | |
| /** | |
| * Get and set a value in browser local storage | |
| * | |
| * @param {string} key - key for the data | |
| * @param {T} initialValue - initial data value | |
| */ | |
| const useLocalStorage = <T>(key: string, initialValue: T) => { | |
| // State to store our value | |
| // Pass initial state function to useState so logic is only executed once | |
| const [storedValue, setStoredValue] = useState<T>(() => { | |
| if (typeof window === "undefined") { | |
| return initialValue; | |
| } | |
| 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) { | |
| // If error also return initialValue | |
| console.error(error); | |
| return initialValue; | |
| } | |
| }); | |
| // Return a wrapped version of useState's setter function that ... | |
| // ... persists the new value to localStorage. | |
| const setValue = (value: T | ((val: T) => T)) => { | |
| 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 | |
| if (typeof window !== "undefined") { | |
| window.localStorage.setItem(key, JSON.stringify(valueToStore)); | |
| } | |
| } catch (error) { | |
| // A more advanced implementation would handle the error case | |
| console.error(error); | |
| } | |
| }; | |
| return [storedValue, setValue] as const; | |
| }; | |
| export default useLocalStorage; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment