Interface OverlayOptions

interface OverlayOptions {
    anchor?: HTMLElement;
    dismissOnEscape?: boolean;
    dismissOnOutside?: boolean;
    edge?: HTMLElement;
    initialFocus?: null | HTMLElement;
    modal?: boolean;
    onClose?: () => void;
    placement?: "center" | "below" | "beside";
    restoreFocus?: boolean;
}

Properties

anchor? dismissOnEscape? dismissOnOutside? edge? initialFocus? modal? onClose? placement? restoreFocus?

Properties

Optionalanchor

anchor?: HTMLElement

The control the panel opens from; positions the panel and keeps a click on it from counting as outside.

OptionaldismissOnEscape

dismissOnEscape?: boolean

Close on Escape. Default true.

OptionaldismissOnOutside

dismissOnOutside?: boolean

Close on a press outside the panel and its anchor. Default: not modal.

Optionaledge

edge?: HTMLElement

A second element the panel should clear when placed beside (the rail, not just the button in it).

OptionalinitialFocus

initialFocus?: null | HTMLElement

Where focus lands: an element, null to leave focus where it is, or the first control (default).

Optionalmodal

modal?: boolean

Draw a scrim and refuse outside dismissal. Default false; center placement implies it.

OptionalonClose

onClose?: () => void

Optionalplacement

placement?: "center" | "below" | "beside"

Where the panel goes relative to the anchor. Default below; center ignores the anchor.

OptionalrestoreFocus

restoreFocus?: boolean

Give focus back to the opener on close. Default true.

Settings

Member Visibility

On This Page

Properties