-
-
Save crazy4groovy/28318a0cdb1bbeefb687e958bee66917 to your computer and use it in GitHub Desktop.
Make a component callback prop stable (i.e. cannot be used during render phase) (ReactJS)
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
type AnyFunction = (...args: any[]) => any | |
function useEvent<T extends AnyFunction>(callback?: T) { | |
const ref = useRef<AnyFunction | undefined>(() => { | |
throw new Error("Cannot call an event handler while rendering.") | |
}) | |
useLayoutEffect(() => { | |
ref.current = callback | |
}) | |
return useCallback<AnyFunction>( | |
(...args) => ref.current?.apply(null, args), | |
[] | |
) as T | |
} | |
// Usage | |
function Component(props) { | |
const [visible, setVisible] = useState(false) | |
// props.onToggle may not be stable | |
const onToggle = useEvent(props.onToggle) | |
// But our onToggle is stable | |
useEffect(() => onToggle(visible), [onToggle, visible]) | |
// ❌ Throws when used in the render phase | |
onToggle(visible) | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment