Function useOverlay

packages/react/src/hooks/useOverlay.tsx:21–41

({
  overlayRef: _overlayRef,
  returnFocusRef,
  initialFocusRef,
  onEscape,
  ignoreClickRefs,
  onClickOutside,
  preventFocusOnOpen,
}: UseOverlaySettings)

}

export const useOverlay = ({
  overlayRef: _overlayRef,
  returnFocusRef,
  initialFocusRef,
  onEscape,
  ignoreClickRefs,
  onClickOutside,
  preventFocusOnOpen,
}: UseOverlaySettings): OverlayReturnProps => {
  const overlayRef = useProvidedRefOrCreate<HTMLDivElement>(_overlayRef)
  useOpenAndCloseFocus({containerRef: overlayRef, returnFocusRef, initialFocusRef, preventFocusOnOpen})
  useOnOutsideClick({containerRef: overlayRef, ignoreClickRefs, onClickOutside})

  // We only want one overlay to close at a time
  const preventeddefaultCheckedEscape: UseOverlaySettings['onEscape'] = event => {
    onEscape(event)
    event.preventDefault()
  }
  useOnEscapePress(preventeddefaultCheckedEscape)
  return {ref: overlayRef}
}