Class: DialogDriver<ContentT>

Defined in: packages/component-driver-angular-material-v21/src/components/DialogDriver.ts:54

Driver for a dialog opened through the MatDialog service.

The dialog container (<mat-dialog-container role="dialog">) is portaled into the CDK overlay container on document.body — outside the test engine's subtree — so this driver re-roots there (DialogDriver.overriddenParentLocator + 'Same'), the same portal technique as the mui-v7 DialogDriver. The scene locator refines the container element itself; MatDialog forwards no data-testid, so give the dialog a stable MatDialogConfig.id (it lands on the container) and locate it with byAttribute('id', …).

The driver assumes the default role: 'dialog'; a dialog opened with role: 'alertdialog' needs its own locator arrangement.

Dialog content is the consumer's own component — declare its parts through the ContainerDriver content option; they resolve relative to the container.

Extends

• ContainerDriver<ContentT, typeof dialogParts>

Type Parameters

ContentT

ContentT extends ScenePart

Constructors

Constructor

new DialogDriver<ContentT>(locator, interactor, option?): DialogDriver<ContentT>

Defined in: packages/component-driver-angular-material-v21/src/components/DialogDriver.ts:55

Parameters

locator

PartLocator

interactor

Interactor

option?

Partial<IContainerDriverOption<{ }, { }>>

Returns

DialogDriver<ContentT>

Overrides

ContainerDriver<ContentT, typeof dialogParts>.constructor

Accessors

driverName

Get Signature

get driverName(): string

Defined in: packages/component-driver-angular-material-v21/src/components/DialogDriver.ts:164

Returns

string

Overrides

ContainerDriver.driverName

Methods

closeByBackdropClick()

closeByBackdropClick(timeoutMs?): Promise<boolean>

Defined in: packages/component-driver-angular-material-v21/src/components/DialogDriver.ts:101

Dismiss the dialog by clicking its backdrop, then wait for it to close.

The CDK dispatches backdropClick from a click on the backdrop element; the click lands near the backdrop's top-left corner so real (hit-tested) clicks stay clear of the centered dialog pane. Whether it actually closes depends on the dialog's disableClose; the returned boolean reflects the observed close, not merely the click.

Parameters

timeoutMs?

number = defaultTransitionDurationMs

How long to wait for the close transition to finish

Returns

Promise<boolean>

true if the dialog closed

---

closeByEscape()

closeByEscape(timeoutMs?): Promise<boolean>

Defined in: packages/component-driver-angular-material-v21/src/components/DialogDriver.ts:119

Dismiss the dialog by pressing Escape, then wait for it to close.

The key is pressed on the dialog container and bubbles to the CDK's document-level keyboard dispatcher — a code path distinct from closeByBackdropClick. Whether it actually closes depends on the dialog's disableClose; the returned boolean reflects the observed close, not merely the key press.

Parameters

timeoutMs?

number = defaultTransitionDurationMs

How long to wait for the close transition to finish

Returns

Promise<boolean>

true if the dialog closed

---

getTitle()

getTitle(): Promise<string | null>

Defined in: packages/component-driver-angular-material-v21/src/components/DialogDriver.ts:77

The dialog's title text, or null when it has none. Resolved through the ARIA link Material maintains — the container's aria-labelledby names the mat-dialog-title element's id (or whatever ariaLabelledBy the dialog was configured with).

Returns

Promise<string | null>

---

isOpen()

isOpen(): Promise<boolean>

Defined in: packages/component-driver-angular-material-v21/src/components/DialogDriver.ts:160

Whether the dialog is open. Attachment is the open predicate: the CDK removes the dialog's overlay from the DOM when it closes (there is no hidden-but-attached state, unlike MUI's persistent modal root), and a style probe would race the exit-animation detach. Around an open/close action prefer waitForOpen/waitForClose, which absorb the enter/exit animation.

Returns

Promise<boolean>

---

waitForClose()

waitForClose(timeoutMs?): Promise<boolean>

Defined in: packages/component-driver-angular-material-v21/src/components/DialogDriver.ts:143

Wait for the dialog to close.

Parameters

timeoutMs?

number = defaultTransitionDurationMs

Returns

Promise<boolean>

true if the dialog is closed when the wait ends

---

waitForOpen()

waitForOpen(timeoutMs?): Promise<boolean>

Defined in: packages/component-driver-angular-material-v21/src/components/DialogDriver.ts:129

Wait for the dialog to open.

Parameters

timeoutMs?

number = defaultTransitionDurationMs

Returns

Promise<boolean>

true if the dialog is open when the wait ends

---

overriddenParentLocator()

static overriddenParentLocator(): Optional<PartLocator>

Defined in: packages/component-driver-angular-material-v21/src/components/DialogDriver.ts:63

Portal hook: where to re-root this driver's locator when its component renders outside the parent's DOM (a modal, popup, drawer). Return the PartLocator that locates the component from the document root, or undefined (the default) for normal in-tree components whose locator chains from the parent.

This is static because it is per-class metadata read off the constructor before any instance exists — which makes the "no instance state" constraint structural rather than a documented caution. Override with static override.

Returns

Optional<PartLocator>

Overrides

ContainerDriver.overriddenParentLocator

---

overrideLocatorRelativePosition()

static overrideLocatorRelativePosition(): Optional<LocatorRelativePosition>

Defined in: packages/component-driver-angular-material-v21/src/components/DialogDriver.ts:67

Portal hook: the locator relative position to apply when the component's real DOM is a sibling/elsewhere rather than a descendant (e.g. a MUI dialog rendered at the document root, located by a "Same"-level selector). Return undefined (the default) to keep the natural position declared by the ScenePart.

Static for the same reason as ComponentDriver.overriddenParentLocator: it is class-level metadata read before construction. Override with static override.

Returns

Optional<LocatorRelativePosition>

Overrides

ContainerDriver.overrideLocatorRelativePosition

Inherited members (19)

Properties

commutableOption

readonly commutableOption: CommutableComponentDriverOption

Defined in: packages/core/dist/index.d.mts:1182

The component-agnostic slice of the constructor option that is safe to share across the whole driver tree — everything the constructor received EXCEPT the component-specific parts, which each driver owns for itself. Parent drivers pass this straight to the constructors of children they create dynamically (see the list helpers). See CommutableComponentDriverOption.

Inherited from

ContainerDriver.commutableOption

---

interactor

readonly interactor: Interactor

Defined in: packages/core/dist/index.d.mts:1172

Inherited from

ContainerDriver.interactor

Accessors

content

Get Signature

get content(): ScenePartDriver<ContentT>

Defined in: packages/core/dist/index.d.mts:947

Returns

ScenePartDriver<ContentT>

Inherited from

ContainerDriver.content

---

locator

Get Signature

get locator(): PartLocator

Defined in: packages/core/dist/index.d.mts:1229

Return the locator of the component

Returns

PartLocator

Inherited from

ContainerDriver.locator

---

parts

Get Signature

get parts(): ScenePartDriver<T>

Defined in: packages/core/dist/index.d.mts:1225

Return driver instance of all the named parts

Returns

ScenePartDriver<T>

Inherited from

ContainerDriver.parts

Methods

click()

click(option?): Promise<void>

Defined in: packages/core/dist/index.d.mts:1253

Parameters

option?

Partial<ClickOption>

Returns

Promise<void>

Inherited from

ContainerDriver.click

---

exists()

exists(): Promise<boolean>

Defined in: packages/core/dist/index.d.mts:1252

Whether the component exists/attached to the DOM

Returns

Promise<boolean>

true if the component is attached to the DOM, false otherwise

Inherited from

ContainerDriver.exists

---

focus()

focus(option?): Promise<void>

Defined in: packages/core/dist/index.d.mts:1262

Parameters

option?

Partial<FocusOption>

Returns

Promise<void>

Inherited from

ContainerDriver.focus

---

getAttribute()

getAttribute(attributeName): Promise<Optional<string>>

Defined in: packages/core/dist/index.d.mts:1247

Parameters

attributeName

string

Returns

Promise<Optional<string>>

Inherited from

ContainerDriver.getAttribute

---

getText()

getText(): Promise<Optional<string>>

Defined in: packages/core/dist/index.d.mts:1246

Get the combined text content of the component

Returns

Promise<Optional<string>>

If the component exists and has content, it should return the text or otherwise undefined

Inherited from

ContainerDriver.getText

---

hover()

hover(option?): Promise<void>

Defined in: packages/core/dist/index.d.mts:1254

Parameters

option?

Partial<HoverOption>

Returns

Promise<void>

Inherited from

ContainerDriver.hover

---

isVisible()

isVisible(): Promise<boolean>

Defined in: packages/core/dist/index.d.mts:1336

Whether the component is visible. Visibility is defined that the component does not have the CSS property display: none, visibility: hidden, or opacity: 0. However this does not check whether the component is within the viewport.

Returns

Promise<boolean>

true if the component is visible, false otherwise

Inherited from

ContainerDriver.isVisible

---

pressKey()

pressKey(key, option?): Promise<void>

Defined in: packages/core/dist/index.d.mts:1268

Dispatch a keyboard key press on the component. See Interactor.pressKey.

Parameters

key

string

A KeyboardEvent.key value, e.g. 'Escape', 'Backspace', 'Enter'

option?

Partial<PressKeyOption>

Reserved for future modifier-key support

Returns

Promise<void>

Inherited from

ContainerDriver.pressKey

---

runtimeCssSelector()

runtimeCssSelector(): Promise<string>

Defined in: packages/core/dist/index.d.mts:1367

Get the runtime CSS selector of the component. This is useful for debugging and testing purposes.

Returns

Promise<string>

The runtime CSS selector of the component

Inherited from

ContainerDriver.runtimeCssSelector

---

scrollIntoView()

scrollIntoView(): Promise<void>

Defined in: packages/core/dist/index.d.mts:1289

Scroll the component into the viewport. See Interactor.scrollIntoView.

jsdom has no layout engine, so the scroll is a no-op there and behavioral assertions (visibility, offset) are E2E-only.

Returns

Promise<void>

Inherited from

ContainerDriver.scrollIntoView

---

typeText()

typeText(text): Promise<void>

Defined in: packages/core/dist/index.d.mts:1274

Type text into the component as real per-character keystrokes, inserting at the current caret without clearing. See Interactor.typeText.

Parameters

text

string

The literal text to type, one keystroke per character

Returns

Promise<void>

Inherited from

ContainerDriver.typeText

---

waitUntil()

waitUntil<T>(option): Promise<T>

Defined in: packages/core/dist/index.d.mts:1356

Type Parameters

T

T

Parameters

option

WaitUntilOption<T>

Returns

Promise<T>

Inherited from

ContainerDriver.waitUntil

---

waitUntilComponentState()

waitUntilComponentState(option?): Promise<void>

Defined in: packages/core/dist/index.d.mts:1355

Wait until the component is in the expected state such as the component's visibility or existence. If the component has not reached the expected state within the timeout, it will throw an error.

By default it waits until the component is attached to the DOM within 30 seconds.

Parameters

option?

Partial<Readonly<WaitForOption>>

The option to configure the wait behavior

Returns

Promise<void>

Inherited from

ContainerDriver.waitUntilComponentState

---

waitUntilVisible()

waitUntilVisible(timeoutMs?): Promise<void>

Defined in: packages/core/dist/index.d.mts:1343

Wait until the component is attached and becomes visible to the DOM.

Parameters

timeoutMs?

number

The number of milliseconds to wait before timing out. Defaults to defaultWaitForOption.timeoutMs so this wait shares a single flake-tolerance source with waitUntilComponentState (#1057).

Returns

Promise<void>

Inherited from

ContainerDriver.waitUntilVisible

Protected members (16)

Methods

activate()

protected activate(): Promise<void>

Defined in: packages/core/dist/index.d.mts:1282

Activate the component without relying on pointer geometry. See Interactor.activate.

Returns

Promise<void>

Inherited from

ContainerDriver.activate

---

contextMenu()

protected contextMenu(): Promise<void>

Defined in: packages/core/dist/index.d.mts:1278

Dispatch a right-click / contextmenu event on the component. See Interactor.contextMenu.

Returns

Promise<void>

Inherited from

ContainerDriver.contextMenu

---

drag()

protected drag(delta): Promise<void>

Defined in: packages/core/dist/index.d.mts:1320

Drag this component by the given pixel delta from its center. See Interactor.drag.

Prefer a keyboard-driven setValue over a true drag in real drivers — these drag primitives exist only for cases keyboard cannot express (e.g. panning a Lightbox, reordering a column). jsdom has no layout engine, so the positional outcome of the drag is E2E-only there.

Parameters

delta

Point

Pixel offset to drag by

Returns

Promise<void>

Inherited from

ContainerDriver.drag

---

dragTo()

protected dragTo(target): Promise<void>

Defined in: packages/core/dist/index.d.mts:1309

Drag this component and drop it onto another component. See Interactor.dragTo.

Prefer a keyboard-driven setValue over a true drag in real drivers — these drag primitives exist only for cases keyboard cannot express (e.g. panning a Lightbox, reordering a column). jsdom has no layout engine, so the positional outcome of the drag is E2E-only there.

Parameters

target

ComponentDriver<any>

Another driver whose root element is the drop target

Returns

Promise<void>

Inherited from

ContainerDriver.dragTo

---

enforcePartExistence()

protected enforcePartExistence(partName): Promise<void>

Defined in: packages/core/dist/index.d.mts:1235

Check the specified parts' existences, and throw MissingPartError if any of the part is found not existence. Existence is defined by the part's existence in the DOM regardless of its visibility on the screen

Parameters

partName

"backdrop" | readonly "backdrop"[]

Single or array of the names of the parts to be enforced

Returns

Promise<void>

Inherited from

ContainerDriver.enforcePartExistence

---

getBoundingRect()

protected getBoundingRect(): Promise<BoundingRect>

Defined in: packages/core/dist/index.d.mts:1327

Get this component's bounding rectangle. See Interactor.getBoundingRect.

jsdom has no layout engine, so every coordinate and dimension is 0 there; real geometry is E2E-only.

Returns

Promise<BoundingRect>

Inherited from

ContainerDriver.getBoundingRect

---

getMissingPartNames()

protected getMissingPartNames(partName): Promise<readonly "backdrop"[]>

Defined in: packages/core/dist/index.d.mts:1241

Get the names of parts not in the DOM

Parameters

partName

"backdrop" | readonly "backdrop"[]

Single or array of the names of the parts to be examined

Returns

Promise<readonly "backdrop"[]>

Inherited from

ContainerDriver.getMissingPartNames

---

innerHTML()

protected innerHTML(): Promise<string>

Defined in: packages/core/dist/index.d.mts:1361

Get the inner HTML of the component

Returns

Promise<string>

The inner HTML of the component

Inherited from

ContainerDriver.innerHTML

---

mouseDown()

protected mouseDown(option?): Promise<void>

Defined in: packages/core/dist/index.d.mts:1256

Parameters

option?

Partial<MouseDownOption>

Returns

Promise<void>

Inherited from

ContainerDriver.mouseDown

---

mouseEnter()

protected mouseEnter(option?): Promise<void>

Defined in: packages/core/dist/index.d.mts:1260

Parameters

option?

Partial<MouseEnterOption>

Returns

Promise<void>

Inherited from

ContainerDriver.mouseEnter

---

mouseLeave()

protected mouseLeave(option?): Promise<void>

Defined in: packages/core/dist/index.d.mts:1261

Parameters

option?

Partial<MouseLeaveOption>

Returns

Promise<void>

Inherited from

ContainerDriver.mouseLeave

---

mouseMove()

protected mouseMove(option?): Promise<void>

Defined in: packages/core/dist/index.d.mts:1255

Parameters

option?

Partial<MouseMoveOption>

Returns

Promise<void>

Inherited from

ContainerDriver.mouseMove

---

mouseOut()

protected mouseOut(option?): Promise<void>

Defined in: packages/core/dist/index.d.mts:1259

Parameters

option?

Partial<MouseOutOption>

Returns

Promise<void>

Inherited from

ContainerDriver.mouseOut

---

mouseOver()

protected mouseOver(option?): Promise<void>

Defined in: packages/core/dist/index.d.mts:1258

Parameters

option?

Partial<HoverOption>

Returns

Promise<void>

Inherited from

ContainerDriver.mouseOver

---

mouseUp()

protected mouseUp(option?): Promise<void>

Defined in: packages/core/dist/index.d.mts:1257

Parameters

option?

Partial<MouseUpOption>

Returns

Promise<void>

Inherited from

ContainerDriver.mouseUp

---

scrollBy()

protected scrollBy(delta): Promise<void>

Defined in: packages/core/dist/index.d.mts:1298

Scroll the component by the given pixel delta. See Interactor.scrollBy.

jsdom has no layout engine, so the scroll is a no-op there and behavioral assertions (resulting offset) are E2E-only.

Parameters

delta

Point

Pixel offset to scroll by

Returns

Promise<void>

Inherited from

ContainerDriver.scrollBy