Skip to main content

Abstract Class: OverlayDriver<T>

Defined in: packages/component-driver-mui-v9/src/components/OverlayDriver.ts:23

Shared base for MUI portal-rendered overlays (Drawer today; Dialog, Menu, Popover and SpeedDial are prospective consumers). It owns the open/close lifecycle that DialogDriver first proved out: isOpen derived from the visible surface, waitForOpen/waitForClose spanning the transition, and closeByBackdrop.

Subclasses supply getSurfaceLocator (the element whose visibility means "open") and, when the overlay is portal-rendered, override the static overriddenParentLocator()/overrideLocatorRelativePosition() portal hooks to re-root.

closeByEscape is intentionally absent: keyboard dismissal needs a key-press primitive the Interactor interface does not yet expose, which would have to be added to every interactor (DOM/React/Vue/Playwright). It is deferred rather than partially implemented.

Extends​

  • ComponentDriver<T>

Extended by​

Type Parameters​

T​

T extends ScenePart = { }

Constructors​

Constructor​

new OverlayDriver<T>(locator, interactor, option?): OverlayDriver<T>

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

Parameters​

locator​

PartLocator

Locator for the root of this component.

interactor​

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​

OverlayDriver<T>

Inherited from​

ComponentDriver<T>.constructor

Methods​

closeByBackdrop()​

closeByBackdrop(timeoutMs?): Promise<boolean>

Defined in: packages/component-driver-mui-v9/src/components/OverlayDriver.ts:107

Dismiss by clicking the backdrop, then wait for the close transition. Whether it actually closes depends on the consumer honoring the backdrop dismissal; the returned boolean reflects the observed close, not merely the click.

Parameters​

timeoutMs?​

number = defaultTransitionDuration

Returns​

Promise<boolean>

isOpen()​

isOpen(): Promise<boolean>

Defined in: packages/component-driver-mui-v9/src/components/OverlayDriver.ts:52

Whether the overlay is mounted and its surface is visible. Because of open/close transitions, prefer waitForOpen()/waitForClose() immediately after an action.

Returns​

Promise<boolean>

waitForClose()​

waitForClose(timeoutMs?): Promise<boolean>

Defined in: packages/component-driver-mui-v9/src/components/OverlayDriver.ts:78

Wait until the overlay is closed. Polls for up to timeoutMs, then allows a further closeGraceMs grace period for a real transition timer that's merely running late before giving up (see the fallback below).

Parameters​

timeoutMs?​

number = defaultTransitionDuration

Returns​

Promise<boolean>

true once closed, within timeoutMs plus the grace period.

waitForOpen()​

waitForOpen(timeoutMs?): Promise<boolean>

Defined in: packages/component-driver-mui-v9/src/components/OverlayDriver.ts:63

Wait until the overlay is open.

Parameters​

timeoutMs?​

number = defaultTransitionDuration

Returns​

Promise<boolean>

true once open within the timeout.

Inherited members (22)

Properties​

commutableOption​

readonly commutableOption: CommutableComponentDriverOption

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

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​

ComponentDriver.commutableOption

interactor​

readonly interactor: Interactor

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

Inherited from​

ComponentDriver.interactor

Accessors​

driverName​

Get Signature​

get abstract driverName(): string

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

Returns​

string

Inherited from​

ComponentDriver.driverName

locator​

Get Signature​

get locator(): PartLocator

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

Return the locator of the component

Returns​

PartLocator

Inherited from​

ComponentDriver.locator

parts​

Get Signature​

get parts(): ScenePartDriver<T>

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

Return driver instance of all the named parts

Returns​

ScenePartDriver<T>

Inherited from​

ComponentDriver.parts

Methods​

click()​

click(option?): Promise<void>

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

Parameters​
option?​

Partial<ClickOption>

Returns​

Promise<void>

Inherited from​

ComponentDriver.click

exists()​

exists(): Promise<boolean>

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

Whether the component exists/attached to the DOM

Returns​

Promise<boolean>

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

Inherited from​

ComponentDriver.exists

focus()​

focus(option?): Promise<void>

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

Parameters​
option?​

Partial<FocusOption>

Returns​

Promise<void>

Inherited from​

ComponentDriver.focus

getAttribute()​

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

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

Parameters​
attributeName​

string

Returns​

Promise<Optional<string>>

Inherited from​

ComponentDriver.getAttribute

getText()​

getText(): Promise<Optional<string>>

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

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​

ComponentDriver.getText

hover()​

hover(option?): Promise<void>

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

Parameters​
option?​

Partial<HoverOption>

Returns​

Promise<void>

Inherited from​

ComponentDriver.hover

isVisible()​

isVisible(): Promise<boolean>

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

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​

ComponentDriver.isVisible

pressKey()​

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

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

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>

Inherited from​

ComponentDriver.pressKey

runtimeCssSelector()​

runtimeCssSelector(): Promise<string>

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

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

scrollIntoView()​

scrollIntoView(): Promise<void>

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

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

typeText()​

typeText(text): Promise<void>

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

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​

ComponentDriver.typeText

waitUntil()​

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

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

Type Parameters​
T​

T

Parameters​
option​

WaitUntilOption<T>

Returns​

Promise<T>

Inherited from​

ComponentDriver.waitUntil

waitUntilComponentState()​

waitUntilComponentState(option?): Promise<void>

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

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​

ComponentDriver.waitUntilComponentState

waitUntilVisible()​

waitUntilVisible(timeoutMs?): Promise<void>

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

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​

ComponentDriver.waitUntilVisible

within()​

within<ContentT>(parts): ScenePartDriver<ContentT>

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

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

Inherited from​

ComponentDriver.within

overriddenParentLocator()​

static overriddenParentLocator(_option?): Optional<PartLocator>

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

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​

Optional<PartLocator>

Inherited from​

ComponentDriver.overriddenParentLocator

overrideLocatorRelativePosition()​

static overrideLocatorRelativePosition(_option?): Optional<LocatorRelativePosition>

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

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>

Inherited from​

ComponentDriver.overrideLocatorRelativePosition

Protected members (20)

Accessors​

interiorLocator​

Get Signature​

get protected interiorLocator(): PartLocator

Defined in: packages/component-driver-mui-v9/src/components/OverlayDriver.ts:37

Interiors resolve against the overlay's surface, not its Modal root: the root's own children are the backdrop, the focus-trap sentinels and a positioning container, none of which the scene wrote. The surface is exactly the element getSurfaceLocator already names for the open-state read, so the two stay in lockstep by construction.

Returns​

PartLocator

Overrides​

ComponentDriver.interiorLocator

Methods​

activate()​

protected activate(): Promise<void>

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

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

Returns​

Promise<void>

Inherited from​

ComponentDriver.activate

awaitPostcondition()​

protected awaitPostcondition(postcondition, probeFn, option?): Promise<void>

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

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.

Inherited from​

ComponentDriver.awaitPostcondition

contextMenu()​

protected contextMenu(): Promise<void>

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

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

Returns​

Promise<void>

Inherited from​

ComponentDriver.contextMenu

drag()​

protected drag(delta): Promise<void>

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

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​

ComponentDriver.drag

dragTo()​

protected dragTo(target): Promise<void>

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

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​

ComponentDriver.dragTo

enforcePartExistence()​

protected enforcePartExistence(partName): Promise<void>

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

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

getBackdropLocator()​

protected getBackdropLocator(): PartLocator

Defined in: packages/component-driver-mui-v9/src/components/OverlayDriver.ts:44

Locator of the dismissible backdrop. Defaults to MUI's .MuiBackdrop-root.

Returns​

PartLocator

getBoundingRect()​

protected getBoundingRect(): Promise<BoundingRect>

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

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()​

protected getMissingPartNames(partName): Promise<readonly keyof T[]>

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

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

getSurfaceLocator()​

abstract protected getSurfaceLocator(): PartLocator

Defined in: packages/component-driver-mui-v9/src/components/OverlayDriver.ts:28

Locator of the surface whose visibility reflects the open state (e.g. the drawer/dialog paper).

Returns​

PartLocator

innerHTML()​

protected innerHTML(): Promise<string>

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

Get the inner HTML of the component

Returns​

Promise<string>

The inner HTML of the component

Inherited from​

ComponentDriver.innerHTML

mouseDown()​

protected mouseDown(option?): Promise<void>

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

Parameters​
option?​

Partial<MouseDownOption>

Returns​

Promise<void>

Inherited from​

ComponentDriver.mouseDown

mouseEnter()​

protected mouseEnter(option?): Promise<void>

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

Parameters​
option?​

Partial<MouseEnterOption>

Returns​

Promise<void>

Inherited from​

ComponentDriver.mouseEnter

mouseLeave()​

protected mouseLeave(option?): Promise<void>

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

Parameters​
option?​

Partial<MouseLeaveOption>

Returns​

Promise<void>

Inherited from​

ComponentDriver.mouseLeave

mouseMove()​

protected mouseMove(option?): Promise<void>

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

Parameters​
option?​

Partial<MouseMoveOption>

Returns​

Promise<void>

Inherited from​

ComponentDriver.mouseMove

mouseOut()​

protected mouseOut(option?): Promise<void>

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

Parameters​
option?​

Partial<MouseOutOption>

Returns​

Promise<void>

Inherited from​

ComponentDriver.mouseOut

mouseOver()​

protected mouseOver(option?): Promise<void>

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

Parameters​
option?​

Partial<HoverOption>

Returns​

Promise<void>

Inherited from​

ComponentDriver.mouseOver

mouseUp()​

protected mouseUp(option?): Promise<void>

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

Parameters​
option?​

Partial<MouseUpOption>

Returns​

Promise<void>

Inherited from​

ComponentDriver.mouseUp

scrollBy()​

protected scrollBy(delta): Promise<void>

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

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​

ComponentDriver.scrollBy