|
| 1 | +import { useCallback, useEffect, useRef } from 'react'; |
| 2 | +import useEventCallback from '@restart/hooks/useEventCallback'; |
| 3 | + |
| 4 | +import { noop, warn } from '../../utils'; |
| 5 | + |
| 6 | +export type MouseEvents = { |
| 7 | + [K in keyof GlobalEventHandlersEventMap]: GlobalEventHandlersEventMap[K] extends MouseEvent |
| 8 | + ? K |
| 9 | + : never; |
| 10 | +}[keyof GlobalEventHandlersEventMap]; |
| 11 | + |
| 12 | +function isLeftClickEvent(event: MouseEvent) { |
| 13 | + return event.button === 0; |
| 14 | +} |
| 15 | + |
| 16 | +function isModifiedEvent(event: MouseEvent) { |
| 17 | + return !!(event.metaKey || event.altKey || event.ctrlKey || event.shiftKey); |
| 18 | +} |
| 19 | + |
| 20 | +export interface ClickOutsideOptions { |
| 21 | + disabled?: boolean; |
| 22 | + clickTrigger?: MouseEvents; |
| 23 | +} |
| 24 | + |
| 25 | +const InitialTriggerEvents: Partial<Record<MouseEvents, MouseEvents>> = { |
| 26 | + click: 'mousedown', |
| 27 | + mouseup: 'mousedown', |
| 28 | + pointerup: 'pointerdown', |
| 29 | +}; |
| 30 | + |
| 31 | +/** |
| 32 | + * The `useClickOutside` hook registers your callback on the document that fires |
| 33 | + * when a pointer event is registered outside of the provided ref or element. |
| 34 | + */ |
| 35 | +function useClickOutside( |
| 36 | + ref: React.RefObject<Element>, |
| 37 | + onClickOutside: (e: MouseEvent) => void = noop, |
| 38 | + { disabled, clickTrigger = 'click' }: ClickOutsideOptions = {} |
| 39 | +) { |
| 40 | + const preventMouseClickOutsideRef = useRef(false); |
| 41 | + const waitingForTrigger = useRef(false); |
| 42 | + |
| 43 | + const handleMouseCapture = useCallback( |
| 44 | + (e: MouseEvent) => { |
| 45 | + const currentTarget = ref.current; |
| 46 | + |
| 47 | + warn( |
| 48 | + !!currentTarget, |
| 49 | + 'ClickOutside captured a close event but does not have a ref to compare it to. ' + |
| 50 | + 'useClickOutside(), should be passed a ref that resolves to a DOM node' |
| 51 | + ); |
| 52 | + |
| 53 | + preventMouseClickOutsideRef.current = |
| 54 | + !currentTarget || |
| 55 | + isModifiedEvent(e) || |
| 56 | + !isLeftClickEvent(e) || |
| 57 | + !!currentTarget.contains(e.target as Node) || |
| 58 | + waitingForTrigger.current; |
| 59 | + |
| 60 | + waitingForTrigger.current = false; |
| 61 | + }, |
| 62 | + [ref] |
| 63 | + ); |
| 64 | + |
| 65 | + const handleInitialMouse = useEventCallback((e: MouseEvent) => { |
| 66 | + const currentTarget = ref.current; |
| 67 | + |
| 68 | + if (currentTarget?.contains(e.target as Node)) { |
| 69 | + waitingForTrigger.current = true; |
| 70 | + } else { |
| 71 | + // When clicking on scrollbars within current target, click events are not |
| 72 | + // triggered, so this ref is never reset inside `handleMouseCapture`. This |
| 73 | + // would cause a bug where it requires 2 clicks to close the overlay. |
| 74 | + waitingForTrigger.current = false; |
| 75 | + } |
| 76 | + }); |
| 77 | + |
| 78 | + const handleMouse = useEventCallback((e: MouseEvent) => { |
| 79 | + if (!preventMouseClickOutsideRef.current) { |
| 80 | + onClickOutside(e); |
| 81 | + } |
| 82 | + }); |
| 83 | + |
| 84 | + useEffect(() => { |
| 85 | + if (disabled || ref == null) return undefined; |
| 86 | + |
| 87 | + const doc = ref.current?.ownerDocument || document; |
| 88 | + const ownerWindow = doc.defaultView || window; |
| 89 | + |
| 90 | + // Store the current event to avoid triggering handlers immediately |
| 91 | + // For things rendered in an iframe, the event might originate on the parent window |
| 92 | + // so we should fall back to that global event if the local one doesn't exist |
| 93 | + // https://github.com/facebook/react/issues/20074 |
| 94 | + let currentEvent = ownerWindow.event ?? ownerWindow.parent?.event; |
| 95 | + |
| 96 | + let removeInitialTriggerListener: (() => void) | null = null; |
| 97 | + if (InitialTriggerEvents[clickTrigger]) { |
| 98 | + doc.addEventListener( |
| 99 | + InitialTriggerEvents[clickTrigger]!, |
| 100 | + handleInitialMouse, |
| 101 | + true |
| 102 | + ); |
| 103 | + |
| 104 | + removeInitialTriggerListener = () => { |
| 105 | + doc.removeEventListener( |
| 106 | + InitialTriggerEvents[clickTrigger]!, |
| 107 | + handleInitialMouse |
| 108 | + ); |
| 109 | + }; |
| 110 | + } |
| 111 | + |
| 112 | + const handleMouseTrigger = (e: MouseEvent) => { |
| 113 | + // skip if this event is the same as the one running when we added the handlers |
| 114 | + if (e === currentEvent) { |
| 115 | + currentEvent = undefined; |
| 116 | + return; |
| 117 | + } |
| 118 | + handleMouse(e); |
| 119 | + }; |
| 120 | + |
| 121 | + // Use capture for this listener so it fires before React's listener, to |
| 122 | + // avoid false positives in the contains() check below if the target DOM |
| 123 | + // element is removed in the React mouse callback. |
| 124 | + doc.addEventListener(clickTrigger, handleMouseCapture, true); |
| 125 | + doc.addEventListener(clickTrigger, handleMouseTrigger, true); |
| 126 | + |
| 127 | + return () => { |
| 128 | + removeInitialTriggerListener?.(); |
| 129 | + doc.removeEventListener(clickTrigger, handleMouseCapture); |
| 130 | + doc.removeEventListener(clickTrigger, handleMouseTrigger); |
| 131 | + }; |
| 132 | + }, [ |
| 133 | + ref, |
| 134 | + disabled, |
| 135 | + clickTrigger, |
| 136 | + handleMouseCapture, |
| 137 | + handleInitialMouse, |
| 138 | + handleMouse, |
| 139 | + ]); |
| 140 | +} |
| 141 | + |
| 142 | +export default useClickOutside; |
0 commit comments