:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
import { ReferenceType } from '@floating-ui/react'
import { useEffect, useRef } from 'react'
export const CLICK_OUTSIDE_BLOCK_CLASS = 'click-outside-block'
const exceptions = [`.${CLICK_OUTSIDE_BLOCK_CLASS}`, `.${CLICK_OUTSIDE_BLOCK_CLASS} *`]
export function useOutsideClickHandler(
refs: React.MutableRefObject<HTMLElement | ReferenceType | null>[],
handleClickOutside: (event: Event) => void,
extraDeps: any[] = [],
exceptTagNames?: string[] // list of tag names that don't trigger the callback even if outside
): void {
// Store refs and callback in mutable refs so the effect closure always
// sees the latest values without needing them in the dependency array.
// This avoids spreading `refs` into useEffect deps (which would change
// the array length when refs go from [] to [ref1, ref2, ...]).
const refsRef = useRef(refs)
refsRef.current = refs
const handleClickOutsideRef = useRef(handleClickOutside)
handleClickOutsideRef.current = handleClickOutside
const exceptTagNamesRef = useRef(exceptTagNames)
exceptTagNamesRef.current = exceptTagNames
useEffect(() => {
function handleClick(event: Event): void {
// Ignore non-primary clicks (right-click, middle-click).
// Radix context menus (BrowserLikeMenuItems) fire `contextmenu` before `mouseup`,
// causing the browser to retarget `mouseup` to <html> which falsely triggers outside-click dismissal.
if (event instanceof MouseEvent && event.button !== 0) {
return
}
if (exceptions.some((exception) => (event.target as Element)?.matches?.(exception))) {
return
}
if (
refsRef.current.some((maybeRef) => {
if (typeof maybeRef === 'string') {
return event.composedPath?.()?.find((e) => (e as HTMLElement)?.matches?.(maybeRef))
}
const ref = maybeRef.current
if (!event.target || !ref) {
return false
}
const hasShadowRoot = !!(event.target as HTMLElement).shadowRoot
return hasShadowRoot
? event.composedPath?.()?.find((el) => el === ref)
: `contains` in ref && ref.contains(event.target as Element)
})
) {
return
}
const target = (event.composedPath?.()?.[0] || event.target) as HTMLElement
if (exceptTagNamesRef.current && exceptTagNamesRef.current.includes(target.tagName)) {
return
}
handleClickOutsideRef.current?.(event)
}
// Only attach event listeners if there's something to track
if (refsRef.current.length > 0) {
document.addEventListener('mouseup', handleClick)
document.addEventListener('touchend', handleClick)
return () => {
document.removeEventListener('mouseup', handleClick)
document.removeEventListener('touchend', handleClick)
}
}
}, extraDeps) // eslint-disable-line react-hooks/exhaustive-deps
}