useOverlay
Provides the behavior for overlays such as dialogs, popovers, and menus. Handles hiding the overlay when the user interacts outside it (if `isDismissible`), when the Escape key is pressed, or optionally, on blur. Handles multiple overlays open at once as a stack: only the top-most overlay will close at once.
| install | yarn add @react-aria/overlays |
|---|---|
| version | 3.0.1 |
| usage | import {useOverlay} from '@react-aria/overlays' |
API#
useOverlay(
(props: OverlayProps,
, ref: RefObject<HTMLElement>
)): OverlayAriaExample#
See useDialog and useOverlayTrigger for examples of using
useOverlay to provide common overlay behavior to a component.