sigit/sigit.io
7
2
Fork 0
Code Issues 25 Pull Requests 1 Actions Packages Projects 1 Releases 5 Wiki Activity

refactor(hooks): add comments to local storage hook
Some checks failed
Open PR on Staging / audit_and_check (pull_request) Failing after 16s
Details

Browse Source
This commit is contained in:
en 2025-03-11 10:58:19 +00:00
parent afdc9449b1
commit 4f5dcc0336
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/hooks/useLocalStorage.ts
View File

@ -6,6 +6,11 @@ import {
setLocalStorageItem setLocalStorageItem
} from '../utils' } from '../utils'
/**
* Subscribe to the Browser's storage event. Get the new value if any of the tabs changes it.
* @param callback - function to be called when the storage event is triggered
* @returns clean up function
*/
const useLocalStorageSubscribe = (callback: () => void) => { const useLocalStorageSubscribe = (callback: () => void) => {
window.addEventListener('storage', callback) window.addEventListener('storage', callback)
return () => window.removeEventListener('storage', callback) return () => window.removeEventListener('storage', callback)
@ -28,8 +33,11 @@ export function useLocalStorage<T>(
) )
} }
// https://react.dev/reference/react/useSyncExternalStore
// Returns the snapshot of the data and subscribes to the storage event
const data = React.useSyncExternalStore(useLocalStorageSubscribe, getSnapshot) const data = React.useSyncExternalStore(useLocalStorageSubscribe, getSnapshot)
// Takes the value or a function that returns the value and updates the local storage
const setState: React.Dispatch<React.SetStateAction<T>> = React.useCallback( const setState: React.Dispatch<React.SetStateAction<T>> = React.useCallback(
(v: React.SetStateAction<T>) => { (v: React.SetStateAction<T>) => {
try { try {