This site uses cookies from Google to deliver its services and to analyze traffic.
More details

Dialog

Autocomplete
Badge
Bottom Sheet
Button
Button toggle
Card
Checkbox
Chips
Core
Datepicker
Dialog
Divider
Expansion Panel
Form field
Grid list
Icon
Input
List
Menu
Paginator
Progress bar
Progress spinner
Radio button
Ripples
Select
Sidenav
Slide toggle
Slider
Snackbar
Sort header
Stepper
Table
Tabs
Toolbar
Tooltip
Tree
API for dialog

API reference for Angular Material dialog

import {MatDialogModule} from '@angular/material/dialog';

Service to open Material Design modal dialogs.

Properties
Name Description

afterAllClosed: Observable<void>

Stream that emits when all open dialog have finished closing. Will emit on subscribe if there are no open dialogs to begin with.

afterOpened: Subject<MatDialogRef<any>>

Stream that emits when a dialog has been opened.

openDialogs: MatDialogRef<any>[]

Keeps track of the currently-open dialogs.
Methods
closeAll

Closes all of the currently-open dialogs.
getDialogById

Finds an open dialog by its id.
Parameters

id

string

Returns
MatDialogRef<any> | undefined

open

Opens a modal dialog containing the given component.
Parameters

component

ComponentType<T>

config?

MatDialogConfig<D>

Returns
MatDialogRef<T, R>

Reference to the newly-opened dialog.
open

Opens a modal dialog containing the given template.
Parameters

template

TemplateRef<T>

config?

MatDialogConfig<D>

Returns
MatDialogRef<T, R>

Reference to the newly-opened dialog.
open
Parameters

template

ComponentType<T> | TemplateRef<T>

config?

MatDialogConfig<D>

Returns
MatDialogRef<T, R>

Button that will close the current dialog.

Selector: [mat-dialog-close] [matDialogClose]

Exported as: matDialogClose
Properties
Name Description
@Input('aria-label')

ariaLabel: string

Screenreader label for the button.
@Input('mat-dialog-close')

dialogResult: any

Dialog close input.
@Input()

type: 'submit' | 'button' | 'reset'

Default to "button" to prevents accidental form submits.
Deprecated

dialogRef: MatDialogRef<any>

Reference to the containing dialog.

Title of a dialog element. Stays fixed to the top of the dialog when scrolling.

Selector: [mat-dialog-title] [matDialogTitle]

Exported as: matDialogTitle
Properties
Name Description
@Input()

id: string

Unique id for the dialog title. If none is supplied, it will be auto-generated.

Scrollable content container of a dialog.

Selector: [mat-dialog-content] mat-dialog-content [matDialogContent]

Container for the bottom action buttons in a dialog. Stays fixed to the bottom when scrolling.

Selector: [mat-dialog-actions] mat-dialog-actions [matDialogActions]

Configuration for opening a modal dialog with the MatDialog service.

Properties
Name Description

ariaDescribedBy: string | null

ID of the element that describes the dialog.

ariaLabel: string | null

Aria label to assign to the dialog element.

ariaLabelledBy: string | null

ID of the element that labels the dialog.

autoFocus: boolean

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

backdropClass: string | string[]

Custom class for the backdrop.

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).

componentFactoryResolver: ComponentFactoryResolver

Alternate ComponentFactoryResolver to use when resolving the associated component.

data: D | null

Data being injected into the child component.

direction: Direction

Layout direction for the dialog's content.

disableClose: boolean

Whether the user can use escape or clicking on the backdrop to close the modal.

hasBackdrop: boolean

Whether the dialog has a backdrop.

height: string

Height of the dialog.

id: string

ID for the dialog. If omitted, a unique one will be generated.

maxHeight: number | string

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

maxWidth: number | string

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

minHeight: number | string

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

minWidth: number | string

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

panelClass: string | string[]

Custom class for the overlay pane.

position: DialogPosition

Position overrides.

restoreFocus: boolean

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

role: DialogRole

The ARIA role of the dialog element.

scrollStrategy: ScrollStrategy

Scroll strategy to be used for the dialog.

viewContainerRef: ViewContainerRef

Where the attached component should live in Angular's logical component tree. This affects what is available for injection and the change detection order for the component instantiated inside of the dialog. This does not affect where the dialog content will be rendered.

width: string

Width of the dialog.

Reference to a dialog opened via the MatDialog service.

Properties
Name Description

componentInstance: T

The instance of component opened into the dialog.

disableClose: boolean | undefined

Whether the user is allowed to close the dialog.

id: string

Id of the dialog.
Methods
addPanelClass

Add a CSS class or an array of classes to the overlay pane.
Parameters

classes

string | string[]

Returns
this

afterClosed

Gets an observable that is notified when the dialog is finished closing.
Returns
Observable<R | undefined>

afterOpened

Gets an observable that is notified when the dialog is finished opening.
Returns
Observable<void>

backdropClick

Gets an observable that emits when the overlay's backdrop has been clicked.
Returns
Observable<MouseEvent>

beforeClosed

Gets an observable that is notified when the dialog has started closing.
Returns
Observable<R | undefined>

close

Close the dialog.
Parameters

dialogResult?

R

getState

Gets the current state of the dialog's lifecycle.
Returns
MatDialogState

keydownEvents

Gets an observable that emits when keydown events are targeted on the overlay.
Returns
Observable<KeyboardEvent>

removePanelClass

Remove a CSS class or an array of classes from the overlay pane.
Parameters

classes

string | string[]

Returns
this

updatePosition

Updates the dialog's position.
Parameters

position?

DialogPosition

Returns
this

updateSize

Updates the dialog's width and height.
Parameters

width

string = ''

height

string = ''

Returns
this

Possible overrides for a dialog's position.

Properties
Name Description

bottom: string

Override for the dialog's bottom position.

left: string

Override for the dialog's left position.

right: string

Override for the dialog's right position.

top: string

Override for the dialog's top position.

Valid ARIA roles for a dialog element.

type DialogRole = 'dialog' | 'alertdialog';

Injection token that can be used to access the data that was passed in to a dialog.

const MAT_DIALOG_DATA: InjectionToken<any>;

Injection token that can be used to specify default dialog options.

const MAT_DIALOG_DEFAULT_OPTIONS: InjectionToken<MatDialogConfig<any>>;

Injection token that determines the scroll handling while the dialog is open.

const MAT_DIALOG_SCROLL_STRATEGY: InjectionToken<() => ScrollStrategy>;

API reference for Angular Material dialog-testing

import {MatDialogHarness} from '@angular/material/dialog/testing';

Harness for interacting with a standard MatDialog in tests.

Properties
Name Description

static hostSelector: '.mat-dialog-container'

The selector for the host element of a MatDialog instance.
Methods
async
close

Closes the dialog by pressing escape.

Note: this method does nothing if disableClose has been set to true for the dialog.
Returns
Promise<void>

Promise that resolves when the action completes.
async
getAllChildLoaders
Parameters

selector

S

Returns
Promise<HarnessLoader[]>

async
getAllHarnesses
Parameters

query

HarnessQuery<T>

Returns
Promise<T[]>

async
getAriaDescribedby

Gets the value of the dialog's "aria-describedby" attribute.
Returns
Promise<string | null>

async
getAriaLabel

Gets the value of the dialog's "aria-label" attribute.
Returns
Promise<string | null>

async
getAriaLabelledby

Gets the value of the dialog's "aria-labelledby" attribute.
Returns
Promise<string | null>

async
getChildLoader
Parameters

selector

S

Returns
Promise<HarnessLoader>

async
getHarness
Parameters

query

HarnessQuery<T>

Returns
Promise<T>

async
getId

Gets the id of the dialog.
Returns
Promise<string | null>

async
getRole

Gets the role of the dialog.
Returns
Promise<DialogRole | null>

async
host

Gets a Promise for the TestElement representing the host element of the component.
Returns
Promise<TestElement>

static
with

Gets a HarnessPredicate that can be used to search for a MatDialogHarness that meets certain criteria.
Parameters

options

DialogHarnessFilters = {}

Returns
HarnessPredicate<MatDialogHarness>

a HarnessPredicate configured with the given options.

A set of criteria that can be used to filter a list of MatDialogHarness instances.

Dialog
Testing
Indigo & Pink theme selected.