Created
September 7, 2022 08:06
-
-
Save kachar/0972de77a1a83af92e472d3e47b9fb6e to your computer and use it in GitHub Desktop.
This file contains 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
import { Dispatch, SetStateAction, useState } from 'react' | |
export default function useLocalStorage<T>( | |
key: string, | |
initialValue: T, | |
): [T, Dispatch<SetStateAction<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.log(error) | |
return initialValue | |
} | |
}) | |
// Return a wrapped version of useState's setter function that ... | |
// ... persists the new value to localStorage. | |
const setValue: Dispatch<SetStateAction<T>> = (value) => { | |
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)) | |
} | |
// We dispatch a custom event so every useLocalStorage hook are notified | |
window.dispatchEvent(new Event('local-storage')) | |
} catch (error) { | |
// A more advanced implementation would handle the error case | |
console.log(error) | |
} | |
} | |
return [storedValue, setValue] | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment