Class: DialogDriver<ContentT>

@atomic-testing/component-driver-mui-v5.DialogDriver

Type parameters

Name	Type
ContentT	extends ScenePart

Hierarchy

• ContainerDriver<ContentT, typeof parts>

  ↳ DialogDriver

Constructors

constructor

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

Type parameters

Name	Type
ContentT	extends ScenePart

Parameters

Name	Type
locator	PartLocator
interactor	Interactor
option?	Partial<IContainerDriverOption<, >>

Returns

DialogDriver<ContentT>

Overrides

ContainerDriver&lt;ContentT, typeof parts&gt;.constructor

Defined in

packages/component-driver-mui-v5/src/components/DialogDriver.ts:31

Properties

commutableOption

• Readonly commutableOption: IComponentDriverOption<{ dialogContainer: { driver: typeof HTMLElementDriver = HTMLElementDriver; locator: CssLocator } ; title: { driver: typeof HTMLElementDriver = HTMLElementDriver; locator: CssLocator } }>

Option passed to the constructor includes both universal options which can be shared across all component driver tree, and component specific options which are only applicable to the component.

Commutable option is the option that can be shared across all component driver tree.

Inherited from

ContainerDriver.commutableOption

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:19

---

interactor

• Readonly interactor: Interactor

Inherited from

ContainerDriver.interactor

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:10

Accessors

content

• get content(): ScenePartDriver<ContentT>

Returns

ScenePartDriver<ContentT>

Inherited from

ContainerDriver.content

Defined in

packages/core/build/src/drivers/ContainerDriver.d.ts:8

---

driverName

• get driverName(): string

Returns

string

Overrides

ContainerDriver.driverName

Defined in

packages/component-driver-mui-v5/src/components/DialogDriver.ts:87

---

locator

• get locator(): PartLocator

Return the locator of the component

Returns

PartLocator

Inherited from

ContainerDriver.locator

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:50

---

parts

• get parts(): ScenePartDriver<T>

Return driver instance of all the named parts

Returns

ScenePartDriver<T>

Inherited from

ContainerDriver.parts

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:46

Methods

click

▸ click(option?): Promise<void>

Parameters

Name	Type
option?	Partial<ClickOption>

Returns

Promise<void>

Inherited from

ContainerDriver.click

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:74

---

enforcePartExistence

▸ enforcePartExistence(partName): Promise<void>

Check the specified parts' existences, and throw MissPartError 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

Name	Type	Description
partName	"title" | "dialogContainer" | readonly ("title" | "dialogContainer")[]	Single or array of the names of the parts to be enforced

Returns

Promise<void>

Inherited from

ContainerDriver.enforcePartExistence

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:56

---

exists

▸ exists(): Promise<boolean>

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

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:73

---

focus

▸ focus(option?): Promise<void>

Parameters

Name	Type
option?	Partial<FocusOption>

Returns

Promise<void>

Inherited from

ContainerDriver.focus

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:83

---

getAttribute

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

Parameters

Name	Type
attributeName	string

Returns

Promise<Optional<string>>

Inherited from

ContainerDriver.getAttribute

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:68

---

getMissingPartNames

▸ getMissingPartNames(partName): Promise<readonly ("title" | "dialogContainer")[]>

Get the names of parts not in the DOM

Parameters

Name	Type	Description
partName	"title" | "dialogContainer" | readonly ("title" | "dialogContainer")[]	Single or array of the names of the parts to be examined

Returns

Promise<readonly ("title" | "dialogContainer")[]>

Inherited from

ContainerDriver.getMissingPartNames

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:62

---

getText

▸ getText(): Promise<Optional<string>>

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

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:67

---

getTitle

▸ getTitle(): Promise<null | string>

Returns

Promise<null | string>

Defined in

packages/component-driver-mui-v5/src/components/DialogDriver.ts:47

---

hover

▸ hover(option?): Promise<void>

Parameters

Name	Type
option?	Partial<HoverOption>

Returns

Promise<void>

Inherited from

ContainerDriver.hover

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:75

---

isOpen

▸ isOpen(): Promise<boolean>

Check if the dialog box is open. Caution, because of animation, upon an open/close action is performed use waitForOpen() or waitForClose() before using isOpen() would result a more accurate open state of the dialog

Returns

Promise<boolean>

true if dialog box is open

Defined in

packages/component-driver-mui-v5/src/components/DialogDriver.ts:78

---

isVisible

▸ isVisible(): Promise<boolean>

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 wether the component is within the viewport.

Returns

Promise<boolean>

true if the component is visible, false otherwise

Inherited from

ContainerDriver.isVisible

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:92

---

mouseDown

▸ mouseDown(option?): Promise<void>

Parameters

Name	Type
option?	Partial<MouseDownOption>

Returns

Promise<void>

Inherited from

ContainerDriver.mouseDown

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:77

---

mouseEnter

▸ mouseEnter(option?): Promise<void>

Parameters

Name	Type
option?	Partial<MouseEnterOption>

Returns

Promise<void>

Inherited from

ContainerDriver.mouseEnter

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:81

---

mouseLeave

▸ mouseLeave(option?): Promise<void>

Parameters

Name	Type
option?	Partial<MouseLeaveOption>

Returns

Promise<void>

Inherited from

ContainerDriver.mouseLeave

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:82

---

mouseMove

▸ mouseMove(option?): Promise<void>

Parameters

Name	Type
option?	Partial<MouseMoveOption>

Returns

Promise<void>

Inherited from

ContainerDriver.mouseMove

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:76

---

mouseOut

▸ mouseOut(option?): Promise<void>

Parameters

Name	Type
option?	Partial<MouseOutOption>

Returns

Promise<void>

Inherited from

ContainerDriver.mouseOut

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:80

---

mouseOver

▸ mouseOver(option?): Promise<void>

Parameters

Name	Type
option?	Partial<HoverOption>

Returns

Promise<void>

Inherited from

ContainerDriver.mouseOver

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:79

---

mouseUp

▸ mouseUp(option?): Promise<void>

Parameters

Name	Type
option?	Partial<MouseUpOption>

Returns

Promise<void>

Inherited from

ContainerDriver.mouseUp

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:78

---

overriddenParentLocator

▸ overriddenParentLocator(): Optional<PartLocator>

Returns

Optional<PartLocator>

Overrides

ContainerDriver.overriddenParentLocator

Defined in

packages/component-driver-mui-v5/src/components/DialogDriver.ts:39

---

overrideLocatorRelativePosition

▸ overrideLocatorRelativePosition(): Optional<LocatorRelativePosition>

Returns

Optional<LocatorRelativePosition>

Overrides

ContainerDriver.overrideLocatorRelativePosition

Defined in

packages/component-driver-mui-v5/src/components/DialogDriver.ts:43

---

waitForClose

▸ waitForClose(timeoutMs?): Promise<boolean>

Wait for dialog to close

Parameters

Name	Type	Default value
timeoutMs	number	defaultTransitionDuration

Returns

Promise<boolean>

true open has performed successfully

Defined in

packages/component-driver-mui-v5/src/components/DialogDriver.ts:68

---

waitForOpen

▸ waitForOpen(timeoutMs?): Promise<boolean>

Wait for dialog to open

Parameters

Name	Type	Default value
timeoutMs	number	defaultTransitionDuration

Returns

Promise<boolean>

true open has performed successfully

Defined in

packages/component-driver-mui-v5/src/components/DialogDriver.ts:58

---

waitUntil

▸ waitUntil(option?): Promise<void>

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

Name	Type	Description
option?	Partial<Readonly<WaitForOption>>	The option to configure the wait behavior

Returns

Promise<void>

Inherited from

ContainerDriver.waitUntil

Defined in

packages/core/build/src/drivers/ComponentDriver.d.ts:104