Abstract Class: ContainerDriver<ContentT, T>
Defined in: packages/core/src/drivers/ContainerDriver.ts:13
Base class for all component drivers. It provides the basic functionality to interact with the component
Extends​
Type Parameters​
ContentT​
ContentT extends ScenePart
T​
T extends ScenePart = { }
Implements​
Constructors​
Constructor​
new ContainerDriver<
ContentT,T>(locator,interactor,option?):ContainerDriver<ContentT,T>
Defined in: packages/core/src/drivers/ContainerDriver.ts:19
Parameters​
locator​
interactor​
option?​
Partial<IContainerDriverOption<ContentT, T>>
Returns​
ContainerDriver<ContentT, T>
Overrides​
Properties​
commutableOption​
readonlycommutableOption:IComponentDriverOption<T>
Defined in: packages/core/src/drivers/ComponentDriver.ts:37
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​
ComponentDriver.commutableOption
interactor​
readonlyinteractor:Interactor
Defined in: packages/core/src/drivers/ComponentDriver.ts:56
Environment adapter used for all interactions.
Inherited from​
Accessors​
content​
Get Signature​
get content():
ScenePartDriver<ContentT>
Defined in: packages/core/src/drivers/ContainerDriver.ts:25
Returns​
ScenePartDriver<ContentT>
driverName​
Get Signature​
get
abstractdriverName():string
Defined in: packages/core/src/drivers/ComponentDriver.ts:352
Returns​
string
Inherited from​
locator​
Get Signature​
get locator():
PartLocator
Defined in: packages/core/src/drivers/ComponentDriver.ts:104
Return the locator of the component
Returns​
The locator which helps locate the root of the component
Implementation of​
Inherited from​
parts​
Get Signature​
get parts():
ScenePartDriver<T>
Defined in: packages/core/src/drivers/ComponentDriver.ts:97
Return driver instance of all the named parts
Returns​
Return driver instance of all the named parts
Implementation of​
Inherited from​
Methods​
activate()​
activate():
Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:229
Activate the component without relying on pointer geometry. See Interactor.activate.
Returns​
Promise<void>
Inherited from​
click()​
click(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:170
Parameters​
option?​
Partial<ClickOption>
Returns​
Promise<void>
Inherited from​
contextMenu()​
contextMenu():
Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:222
Dispatch a right-click / contextmenu event on the component. See Interactor.contextMenu.
Returns​
Promise<void>
Inherited from​
drag()​
drag(
delta):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:279
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​
Pixel offset to drag by
Returns​
Promise<void>
Inherited from​
dragTo()​
dragTo(
target):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:265
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​
enforcePartExistence()​
protectedenforcePartExistence(partName):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:113
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​
keyof T | readonly keyof T[]
Single or array of the names of the parts to be enforced
Returns​
Promise<void>
Inherited from​
ComponentDriver.enforcePartExistence
exists()​
exists():
Promise<boolean>
Defined in: packages/core/src/drivers/ComponentDriver.ts:166
Whether the component exists/attached to the DOM
Returns​
Promise<boolean>
true if the component is attached to the DOM, false otherwise
Implementation of​
Inherited from​
focus()​
focus(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:206
Parameters​
option?​
Partial<FocusOption>
Returns​
Promise<void>
Inherited from​
getAttribute()​
getAttribute(
attributeName):Promise<Optional<string>>
Defined in: packages/core/src/drivers/ComponentDriver.ts:158
Parameters​
attributeName​
string
Returns​
Promise<Optional<string>>
Inherited from​
getBoundingRect()​
getBoundingRect():
Promise<BoundingRect>
Defined in: packages/core/src/drivers/ComponentDriver.ts:289
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​
ComponentDriver.getBoundingRect
getMissingPartNames()​
protectedgetMissingPartNames(partName):Promise<readonly keyofT[]>
Defined in: packages/core/src/drivers/ComponentDriver.ts:125
Get the names of parts not in the DOM
Parameters​
partName​
keyof T | readonly keyof T[]
Single or array of the names of the parts to be examined
Returns​
Promise<readonly keyof T[]>
Inherited from​
ComponentDriver.getMissingPartNames
getText()​
getText():
Promise<Optional<string>>
Defined in: packages/core/src/drivers/ComponentDriver.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
Implementation of​
Inherited from​
hover()​
hover(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:174
Parameters​
option?​
Partial<HoverOption>
Returns​
Promise<void>
Inherited from​
innerHTML()​
innerHTML():
Promise<string>
Defined in: packages/core/src/drivers/ComponentDriver.ts:339
Get the inner HTML of the component
Returns​
Promise<string>
The inner HTML of the component
Inherited from​
isVisible()​
isVisible():
Promise<boolean>
Defined in: packages/core/src/drivers/ComponentDriver.ts:301
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
Implementation of​
Inherited from​
mouseDown()​
mouseDown(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:182
Parameters​
option?​
Partial<MouseDownOption>
Returns​
Promise<void>
Inherited from​
mouseEnter()​
mouseEnter(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:198
Parameters​
option?​
Partial<MouseEnterOption>
Returns​
Promise<void>
Inherited from​
mouseLeave()​
mouseLeave(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:202
Parameters​
option?​
Partial<MouseLeaveOption>
Returns​
Promise<void>
Inherited from​
mouseMove()​
mouseMove(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:178
Parameters​
option?​
Partial<MouseMoveOption>
Returns​
Promise<void>
Inherited from​
mouseOut()​
mouseOut(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:194
Parameters​
option?​
Partial<MouseOutOption>
Returns​
Promise<void>
Inherited from​
mouseOver()​
mouseOver(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:190
Parameters​
option?​
Partial<HoverOption>
Returns​
Promise<void>
Inherited from​
mouseUp()​
mouseUp(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:186
Parameters​
option?​
Partial<MouseUpOption>
Returns​
Promise<void>
Inherited from​
pressKey()​
pressKey(
key,option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:215
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​
runtimeCssSelector()​
runtimeCssSelector():
Promise<string>
Defined in: packages/core/src/drivers/ComponentDriver.ts:348
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​
ComponentDriver.runtimeCssSelector
scrollBy()​
scrollBy(
delta):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:251
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​
Pixel offset to scroll by
Returns​
Promise<void>
Inherited from​
scrollIntoView()​
scrollIntoView():
Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:239
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​
ComponentDriver.scrollIntoView
waitUntil()​
waitUntil<
T>(option):Promise<T>
Defined in: packages/core/src/drivers/ComponentDriver.ts:331
Type Parameters​
T​
T
Parameters​
option​
Returns​
Promise<T>
Inherited from​
waitUntilComponentState()​
waitUntilComponentState(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:327
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>> = defaultWaitForOption
The option to configure the wait behavior
Returns​
Promise<void>
Implementation of​
IComponentDriver.waitUntilComponentState
Inherited from​
ComponentDriver.waitUntilComponentState
waitUntilVisible()​
waitUntilVisible(
timeoutMs?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:309
Wait until the component is attached and becomes visible to the DOM.
Parameters​
timeoutMs?​
number = 10000
The number of milliseconds to wait before timing out
Returns​
Promise<void>
Inherited from​
ComponentDriver.waitUntilVisible
overriddenParentLocator()​
staticoverriddenParentLocator():Optional<PartLocator>
Defined in: packages/core/src/drivers/ComponentDriver.ts:77
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​
Inherited from​
ComponentDriver.overriddenParentLocator
overrideLocatorRelativePosition()​
staticoverrideLocatorRelativePosition():Optional<LocatorRelativePosition>
Defined in: packages/core/src/drivers/ComponentDriver.ts:90
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>