Skip to main content

Interface: IComponentDriver<T>

Defined in: packages/core/src/partTypes.ts:139

Extended by​

Type Parameters​

T​

T extends ScenePart = { }

Properties​

locator​

readonly locator: PartLocator

Defined in: packages/core/src/partTypes.ts:148

The locator which helps locate the root of the component

parts​

readonly parts: ScenePartDriver<T>

Defined in: packages/core/src/partTypes.ts:143

Return driver instance of all the named parts

Methods​

exists()​

exists(): Promise<boolean>

Defined in: packages/core/src/partTypes.ts:160

Whether the component exists/attached to the DOM

Returns​

Promise<boolean>

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

getText()​

getText(): Promise<Optional<string>>

Defined in: packages/core/src/partTypes.ts:154

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

isVisible()​

isVisible(): Promise<boolean>

Defined in: packages/core/src/partTypes.ts:170

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

waitUntilComponentState()​

waitUntilComponentState(option?): Promise<void>

Defined in: packages/core/src/partTypes.ts:183

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>