Class: TokenizerDriver
Defined in: component-driver-astryx/src/components/TokenizerDriver.ts:21
Driver for the Astryx Tokenizer (@astryxdesign/core/Tokenizer) ā a
search-as-you-type multi-token input.
The root is a role="group" (self-emitting data-testid) holding the existing
token chips followed by the role="combobox" <input>; results render in a
popup role="listbox" whose options carry ${listboxId}-option-${i} ids (shared
with Typeahead). Tokens are the root's span.astryx-token children, each with a
Remove <label> button. With hasCreate, a non-matching query yields a
Create "<query>" option. Results are debounced/async, so reads wait via
AstryxComboboxDriver.waitForOptions.
Extendsā
Constructorsā
Constructorā
new TokenizerDriver(
locator,interactor,option?):TokenizerDriver
Defined in: 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<{ }>>
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ā
TokenizerDriver
Inherited fromā
AstryxComboboxDriver.constructor
Accessorsā
driverNameā
Get Signatureā
get driverName():
string
Defined in: component-driver-astryx/src/components/TokenizerDriver.ts:150
Returnsā
string
Overridesā
AstryxComboboxDriver.driverName
Methodsā
addByLabel()ā
addByLabel(
label):Promise<boolean>
Defined in: component-driver-astryx/src/components/TokenizerDriver.ts:97
Add the result with the given label as a token (waits for results first).
Parametersā
labelā
string
Returnsā
Promise<boolean>
false when no such result exists.
clearAll()ā
clearAll():
Promise<boolean>
Defined in: component-driver-astryx/src/components/TokenizerDriver.ts:141
Clear every token via the clear control.
Returnsā
Promise<boolean>
false when there is no clear control (hasClear is off or there are no tokens).
create()ā
create():
Promise<boolean>
Defined in: component-driver-astryx/src/components/TokenizerDriver.ts:112
Click the Create "<query>" option to add the current query as a new token
(requires hasCreate; waits for results first).
Returnsā
Promise<boolean>
false when there is no create option.
getDisabledMessage()ā
getDisabledMessage():
Promise<Optional<string>>
Defined in: component-driver-astryx/src/components/TokenizerDriver.ts:66
The disabledMessage tooltip text, resolved via the query input's (the
role="combobox" control) aria-describedby link ā Astryx wires
disabledMessage's aria-describedby onto that inner input, not the
role="group" root. undefined when the field isn't in that
disabled-with-message state.
Returnsā
Promise<Optional<string>>
getQuery()ā
getQuery():
Promise<string>
Defined in: component-driver-astryx/src/components/TokenizerDriver.ts:55
The current query text in the input.
Returnsā
Promise<string>
getResultLabels()ā
getResultLabels():
Promise<readonlystring[]>
Defined in: component-driver-astryx/src/components/TokenizerDriver.ts:88
The result option labels for the current query, waiting for the (debounced) results.
Returnsā
Promise<readonly string[]>
getTokenCount()ā
getTokenCount():
Promise<number>
Defined in: component-driver-astryx/src/components/TokenizerDriver.ts:50
Number of token chips.
Returnsā
Promise<number>
getTokenLabels()ā
getTokenLabels():
Promise<readonlystring[]>
Defined in: component-driver-astryx/src/components/TokenizerDriver.ts:25
Every token chip's label, in DOM order.
Returnsā
Promise<readonly string[]>
isLoading()ā
isLoading():
Promise<boolean>
Defined in: component-driver-astryx/src/components/TokenizerDriver.ts:81
Whether a search is in flight. Qualified by aria-label="Loading" so it
matches only the busy spinner and not the clear button's always-present bare
role="status" span (every Astryx Button emits one without an
aria-label), which would otherwise be a false positive once a token exists.
Returnsā
Promise<boolean>
removeToken()ā
removeToken(
label):Promise<boolean>
Defined in: component-driver-astryx/src/components/TokenizerDriver.ts:128
Remove the token with the given label via its "Remove" button. byAriaLabel
escapes the label, so token labels containing quotes are matched safely.
Parametersā
labelā
string
Returnsā
Promise<boolean>
false when no such token exists.
type()ā
type(
text):Promise<void>
Defined in: component-driver-astryx/src/components/TokenizerDriver.ts:71
Type a query into the input, triggering a search.
Parametersā
textā
string
Returnsā
Promise<void>
Inherited members (24)
Propertiesā
commutableOptionā
readonlycommutableOption:CommutableComponentDriverOption
Defined in: 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ā
AstryxComboboxDriver.commutableOption
interactorā
readonlyinteractor:Interactor
Defined in: core/dist/index.d.mts:1346
Inherited fromā
AstryxComboboxDriver.interactor
Accessorsā
locatorā
Get Signatureā
get locator():
PartLocator
Defined in: core/dist/index.d.mts:1414
Return the locator of the component
Returnsā
PartLocator
Inherited fromā
partsā
Get Signatureā
get parts():
ScenePartDriver<T>
Defined in: core/dist/index.d.mts:1410
Return driver instance of all the named parts
Returnsā
ScenePartDriver<T>
Inherited fromā
Methodsā
click()ā
click(
option?):Promise<void>
Defined in: core/dist/index.d.mts:1492
Parametersā
option?ā
Partial<ClickOption>
Returnsā
Promise<void>
Inherited fromā
close()ā
close():
Promise<void>
Defined in: component-driver-astryx/src/components/AstryxComboboxDriver.ts:42
Close the popup, if open, by pressing Escape on the combobox. (Re-clicking the trigger is unreliable once the popup's top layer overlaps it ā Firefox cannot land the click ā whereas Astryx closes the listbox on Escape.)
Returnsā
Promise<void>
Inherited fromā
exists()ā
exists():
Promise<boolean>
Defined in: 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ā
focus()ā
focus(
option?):Promise<void>
Defined in: core/dist/index.d.mts:1501
Parametersā
option?ā
Partial<FocusOption>
Returnsā
Promise<void>
Inherited fromā
getAttribute()ā
getAttribute(
attributeName):Promise<Optional<string>>
Defined in: core/dist/index.d.mts:1486
Parametersā
attributeNameā
string
Returnsā
Promise<Optional<string>>
Inherited fromā
AstryxComboboxDriver.getAttribute
getText()ā
getText():
Promise<Optional<string>>
Defined in: 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ā
hover()ā
hover(
option?):Promise<void>
Defined in: core/dist/index.d.mts:1493
Parametersā
option?ā
Partial<HoverOption>
Returnsā
Promise<void>
Inherited fromā
isExpanded()ā
isExpanded():
Promise<boolean>
Defined in: component-driver-astryx/src/components/AstryxComboboxDriver.ts:20
Whether the popup is open ā read from the combobox's aria-expanded.
Returnsā
Promise<boolean>
Inherited fromā
AstryxComboboxDriver.isExpanded
isVisible()ā
isVisible():
Promise<boolean>
Defined in: 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ā
AstryxComboboxDriver.isVisible
open()ā
open():
Promise<void>
Defined in: component-driver-astryx/src/components/AstryxComboboxDriver.ts:30
Open the popup by clicking the combobox, if not already open, then wait for
aria-expanded to flip. The wait matters in the browser: click() resolves
once the event dispatches, but the listbox and its options mount on React's
subsequent render, so a read that races ahead would see an empty popup.
Returnsā
Promise<void>
Inherited fromā
pressKey()ā
pressKey(
key,option?):Promise<void>
Defined in: 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ā
runtimeCssSelector()ā
runtimeCssSelector():
Promise<string>
Defined in: 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ā
AstryxComboboxDriver.runtimeCssSelector
scrollIntoView()ā
scrollIntoView():
Promise<void>
Defined in: 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ā
AstryxComboboxDriver.scrollIntoView
typeText()ā
typeText(
text):Promise<void>
Defined in: 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ā
waitUntil()ā
waitUntil<
T>(option):Promise<T>
Defined in: core/dist/index.d.mts:1596
Type Parametersā
Tā
T
Parametersā
optionā
WaitUntilOption<T>
Returnsā
Promise<T>
Inherited fromā
AstryxComboboxDriver.waitUntil
waitUntilComponentState()ā
waitUntilComponentState(
option?):Promise<void>
Defined in: 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ā
AstryxComboboxDriver.waitUntilComponentState
waitUntilVisible()ā
waitUntilVisible(
timeoutMs?):Promise<void>
Defined in: 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ā
AstryxComboboxDriver.waitUntilVisible
within()ā
within<
ContentT>(parts):ScenePartDriver<ContentT>
Defined in: 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ā
overriddenParentLocator()ā
staticoverriddenParentLocator(_option?):Optional<PartLocator>
Defined in: 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ā
AstryxComboboxDriver.overriddenParentLocator
overrideLocatorRelativePosition()ā
staticoverrideLocatorRelativePosition(_option?):Optional<LocatorRelativePosition>
Defined in: 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ā
Protected members (26)
Propertiesā
optionIdSeparatorā
protectedreadonlyoptionIdSeparator:"option"='option'
Defined in: component-driver-astryx/src/components/TokenizerDriver.ts:22
The id-segment between the listbox id and the option index ('item' or 'option').
Overridesā
AstryxComboboxDriver.optionIdSeparator
Accessorsā
comboboxā
Get Signatureā
get
protectedcombobox():PartLocator
Defined in: component-driver-astryx/src/internal/IndexedOptionListDriver.ts:26
The role="combobox" control ā a <button> for the selectors, an <input> for the typeaheads/palette.
Returnsā
PartLocator
Inherited fromā
interiorLocatorā
Get Signatureā
get
protectedinteriorLocator():PartLocator
Defined in: 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ā
AstryxComboboxDriver.interiorLocator
Methodsā
activate()ā
protectedactivate():Promise<void>
Defined in: core/dist/index.d.mts:1522
Activate the component without relying on pointer geometry. See Interactor.activate.
Returnsā
Promise<void>
Inherited fromā
awaitPostcondition()ā
protectedawaitPostcondition(postcondition,probeFn,option?):Promise<void>
Defined in: 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ā
AstryxComboboxDriver.awaitPostcondition
contextMenu()ā
protectedcontextMenu():Promise<void>
Defined in: core/dist/index.d.mts:1518
Dispatch a right-click / contextmenu event on the component. See Interactor.contextMenu.
Returnsā
Promise<void>
Inherited fromā
AstryxComboboxDriver.contextMenu
drag()ā
protecteddrag(delta):Promise<void>
Defined in: 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ā
dragTo()ā
protecteddragTo(target):Promise<void>
Defined in: 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ā
enforcePartExistence()ā
protectedenforcePartExistence(partName):Promise<void>
Defined in: 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ā
AstryxComboboxDriver.enforcePartExistence
findOptionByLabel()ā
protectedfindOptionByLabel(label):Promise<Optional<PartLocator>>
Defined in: component-driver-astryx/src/internal/IndexedOptionListDriver.ts:50
The option locator whose visible text matches label, or undefined when absent.
Parametersā
labelā
string
Returnsā
Promise<Optional<PartLocator>>
Inherited fromā
AstryxComboboxDriver.findOptionByLabel
getBoundingRect()ā
protectedgetBoundingRect():Promise<BoundingRect>
Defined in: 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ā
AstryxComboboxDriver.getBoundingRect
getMissingPartNames()ā
protectedgetMissingPartNames(partName):Promise<readonlynever[]>
Defined in: 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ā
AstryxComboboxDriver.getMissingPartNames
innerHTML()ā
protectedinnerHTML():Promise<string>
Defined in: core/dist/index.d.mts:1635
Get the inner HTML of the component
Returnsā
Promise<string>
The inner HTML of the component
Inherited fromā
AstryxComboboxDriver.innerHTML
isOptionLabelSelected()ā
protectedisOptionLabelSelected(label):Promise<boolean>
Defined in: component-driver-astryx/src/internal/IndexedOptionListDriver.ts:72
Whether the option with the given label is selected (aria-selected="true"). false when absent.
Parametersā
labelā
string
Returnsā
Promise<boolean>
Inherited fromā
AstryxComboboxDriver.isOptionLabelSelected
mouseDown()ā
protectedmouseDown(option?):Promise<void>
Defined in: core/dist/index.d.mts:1495
Parametersā
option?ā
Partial<MouseDownOption>
Returnsā
Promise<void>
Inherited fromā
AstryxComboboxDriver.mouseDown
mouseEnter()ā
protectedmouseEnter(option?):Promise<void>
Defined in: core/dist/index.d.mts:1499
Parametersā
option?ā
Partial<MouseEnterOption>
Returnsā
Promise<void>
Inherited fromā
AstryxComboboxDriver.mouseEnter
mouseLeave()ā
protectedmouseLeave(option?):Promise<void>
Defined in: core/dist/index.d.mts:1500
Parametersā
option?ā
Partial<MouseLeaveOption>
Returnsā
Promise<void>
Inherited fromā
AstryxComboboxDriver.mouseLeave
mouseMove()ā
protectedmouseMove(option?):Promise<void>
Defined in: core/dist/index.d.mts:1494
Parametersā
option?ā
Partial<MouseMoveOption>
Returnsā
Promise<void>
Inherited fromā
AstryxComboboxDriver.mouseMove
mouseOut()ā
protectedmouseOut(option?):Promise<void>
Defined in: core/dist/index.d.mts:1498
Parametersā
option?ā
Partial<MouseOutOption>
Returnsā
Promise<void>
Inherited fromā
mouseOver()ā
protectedmouseOver(option?):Promise<void>
Defined in: core/dist/index.d.mts:1497
Parametersā
option?ā
Partial<HoverOption>
Returnsā
Promise<void>
Inherited fromā
AstryxComboboxDriver.mouseOver
mouseUp()ā
protectedmouseUp(option?):Promise<void>
Defined in: core/dist/index.d.mts:1496
Parametersā
option?ā
Partial<MouseUpOption>
Returnsā
Promise<void>
Inherited fromā
optionIdPrefix()ā
protectedoptionIdPrefix():Promise<Optional<string>>
Defined in: component-driver-astryx/src/internal/IndexedOptionListDriver.ts:31
The ${listboxId}-${separator}- id prefix shared by the open popup's options, or undefined when closed.
Returnsā
Promise<Optional<string>>
Inherited fromā
AstryxComboboxDriver.optionIdPrefix
optionLabels()ā
protectedoptionLabels():Promise<readonlystring[]>
Defined in: component-driver-astryx/src/internal/IndexedOptionListDriver.ts:60
The visible labels of the options currently in the open popup, in DOM order.
Returnsā
Promise<readonly string[]>
Inherited fromā
AstryxComboboxDriver.optionLabels
optionLocators()ā
protectedoptionLocators():Promise<PartLocator[]>
Defined in: component-driver-astryx/src/internal/IndexedOptionListDriver.ts:37
Every option locator in the open popup, in DOM order. Empty when closed.
Returnsā
Promise<PartLocator[]>
Inherited fromā
AstryxComboboxDriver.optionLocators
scrollBy()ā
protectedscrollBy(delta):Promise<void>
Defined in: 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ā
waitForOptions()ā
protectedwaitForOptions(timeoutMs?):Promise<void>
Defined in: component-driver-astryx/src/internal/IndexedOptionListDriver.ts:83
Wait until the open popup has at least one option, for the debounced/async result lists of the type-to-search members (Typeahead, Tokenizer, PowerSearch, CommandPalette). Resolves early once options appear; otherwise returns after the timeout (e.g. a query with no results), leaving the caller to read an empty list.
Parametersā
timeoutMs?ā
number = 2000
Returnsā
Promise<void>