Class: AutocompleteDriver
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:62
Driver for the Angular Material autocomplete (MatAutocomplete).
Locate it by the trigger <input> carrying the [matAutocomplete]
directive (e.g. a data-testid placed there) — the input is the
role="combobox" element and carries the widget's ARIA state
(aria-expanded, aria-controls). The driver is the text input, so
getValue and enterText compose the plain input contract with the
overlay-panel handling below.
The option panel (role="listbox" with role="option" children) renders
outside the input's subtree — a CDK overlay whose exact location drifts by
Material major (overlay container on v20, native-popover Top Layer host on
v21/v22). Like SelectDriver, this driver never assumes a location: it
resolves the panel through the ARIA link Material maintains — the trigger's
aria-controls names the panel's id while open, and is removed when
closed, so every panel read is guarded by the open state.
The panel opens on the trigger's own focus/click/typing handlers (no
keyboard workaround needed, unlike MatSelect) and only shows while it has
content: Material reports aria-expanded="false" when filtering has left
no options, which this driver surfaces as zero options rather than an
error.
See​
https://material.angular.dev/components/autocomplete
Extends​
ComponentDriver<{ }>
Implements​
IInputDriver<string|null>IDisableableDriverIRequirableDriver
Constructors​
Constructor​
new AutocompleteDriver(
locator,interactor,option?):AutocompleteDriver
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:66
Parameters​
locator​
PartLocator
interactor​
Interactor
option?​
Partial<IComponentDriverOption<{ }>>
Returns​
AutocompleteDriver
Overrides​
ComponentDriver<{}>.constructor
Accessors​
driverName​
Get Signature​
get driverName():
string
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:294
Returns​
string
Overrides​
ComponentDriver.driverName
Methods​
closeDropdown()​
closeDropdown():
Promise<void>
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:117
Close the option panel with Escape (the documented dismiss key) and wait for it to be gone; a no-op when already closed.
Returns​
Promise<void>
enterText()​
enterText(
text):Promise<void>
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:236
Type into the trigger input without selecting anything — the raw filter-as-you-type gesture (replaces the current text; Material opens and re-filters the panel from its own input handler). Follow with getOptionCount/getOptionLabels to observe the filtered panel, or selectByLabel to pick from it.
Parameters​
text​
string
Returns​
Promise<void>
getOptionByLabel()​
getOptionByLabel(
label,option?):Promise<OptionDriver|null>
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:155
Get the driver of the option whose visible label equals label, opening
the panel first unless skipDropdownCheck says the caller already did.
Returns null when no option matches — including when the panel cannot
open because filtering has left nothing to show.
Parameters​
label​
string
option?​
Returns​
Promise<OptionDriver | null>
getOptionCount()​
getOptionCount():
Promise<number>
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:192
The number of options currently in the panel (opens the panel; 0 when
it cannot open because everything is filtered out).
Returns​
Promise<number>
getOptionLabels()​
getOptionLabels():
Promise<string[]>
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:176
The visible label of every option currently in the panel, in DOM order
(opens the panel; [] when it cannot open). Reflects the current filter
state — type first via enterText to filter.
Returns​
Promise<string[]>
getValue()​
getValue():
Promise<string|null>
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:225
The trigger input's current text — after a selection, the label of the selected option.
Returns​
Promise<string | null>
Implementation of​
IInputDriver.getValue
isDisabled()​
isDisabled():
Promise<boolean>
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:283
Whether the trigger input is disabled (the native disabled state).
Returns​
Promise<boolean>
Implementation of​
IDisableableDriver.isDisabled
isDropdownOpen()​
isDropdownOpen():
Promise<boolean>
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:90
Whether the option panel is open, per the trigger's aria-expanded.
Returns​
Promise<boolean>
isRequired()​
isRequired():
Promise<boolean>
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:290
Whether the trigger input is required (the native required state).
Returns​
Promise<boolean>
Implementation of​
IRequirableDriver.isRequired
openDropdown()​
openDropdown():
Promise<void>
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:101
Open the option panel by clicking the trigger input (Material opens on focus/click) and wait for it to be up; a no-op when already open. When the panel has nothing to show — every option filtered out — Material keeps it closed, so this resolves with the panel still reported closed after the transition timeout rather than throwing.
Returns​
Promise<void>
selectByLabel()​
selectByLabel(
label):Promise<void>
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:207
Select the option with the given visible label, probing until filtering has rendered it (typing re-filters asynchronously). Selecting closes the panel; the wait covers that too.
Parameters​
label​
string
Returns​
Promise<void>
Throws​
when no option matches within the probe window
setValue()​
setValue(
value):Promise<boolean>
Defined in: packages/component-driver-angular-material-v22/src/components/AutocompleteDriver.ts:249
The type-then-select flow: types value (which filters the panel), then
selects the option whose label equals it. null clears the input
instead.
Parameters​
value​
string | null
Returns​
Promise<boolean>
false when no option carries that label within the probe
window (the typed text stays in the input, the panel is closed again);
true once the option has been selected — Material then writes the
option's value into the input.
Implementation of​
IInputDriver.setValue
Inherited members (20)
Properties​
commutableOption​
readonlycommutableOption: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​
readonlyinteractor: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
isVisible()​
isVisible():
Promise<boolean>
Defined in: packages/core/dist/index.d.mts:1336
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: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()​
staticoverriddenParentLocator():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()​
staticoverrideLocatorRelativePosition():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()​
protectedactivate():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()​
protectedcontextMenu():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()​
protecteddrag(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()​
protecteddragTo(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()​
protectedenforcePartExistence(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()​
protectedgetBoundingRect():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()​
protectedgetMissingPartNames(partName):Promise<readonlynever[]>
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()​
protectedinnerHTML():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()​
protectedmouseDown(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1256
Parameters​
option?​
Partial<MouseDownOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseDown
mouseEnter()​
protectedmouseEnter(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1260
Parameters​
option?​
Partial<MouseEnterOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseEnter
mouseLeave()​
protectedmouseLeave(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1261
Parameters​
option?​
Partial<MouseLeaveOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseLeave
mouseMove()​
protectedmouseMove(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1255
Parameters​
option?​
Partial<MouseMoveOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseMove
mouseOut()​
protectedmouseOut(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1259
Parameters​
option?​
Partial<MouseOutOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseOut
mouseOver()​
protectedmouseOver(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1258
Parameters​
option?​
Partial<HoverOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseOver
mouseUp()​
protectedmouseUp(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1257
Parameters​
option?​
Partial<MouseUpOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseUp
scrollBy()​
protectedscrollBy(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