Interface MessageDialogConfig

interface MessageDialogConfig {
    ariaDescribedBy?: null | string;
    ariaLabel?: null | string;
    ariaLabelledBy?: null | string;
    autoFocus?: boolean;
    backdropClass?: string;
    closeOnNavigation?: boolean;
    direction?: Direction;
    hasBackdrop?: boolean;
    height?: string;
    maxHeight?: string | number;
    maxWidth?: string | number;
    minHeight?: string | number;
    minWidth?: string | number;
    panelClass?: string | string[];
    position?: DialogPosition;
    restoreFocus?: boolean;
    scrollStrategy?: ScrollStrategy;
    width?: string;
}

Properties

ariaDescribedBy? ariaLabel? ariaLabelledBy? autoFocus? backdropClass? closeOnNavigation? direction? hasBackdrop? height? maxHeight? maxWidth? minHeight? minWidth? panelClass? position? restoreFocus? scrollStrategy? width?

Properties

OptionalariaDescribedBy

ariaDescribedBy?: null | string

ID of the element that describes the dialog.

OptionalariaLabel

ariaLabel?: null | string

Aria label to assign to the dialog element.

OptionalariaLabelledBy

ariaLabelledBy?: null | string

ID of the element that labels the dialog.

OptionalautoFocus

autoFocus?: boolean

Whether the dialog should focus the first focusable element on open.

OptionalbackdropClass

backdropClass?: string

Custom class for the backdrop.

OptionalcloseOnNavigation

closeOnNavigation?: boolean

Whether the dialog should close when the user goes backwards/forwards in history. Note that this usually doesn't include clicking on links (unless the user is using the HashLocationStrategy).

Optionaldirection

direction?: Direction

Layout direction for the dialog's content.

OptionalhasBackdrop

hasBackdrop?: boolean

Whether the dialog has a backdrop.

Optionalheight

height?: string

Height of the dialog.

OptionalmaxHeight

maxHeight?: string | number

Max-height of the dialog. If a number is provided, assumes pixel units.

OptionalmaxWidth

maxWidth?: string | number

Max-width of the dialog. If a number is provided, assumes pixel units. Defaults to 80vw.

OptionalminHeight

minHeight?: string | number

Min-height of the dialog. If a number is provided, assumes pixel units.

OptionalminWidth

minWidth?: string | number

Min-width of the dialog. If a number is provided, assumes pixel units.

OptionalpanelClass

panelClass?: string | string[]

Custom class for the overlay pane.

Optionalposition

position?: DialogPosition

Position overrides.

OptionalrestoreFocus

restoreFocus?: boolean

Whether the dialog should restore focus to the previously-focused element, after it's closed.

OptionalscrollStrategy

scrollStrategy?: ScrollStrategy

Scroll strategy to be used for the dialog.

Optionalwidth

width?: string

Width of the dialog.

Settings

Member Visibility

On This Page

Properties