summaryrefslogtreecommitdiffstats
path: root/src/utils/hooks/use-click-outside.tsx
diff options
context:
space:
mode:
authorArmand Philippot <git@armandphilippot.com>2022-05-24 19:35:12 +0200
committerGitHub <noreply@github.com>2022-05-24 19:35:12 +0200
commitc85ab5ad43ccf52881ee224672c41ec30021cf48 (patch)
tree8058808d9bfca19383f120c46b34d99ff2f89f63 /src/utils/hooks/use-click-outside.tsx
parent52404177c07a2aab7fc894362fb3060dff2431a0 (diff)
parent11b9de44a4b2f305a6a484187805e429b2767118 (diff)
refactor: use storybook and atomic design (#16)
BREAKING CHANGE: rewrite most of the Typescript types, so the content format (the meta in particular) needs to be updated.
Diffstat (limited to 'src/utils/hooks/use-click-outside.tsx')
-rw-r--r--src/utils/hooks/use-click-outside.tsx46
1 files changed, 46 insertions, 0 deletions
diff --git a/src/utils/hooks/use-click-outside.tsx b/src/utils/hooks/use-click-outside.tsx
new file mode 100644
index 0000000..cead98b
--- /dev/null
+++ b/src/utils/hooks/use-click-outside.tsx
@@ -0,0 +1,46 @@
+import { RefObject, useCallback, useEffect } from 'react';
+
+/**
+ * Listen for click/focus outside an element and execute the given callback.
+ *
+ * @param el - A React reference to an element.
+ * @param callback - A callback function to execute on click outside.
+ */
+const useClickOutside = (
+ el: RefObject<HTMLElement>,
+ callback: (target: EventTarget) => void
+) => {
+ /**
+ * Check if an event target is outside an element.
+ *
+ * @param {RefObject<HTMLElement>} ref - A React reference object.
+ * @param {EventTarget} target - An event target.
+ * @returns {boolean} True if the event target is outside the ref object.
+ */
+ const isTargetOutside = (
+ ref: RefObject<HTMLElement>,
+ target: EventTarget
+ ): boolean => {
+ if (!ref.current) return false;
+ return !ref.current.contains(target as Node);
+ };
+
+ const handleEvent = useCallback(
+ (e: MouseEvent | FocusEvent) => {
+ if (e.target && isTargetOutside(el, e.target)) callback(e.target);
+ },
+ [el, callback]
+ );
+
+ useEffect(() => {
+ document.addEventListener('mousedown', handleEvent);
+ document.addEventListener('focusin', handleEvent);
+
+ return () => {
+ document.removeEventListener('mousedown', handleEvent);
+ document.removeEventListener('focusin', handleEvent);
+ };
+ }, [handleEvent]);
+};
+
+export default useClickOutside;