Class: TagPickerDriver
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:96
Driver for the Fluent v9 TagPicker (@fluentui/react-tag-picker, re-exported
by @fluentui/react-components) — a multiselect, freeform-filterable combobox
composed of TagPickerControl (wrapping a TagPickerGroup of currently
selected tags and a freeform TagPickerInput) and a portalled TagPickerList
of TagPickerOption children.
Root — put the scene's locator on TagPickerControl, not <TagPicker>:
DOM audit (@fluentui/react-components@9.74.3): <TagPicker> itself renders no
DOM at all — it is a pure context-provider wrapper around its trigger
(TagPickerControl) and portalled popover (TagPickerList) children, the
same shape Popover/Dialog share at their own top level. TagPickerControl
is the one in-tree, non-portalled element a data-testid can land on
directly (getIntrinsicElementProps spreads it straight onto its root
<div class="fui-TagPickerControl">), and it contains BOTH the selected-tag
group and the freeform input as descendants, so this driver is constructed
straight from that locator with no re-root hooks needed.
Selected-tag group and portalled option list share role="listbox":
DOM audit — TagPickerGroup explicitly sets role="listbox" on itself
(useTagPickerGroup_unstable hardcodes it), and separately TagPickerList
(built on @fluentui/react-combobox's Listbox) also renders
role="listbox". Exactly the collision Wave 2's PopoverDriver documents
for its own too-generic role="group" — this driver anchors on the
un-hashed fui-TagPickerGroup/fui-TagPickerList structural classes
instead of role for both, per the package's tier-2 fallback.
Each selected tag ALSO renders role="option": TagPickerGroup forcing
role="listbox" on itself cascades into Tag's own useTagBase_unstable,
which renders role="option" (not the plain unselectable role="button"/no
role a bare Tag gets elsewhere) for any Tag inside a role="listbox"
group — DOM audit. TagPickerGroup also force-sets dismissible on every
child Tag regardless of the consumer's own props, rendering each as a real
<button> whose default click handler dismisses it (fires the group's
onDismiss, which the picker wires straight back to deselection) — so
removeSelected is a plain ComponentDriver.click on the
matched tag, no dedicated dismiss-icon target needed.
TagPickerGroup renders NOTHING while empty: DOM audit —
renderTagPickerGroup_unstable returns null outright (not even an empty
wrapper <div>) when there are zero selected options, unlike a typical
"empty container" case. getSelectedLabels still degrades correctly
to [] without special-casing: childListHelper's child-count query simply
matches nothing when its container locator itself resolves to no element.
Listbox portal — trigger-anchored + byLinkedElement, same recipe as
Dropdown: DOM audit — the portalled TagPickerList mounts into a cloned
FluentProvider on document.body (the same mechanism every Wave 2 overlay
and Wave 3's Combobox/Dropdown use) and is linked back to
TagPickerInput via aria-controls → the list's id, present ONLY while
open (TagPickerInput renders no id of its own at all, mirroring
Dropdown's trigger — see ../internal/tagPickerLocators.ts). Because
TagPickerInput is built on the identical @fluentui/react-combobox input
trigger primitive Combobox uses (useInputTriggerSlot, confirmed by DOM
audit of the compiled hook), option-reading methods (getOptionCount,
getOptionLabels, getOptionByLabel, selectByLabel)
follow ComboboxDriver's convention of opening the list first rather than
DropdownDriver's silent-empty-while-closed one — but still guard the
subsequent read in a try/catch (a defensive synthesis of both siblings'
conventions), since a disabled or otherwise non-cooperating picker can leave
aria-controls absent even after a best-effort open.
isOpen reads the input's own aria-expanded, not list existence: DOM
audit — like Dropdown, Fluent keeps the portalled list mounted after
closing (e.g. immediately after selectByLabel auto-closes the
picker) for as long as the input retains focus, only clearing the
aria-controls/id link. A mere existence check would misreport "open"
right after a legitimate close, so isOpen reads aria-expanded
instead, confirmed to track the open state exactly (including toggling
closed on a second click of an already-open input).
Scope limit — no portable per-option isSelected: see
TagPickerOptionDriver's class doc.
Extends​
ComponentDriver<{ }>
Implements​
IDisableableDriverIRequirableDriverIReadonlyableDriverIValidatableDriver
Constructors​
Constructor​
new TagPickerDriver(
locator,interactor,option?):TagPickerDriver
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:104
Parameters​
locator​
PartLocator
interactor​
Interactor
option?​
Partial<IComponentDriverOption<{ }>>
Returns​
TagPickerDriver
Overrides​
ComponentDriver<{}>.constructor
Accessors​
driverName​
Get Signature​
get driverName():
string
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:284
Returns​
string
Overrides​
ComponentDriver.driverName
Methods​
close()​
close():
Promise<void>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:173
Close the option list by clicking the freeform input, if open.
Returns​
Promise<void>
getFilterText()​
getFilterText():
Promise<Optional<string>>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:150
The freeform input's current filter text (a native <input>'s own .value,
so genuinely empty reads back as '', never absent in practice — absence is
only the theoretical "locator matched nothing" case, the same '' default
ComboboxDriver.getValue shows).
That "matched nothing" reading is why this is Optional per ADR-006 §7, and
it is a deliberate divergence from HTMLTextInputDriver.getValue, which still
answers null. The html field drivers are outside this package and stay on
the form-value spelling; converting them would change the frozen surface of
component-driver-html and belongs to that decision, not this one.
Returns​
Promise<Optional<string>>
getOptionByLabel()​
getOptionByLabel(
label):Promise<Optional<TagPickerOptionDriver>>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:217
The option whose visible label matches label — opens the list first if
not already open (see class doc); undefined when no option matches, or when
the listbox still can't be resolved after that best-effort open, not
merely because the picker started closed.
Parameters​
label​
string
Returns​
Promise<Optional<TagPickerOptionDriver>>
getOptionCount()​
getOptionCount():
Promise<number>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:185
The number of options in the list — opens it first if not already open
(see class doc); 0 only if the listbox still can't be resolved after
that best-effort open (e.g. a disabled or otherwise non-cooperating
picker), not merely because the picker started closed.
Returns​
Promise<number>
getOptionLabels()​
getOptionLabels():
Promise<string[]>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:200
The visible labels of every option in the list, in DOM order — opens it
first if not already open (see class doc); [] only if the listbox
still can't be resolved after that best-effort open, not merely because
the picker started closed.
Returns​
Promise<string[]>
getSelectedLabels()​
getSelectedLabels():
Promise<string[]>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:112
The visible label of every currently selected tag, in DOM order; [] when none are selected.
Returns​
Promise<string[]>
isDisabled()​
isDisabled():
Promise<boolean>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:265
Whether the freeform input is disabled (native disabled attribute).
Returns​
Promise<boolean>
Implementation of​
IDisableableDriver.isDisabled
isError()​
isError():
Promise<boolean>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:280
Whether the freeform input is in an invalid/error state (aria-invalid="true").
Returns​
Promise<boolean>
Implementation of​
IValidatableDriver.isError
isOpen()​
isOpen():
Promise<boolean>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:161
Whether the option list is expanded, via the input's own aria-expanded (see class doc).
Returns​
Promise<boolean>
isReadonly()​
isReadonly():
Promise<boolean>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:275
Whether the freeform input is read-only (native readonly attribute).
Returns​
Promise<boolean>
Implementation of​
IReadonlyableDriver.isReadonly
isRequired()​
isRequired():
Promise<boolean>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:270
Whether the freeform input is marked required (native required attribute).
Returns​
Promise<boolean>
Implementation of​
IRequirableDriver.isRequired
open()​
open():
Promise<void>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:166
Open the option list by clicking the freeform input, if not already open.
Returns​
Promise<void>
removeSelected()​
removeSelected(
label):Promise<void>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:128
Dismiss the selected tag whose visible label matches label (a plain
click — see class doc for why the whole tag is the dismiss target).
Parameters​
label​
string
Returns​
Promise<void>
Throws​
when no selected tag matches.
selectByLabel()​
selectByLabel(
label):Promise<void>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:233
Click the option whose visible label matches label, opening the list
first. Fluent closes the list and mirrors the option into the selected-tag
group once selected (verified against rendered DOM) — no additional
close call needed here.
Parameters​
label​
string
Returns​
Promise<void>
Throws​
when no option matches.
setFilter()​
setFilter(
text):Promise<void>
Defined in: packages/component-driver-fluent-v9/src/components/TagPickerDriver.ts:156
Replace the freeform input's filter text.
Parameters​
text​
string
Returns​
Promise<void>
Inherited members (21)
Properties​
commutableOption​
readonlycommutableOption: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​
readonlyinteractor:Interactor
Defined in: packages/core/dist/index.d.mts:1346
Inherited from​
ComponentDriver.interactor
Accessors​
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()​
staticoverriddenParentLocator(_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()​
staticoverrideLocatorRelativePosition(_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 (18)
Accessors​
interiorLocator​
Get Signature​
get
protectedinteriorLocator():PartLocator
Defined in: packages/core/dist/index.d.mts:1442
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​
PartLocator
Inherited from​
ComponentDriver.interiorLocator
Methods​
activate()​
protectedactivate():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()​
protectedawaitPostcondition(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()​
protectedcontextMenu():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()​
protecteddrag(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()​
protecteddragTo(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()​
protectedenforcePartExistence(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​
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: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()​
protectedgetMissingPartNames(partName):Promise<readonlynever[]>
Defined in: packages/core/dist/index.d.mts:1480
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:1635
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:1495
Parameters​
option?​
Partial<MouseDownOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseDown
mouseEnter()​
protectedmouseEnter(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1499
Parameters​
option?​
Partial<MouseEnterOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseEnter
mouseLeave()​
protectedmouseLeave(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1500
Parameters​
option?​
Partial<MouseLeaveOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseLeave
mouseMove()​
protectedmouseMove(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1494
Parameters​
option?​
Partial<MouseMoveOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseMove
mouseOut()​
protectedmouseOut(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1498
Parameters​
option?​
Partial<MouseOutOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseOut
mouseOver()​
protectedmouseOver(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1497
Parameters​
option?​
Partial<HoverOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseOver
mouseUp()​
protectedmouseUp(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1496
Parameters​
option?​
Partial<MouseUpOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseUp
scrollBy()​
protectedscrollBy(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