| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| aria-describedby | string | false | ||
| aria-details | string | false | ||
| aria-label | string | false | ||
| aria-labelledby | string | false | ||
| arrow | boolean | false | ||
| autoFocus | boolean | false | ||
| beforeHide | BeforeCallback | false | The callback to run before the overlay is hidden. Returning
| |
| beforeShow | BeforeCallback | false | The callback to run before the overlay is shown. Returning
| |
| canFlip | boolean | false | ||
| children | ReactNode | ((props: TriggerApi) => ReactNode) | true | ||
| clickOutsideIgnoreRefs | RefObject<HTMLElement>[] | false | Additional refs to check for clickOutside behavior | |
| containFocus | boolean | false | Whether to contain focus inside the overlay, so users cannot move focus outside, for example in a modal dialog. True by default for role "dialog" | |
| container | HTMLElement | false | ||
| hideDelay | number | false | The delay when hiding the overlay | |
| hideKeys | { overlay: string[]; target: string[] } | false | Keys to hide the overlay when the overlay is focused Accessibility notes: OverlayTrigger by default closes on tab. To remove tab from closing
and have only Esc keys, set "containFocus" to true, or opt-in to a full dialog role. | |
| initialIsVisible | boolean | false | ||
| overlay | ReactNode | true | ||
| overlayRef | false | Toggles overlay visibility | ||
| padding | number | false | ||
| passA11yPropsToOverlay | boolean | false | By default, role and id are applied to wrapper. But has knowledge of Set to true, if you want OverlayTrigger to place them on your overlay component. | |
| placement | Placement | false | ||
| restoreFocusOnHide | boolean | false | Restore focus to the target after the overlay is hidden | |
| role | false | Accessibility props. Accessibility notes: May opionate "autoFocus" and "containFocus" | ||
| showDelay | number | false | The delay when showing the overlay | |
| showKeys | string[] | false | Keys to show the overlay when the target is focused | |
| shrinkOverlay | boolean | false | ||
| trigger | TriggerVariant | TriggerVariant[] | false | ||
| afterHide | Function | false | ||
| afterShow | Function | false |
Whether to auto focus the first focusable element in the overlay on mount. True by default for role "dialog"
11.5.0