-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #50 from archerdao/dev
UX improvements
- Loading branch information
Showing
5 changed files
with
120 additions
and
6 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| import { useEffect, useState } from 'react' | ||
|
|
||
| function useLocalStorage<T>( | ||
| key: string, | ||
| initialValue: T, | ||
| ): [T, (value: T) => void] { | ||
| // Get from local storage then | ||
| // parse stored json or return initialValue | ||
| const readValue = () => { | ||
| // Prevent build error "window is undefined" but keep keep working | ||
| if (typeof window === 'undefined') { | ||
| return initialValue | ||
| } | ||
|
|
||
| try { | ||
| const item = window.localStorage.getItem(key) | ||
| return item ? JSON.parse(item) : initialValue | ||
| } catch (error) { | ||
| console.warn(`Error reading localStorage key “${key}”:`, error) | ||
| return initialValue | ||
| } | ||
| } | ||
|
|
||
| // State to store our value | ||
| // Pass initial state function to useState so logic is only executed once | ||
| const [storedValue, setStoredValue] = useState<T>(readValue) | ||
|
|
||
| // Return a wrapped version of useState's setter function that ... | ||
| // ... persists the new value to localStorage. | ||
| const setValue = (value: T) => { | ||
| // Prevent build error "window is undefined" but keeps working | ||
| if (typeof window == 'undefined') { | ||
| console.warn( | ||
| `Tried setting localStorage key “${key}” even though environment is not a client`, | ||
| ) | ||
| } | ||
|
|
||
| try { | ||
| // Allow value to be a function so we have the same API as useState | ||
| const newValue = value instanceof Function ? value(storedValue) : value | ||
|
|
||
| // Save to local storage | ||
| window.localStorage.setItem(key, JSON.stringify(newValue)) | ||
|
|
||
| // Save state | ||
| setStoredValue(newValue) | ||
|
|
||
| // We dispatch a custom event so every useLocalStorage hook are notified | ||
| window.dispatchEvent(new Event('local-storage')) | ||
| } catch (error) { | ||
| console.warn(`Error setting localStorage key “${key}”:`, error) | ||
| } | ||
| } | ||
|
|
||
| useEffect(() => { | ||
| setStoredValue(readValue()) | ||
| // eslint-disable-next-line react-hooks/exhaustive-deps | ||
| }, []) | ||
|
|
||
| useEffect(() => { | ||
| const handleStorageChange = () => { | ||
| setStoredValue(readValue()) | ||
| } | ||
|
|
||
| // this only works for other documents, not the current one | ||
| window.addEventListener('storage', handleStorageChange) | ||
|
|
||
| // this is a custom event, triggered in writeValueToLocalStorage | ||
| window.addEventListener('local-storage', handleStorageChange) | ||
|
|
||
| return () => { | ||
| window.removeEventListener('storage', handleStorageChange) | ||
| window.removeEventListener('local-storage', handleStorageChange) | ||
| } | ||
| // eslint-disable-next-line react-hooks/exhaustive-deps | ||
| }, []) | ||
|
|
||
| return [storedValue, setValue] | ||
| } | ||
|
|
||
| export default useLocalStorage |
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
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
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