Abstract Class: ComponentDriver<T>
Defined in: packages/core/src/drivers/ComponentDriver.ts:35
Base class for all component drivers. It provides the basic functionality to interact with the component
Extended by​
Type Parameters​
T​
T extends ScenePart = { }
Implements​
Constructors​
Constructor​
new ComponentDriver<
T>(locator,interactor,option?):ComponentDriver<T>
Defined in: packages/core/src/drivers/ComponentDriver.ts:65
Parameters​
locator​
Locator for the root of this component.
interactor​
Environment adapter used for all interactions.
option?​
Partial<IComponentDriverOption<T>>
Driver option carrying the shared driver-tree context.
Composite-driver authoring rule: a driver that declares non-empty parts
must type this parameter as Partial<IComponentDriverOption> (i.e. the empty
<{}> default) and hardcode its own parts in the body —
super(locator, interactor, { ...option, parts }). The "natural"
Partial<IComponentDriverOption<typeof parts>> signature does NOT satisfy
ScenePartDefinition['driver'] (constructor parameters are checked
contravariantly), so a driver written that way could not be placed in a
parent ScenePart. Lock a composite driver against this rule in one line with
AssertScenePlaceableDriver; the rule itself is regression-tested
centrally in core/src/drivers/__type-tests__ and demonstrated in
@atomic-testing/component-driver-html.
Returns​
ComponentDriver<T>
Properties​
commutableOption​
readonlycommutableOption:CommutableComponentDriverOption
Defined in: packages/core/src/drivers/ComponentDriver.ts:46
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.
interactor​
readonlyinteractor:Interactor
Defined in: packages/core/src/drivers/ComponentDriver.ts:67
Environment adapter used for all interactions.
Accessors​
driverName​
Get Signature​
get
abstractdriverName():string
Defined in: packages/core/src/drivers/ComponentDriver.ts:503
Returns​
string
locator​
Get Signature​
get locator():
PartLocator
Defined in: packages/core/src/drivers/ComponentDriver.ts:129
Return the locator of the component
Returns​
The locator which helps locate the root of the component
Implementation of​
parts​
Get Signature​
get parts():
ScenePartDriver<T>
Defined in: packages/core/src/drivers/ComponentDriver.ts:122
Return driver instance of all the named parts
Returns​
Return driver instance of all the named parts
Implementation of​
Methods​
click()​
click(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:255
Parameters​
option?​
Partial<ClickOption>
Returns​
Promise<void>
exists()​
exists():
Promise<boolean>
Defined in: packages/core/src/drivers/ComponentDriver.ts:251
Whether the component exists/attached to the DOM
Returns​
Promise<boolean>
true if the component is attached to the DOM, false otherwise
Implementation of​
focus()​
focus(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:298
Parameters​
option?​
Partial<FocusOption>
Returns​
Promise<void>
getAttribute()​
getAttribute(
attributeName):Promise<Optional<string>>
Defined in: packages/core/src/drivers/ComponentDriver.ts:243
Parameters​
attributeName​
string
Returns​
Promise<Optional<string>>
getText()​
getText():
Promise<Optional<string>>
Defined in: packages/core/src/drivers/ComponentDriver.ts:239
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​
hover()​
hover(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:259
Parameters​
option?​
Partial<HoverOption>
Returns​
Promise<void>
isVisible()​
isVisible():
Promise<boolean>
Defined in: packages/core/src/drivers/ComponentDriver.ts:403
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​
pressKey()​
pressKey(
key,option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:308
Dispatch a keyboard key press on the component. See Interactor.pressKey for the full contract, including modifier-key delivery via PressKeyOption.
Parameters​
key​
string
A KeyboardEvent.key value, e.g. 'Escape', 'Backspace', 'Enter'
option?​
Partial<PressKeyOption>
Modifier flags and other per-press options — see PressKeyOption
Returns​
Promise<void>
runtimeCssSelector()​
runtimeCssSelector():
Promise<string>
Defined in: packages/core/src/drivers/ComponentDriver.ts:499
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
scrollIntoView()​
scrollIntoView():
Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:341
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>
typeText()​
typeText(
text):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:317
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>
waitUntil()​
waitUntil<
T>(option):Promise<T>
Defined in: packages/core/src/drivers/ComponentDriver.ts:435
Type Parameters​
T​
T
Parameters​
option​
Returns​
Promise<T>
waitUntilComponentState()​
waitUntilComponentState(
option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:431
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
waitUntilVisible()​
waitUntilVisible(
timeoutMs?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:413
Wait until the component is attached and becomes visible to the DOM.
Parameters​
timeoutMs?​
number = defaultWaitForOption.timeoutMs
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>
within()​
within<
ContentT>(parts):ScenePartDriver<ContentT>
Defined in: packages/core/src/drivers/ComponentDriver.ts:189
Driver instances for a caller-supplied interior scene, resolved against this component's ComponentDriver.interiorLocator.
The call-time counterpart to ComponentDriver.parts: parts is the
chrome the driver author hardcodes, this is the interior the scene author
owns — a dialog's body, a popover's panel, a toast's action area. A
PartLocator resolves lazily and queries nothing here, so this is
synchronous and safe to call before the interior has mounted.
This replaced an earlier ContainerDriver base whose content option
required the same scene to be named twice — once as a type argument, once in
the driver option — plus a laundering constructor in every subclass (ADR-019).
Named within rather than getContent because leaf drivers already own that
name for reading a component's own text (a badge's content, a tooltip's
content), and a base-class member cannot collide with them.
Interior children are constructed with an empty option, exactly as content
parts always have been: an interior belongs to the scene, so it inherits no
driver-specific configuration from its host. This differs deliberately from
ComponentDriver.parts, whose children do inherit the host's option.
Type Parameters​
ContentT​
ContentT extends ScenePart
Parameters​
parts​
ContentT
The interior scene to resolve against this component's interior
Returns​
ScenePartDriver<ContentT>
One driver instance per named part
overriddenParentLocator()​
staticoverriddenParentLocator(_option?):Optional<PartLocator>
Defined in: packages/core/src/drivers/ComponentDriver.ts:97
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.
option is the fully-merged constructor option the driver is about to receive
(the same value passed to the driver's own constructor) — a purely static,
per-invocation input, not instance state — so a driver whose portalling is
conditional on how its scene configures it (e.g. an overlay that can render
teleported OR in-tree, such as PrimeVue's appendTo="self") can branch on a
flag there instead of always re-rooting. Ignore it to keep unconditional
portal behavior.
Parameters​
_option?​
Partial<IComponentDriverOption<any>>
Returns​
overrideLocatorRelativePosition()​
staticoverrideLocatorRelativePosition(_option?):Optional<LocatorRelativePosition>
Defined in: packages/core/src/drivers/ComponentDriver.ts:113
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.
See ComponentDriver.overriddenParentLocator for what option carries
and why accepting it does not reintroduce instance state.
Parameters​
_option?​
Partial<IComponentDriverOption<any>>
Returns​
Optional<LocatorRelativePosition>
Protected members (18)
Accessors​
interiorLocator​
Get Signature​
get
protectedinteriorLocator():PartLocator
Defined in: packages/core/src/drivers/ComponentDriver.ts:160
The element ComponentDriver.within resolves an interior scene against —
"inside this component", as this driver defines inside. Defaults to
ComponentDriver.locator, which is already correct wherever a driver's own
locator resolves to the surface holding caller content (Radix/Reka anchor at
Dialog.Content, Fluent at DialogSurface).
Override it when the driver's locator resolves to a wrapper instead. MUI's
Dialog, Drawer and Menu are the shipped cases: their locator is the portal-rendered
Modal root, whose children are the backdrop, two focus-trap sentinels and a
positioning container. Un-narrowed, an interior there reaches MUI's own chrome,
and a 'Child'-relative interior part resolves to .MuiBackdrop-root rather
than to anything the scene wrote — silently, since a locator that matches the
wrong element raises nothing.
An override only helps where that chrome is ancestral to the caller's content. Where a design system interleaves chrome beside it — Fluent's focus-trap sentinels are siblings of the dialog body — no anchor separates the two, and the default stands (ADR-019's rollout-width audit).
An override MUST resolve to an element containing everything the caller
supplied. For a slotted component that means the surface, never one slot: MUI
spreads caller content across DialogTitle/DialogContent/DialogActions as
siblings, so narrowing to .MuiDialogContent-root would drop the action buttons
scenes click. Over-narrowing fails the same silent way it fixes — the part just
stops resolving (ADR-019).
Returns​
Methods​
activate()​
protectedactivate():Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:331
Activate the component without relying on pointer geometry. See Interactor.activate.
Returns​
Promise<void>
awaitPostcondition()​
protectedawaitPostcondition(postcondition,probeFn,option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:470
Hold an action open until its own postcondition holds, so the action does not resolve while the DOM it promised is still arriving.
Why actions, not reads or assertions. An interactor settles the
framework's scheduler after a write (React act(), Vue nextTick(),
Angular whenStable()) and then treats the DOM as final. A component that
defers its own DOM work onto a host timer — a setTimeout to re-register a
select's options, to restore a picker's section spans — lands after that
settle, so the next single-shot read observes a transient state that is
neither the old value nor the new one. Making reads retry cannot fix this
(a read does not know what it is waiting for, and negative reads must stay
fast); making every mutation drain a fixed extra macrotask is a sleep at
framework scale. The action is the only layer that knows what it promised,
so the action is where the wait belongs.
Probing uses waitUntil's escalating intervals, so a postcondition that already holds costs one probe and no delay.
Parameters​
postcondition​
string
Human-readable description of the awaited state, used verbatim in PostconditionNotMetError. Phrase it as the state that must arrive, not the action taken.
probeFn​
() => boolean | Promise<boolean>
Returns true once the postcondition holds. Keep it cheap — it runs repeatedly.
option?​
timeoutMs?​
number
Defaults to defaultWaitForOption.timeoutMs so every wait in the library shares one flake-tolerance source (#1057).
Returns​
Promise<void>
Throws​
If the postcondition never holds. Failing here is deliberate: an action that cannot keep its promise is a real defect, and reporting it at the action gives a far better diagnostic than the downstream assertion mismatch it would otherwise become.
contextMenu()​
protectedcontextMenu():Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:324
Dispatch a right-click / contextmenu event on the component. See Interactor.contextMenu.
Returns​
Promise<void>
drag()​
protecteddrag(delta):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:381
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>
dragTo()​
protecteddragTo(target):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:367
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>
enforcePartExistence()​
protectedenforcePartExistence(partName):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:198
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>
getBoundingRect()​
protectedgetBoundingRect():Promise<BoundingRect>
Defined in: packages/core/src/drivers/ComponentDriver.ts:391
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>
getMissingPartNames()​
protectedgetMissingPartNames(partName):Promise<readonly keyofT[]>
Defined in: packages/core/src/drivers/ComponentDriver.ts:210
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[]>
innerHTML()​
protectedinnerHTML():Promise<string>
Defined in: packages/core/src/drivers/ComponentDriver.ts:490
Get the inner HTML of the component
Returns​
Promise<string>
The inner HTML of the component
mouseDown()​
protectedmouseDown(option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:274
Parameters​
option?​
Partial<MouseDownOption>
Returns​
Promise<void>
mouseEnter()​
protectedmouseEnter(option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:290
Parameters​
option?​
Partial<MouseEnterOption>
Returns​
Promise<void>
mouseLeave()​
protectedmouseLeave(option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:294
Parameters​
option?​
Partial<MouseLeaveOption>
Returns​
Promise<void>
mouseMove()​
protectedmouseMove(option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:270
Parameters​
option?​
Partial<MouseMoveOption>
Returns​
Promise<void>
mouseOut()​
protectedmouseOut(option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:286
Parameters​
option?​
Partial<MouseOutOption>
Returns​
Promise<void>
mouseOver()​
protectedmouseOver(option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:282
Parameters​
option?​
Partial<HoverOption>
Returns​
Promise<void>
mouseUp()​
protectedmouseUp(option?):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:278
Parameters​
option?​
Partial<MouseUpOption>
Returns​
Promise<void>
scrollBy()​
protectedscrollBy(delta):Promise<void>
Defined in: packages/core/src/drivers/ComponentDriver.ts:353
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>