Skip to main content

Class: TooltipDriver

Defined in: packages/component-driver-mui-v9/src/components/TooltipDriver.ts:22

Driver for the Material UI v9 Tooltip component.

The driver is rooted at the trigger element. MUI shows the tooltip on hover/focus and renders it into a portal (a role="tooltip" popper) outside the trigger's subtree, so the text is read from the document root via tooltipLocator after revealing it. The tooltip unmounts when not shown, so presence of that element doubles as the visible state.

Note: hover reveal depends on the tooltip's enterDelay; with a non-zero delay the reveal is timer-bound. getTitle waits for the tooltip to appear.

See​

https://mui.com/material-ui/react-tooltip/

Extends​

  • ComponentDriver

Constructors​

Constructor​

new TooltipDriver(locator, interactor, option?): TooltipDriver

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

Parameters​

locator​

PartLocator

Locator for the root of this component.

interactor​

Interactor

Environment adapter used for all interactions.

option?​

Partial<IComponentDriverOption<{ }>>

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​

TooltipDriver

Inherited from​

ComponentDriver.constructor

Accessors​

driverName​

Get Signature​

get driverName(): string

Defined in: packages/component-driver-mui-v9/src/components/TooltipDriver.ts:79

Returns​

string

Overrides​

ComponentDriver.driverName

Methods​

getTitle()​

getTitle(timeoutMs?): Promise<Optional<string>>

Defined in: packages/component-driver-mui-v9/src/components/TooltipDriver.ts:69

Reveal the tooltip, read its text, then restore the un-hovered state. Returns undefined when the trigger has no tooltip (none appears within the timeout).

The hover is undone before returning so a subsequent read on a different trigger isn't shadowed by this still-open tooltip: MUI renders all tooltips into one portal and provides no per-trigger DOM link, and jsdom's synthetic hover does not fire mouseout on the previously-hovered sibling.

Parameters​

timeoutMs?​

number = defaultRevealTimeout

How long to wait for the tooltip to appear after hovering.

Returns​

Promise<Optional<string>>

hide()​

hide(timeoutMs?): Promise<void>

Defined in: packages/component-driver-mui-v9/src/components/TooltipDriver.ts:39

Hide the tooltip by moving the pointer off its trigger, waiting until it is gone.

Parameters​

timeoutMs?​

number = defaultRevealTimeout

Returns​

Promise<void>

isVisible()​

isVisible(): Promise<boolean>

Defined in: packages/component-driver-mui-v9/src/components/TooltipDriver.ts:51

Whether a tooltip is currently shown.

Returns​

Promise<boolean>

Overrides​

ComponentDriver.isVisible

show()​

show(timeoutMs?): Promise<void>

Defined in: packages/component-driver-mui-v9/src/components/TooltipDriver.ts:27

Reveal the tooltip by hovering its trigger, waiting until it is shown (or the timeout elapses, e.g. when the trigger has no tooltip).

Parameters​

timeoutMs?​

number = defaultRevealTimeout

Returns​

Promise<void>

Inherited members (19)

Properties​

commutableOption​

readonly commutableOption: CommutableComponentDriverOption

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

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:1172

Inherited from​

ComponentDriver.interactor

Accessors​

locator​

Get Signature​

get locator(): PartLocator

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

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:1225

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:1253

Parameters​
option?​

Partial<ClickOption>

Returns​

Promise<void>

Inherited from​

ComponentDriver.click

exists()​

exists(): Promise<boolean>

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

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:1262

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:1247

Parameters​
attributeName​

string

Returns​

Promise<Optional<string>>

Inherited from​

ComponentDriver.getAttribute

getText()​

getText(): Promise<Optional<string>>

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

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:1254

Parameters​
option?​

Partial<HoverOption>

Returns​

Promise<void>

Inherited from​

ComponentDriver.hover

pressKey()​

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

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

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​

ComponentDriver.pressKey

runtimeCssSelector()​

runtimeCssSelector(): Promise<string>

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

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:1289

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:1274

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:1356

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:1355

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:1343

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

overriddenParentLocator()​

static overriddenParentLocator(): Optional<PartLocator>

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

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​

Optional<PartLocator>

Inherited from​

ComponentDriver.overriddenParentLocator

overrideLocatorRelativePosition()​

static overrideLocatorRelativePosition(): Optional<LocatorRelativePosition>

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

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>

Inherited from​

ComponentDriver.overrideLocatorRelativePosition

Protected members (16)

Methods​

activate()​

protected activate(): Promise<void>

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

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

Returns​

Promise<void>

Inherited from​

ComponentDriver.activate

contextMenu()​

protected contextMenu(): Promise<void>

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

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:1320

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:1309

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:1235

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​

readonly never[]

Single or array of the names of the parts to be enforced

Returns​

Promise<void>

Inherited from​

ComponentDriver.enforcePartExistence

getBoundingRect()​

protected getBoundingRect(): Promise<BoundingRect>

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

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 never[]>

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

Get the names of parts not in the DOM

Parameters​
partName​

readonly never[]

Single or array of the names of the parts to be examined

Returns​

Promise<readonly never[]>

Inherited from​

ComponentDriver.getMissingPartNames

innerHTML()​

protected innerHTML(): Promise<string>

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

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:1256

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:1260

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:1261

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:1255

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:1259

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:1258

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:1257

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:1298

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