diff --git a/packages/pixels/package.json b/packages/pixels/package.json index 6cdf7c54..0d6e2964 100644 --- a/packages/pixels/package.json +++ b/packages/pixels/package.json @@ -15,6 +15,9 @@ ] } }, + "files": [ + "./dist" + ], "homepage": "https://github.com/fuf-stack/uniforms#readme", "license": "MIT", "publishConfig": { diff --git a/packages/pixels/src/hooks/useDebounce.ts b/packages/pixels/src/hooks/useDebounce.ts new file mode 100644 index 00000000..4e6f9f2b --- /dev/null +++ b/packages/pixels/src/hooks/useDebounce.ts @@ -0,0 +1,22 @@ +import { useEffect, useState } from 'react'; + +export default (value: Value, delay: number) => { + // State and setters for debounced value + const [debouncedValue, setDebouncedValue] = useState(value); + useEffect( + () => { + // Update debounced value after delay + const handler = setTimeout(() => { + setDebouncedValue(value); + }, delay); + // Cancel the timeout if value changes (also on delay change or unmount) + // This is how we prevent debounced value from updating if value is changed ... + // .. within the delay period. Timeout gets cleared and restarted. + return () => { + clearTimeout(handler); + }; + }, + [value, delay], // Only re-call effect if value or delay changes + ); + return debouncedValue; +}; diff --git a/packages/pixels/src/hooks/useLocalStorage.ts b/packages/pixels/src/hooks/useLocalStorage.ts new file mode 100644 index 00000000..2ca9b9cb --- /dev/null +++ b/packages/pixels/src/hooks/useLocalStorage.ts @@ -0,0 +1,83 @@ +import type { Dispatch, SetStateAction } from 'react'; + +import { useEffect, useState } from 'react'; + +const useLocalStorage = ( + key: string, + initialValue: T | (() => T), +): [T, Dispatch>] => { + // 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(readValue); + + // Return a wrapped version of useState's setter function that ... + // ... persists the new value to localStorage. + const setValue: Dispatch> = (value) => { + // 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;