Class: ContextMenuDriver
Defined in: packages/component-driver-primevue-v4/src/components/ContextMenuDriver.ts:62
Driver for the PrimeVue ContextMenu component, anchored at the TRIGGER —
the element the consumer wires a right-click handler onto — since the menu
surface itself doesn't exist in the DOM until opened (PrimeVue mounts it
only while visible, same as Menu's popup mode).
DOM audit (primevue@4.5.5): ContextMenu has no built-in trigger of its
own — the consumer wires @contextmenu="cm.show($event)" (or the global
prop) onto whatever region should open it — so unlike Menu's
data-pc-name="menu" popup, there is no scene-declared data-testid on
the ContextMenu component to anchor a portal re-root through; the driver
is constructed from the TRIGGER locator instead, and open dispatches
the contextMenu interactor primitive there. The mounted surface then
resolves document-rooted on PrimeVue's own data-pc-name="contextmenu"
marker. The top-level item list carries role="menubar" (not role="menu"
— verified empirically; nested submenu lists get role="menu", out of this
driver's v1 scope, see "Nested items" below), so itemListLocator
differs from MenuDriver's.
Single-open-menu scoping caveat: the surface locator is document-rooted
and generic ([data-pc-name="contextmenu"]) rather than instance-linked —
safe only while at most one ContextMenu is mounted at a time. PrimeVue
unmounts a closed ContextMenu, but separate ContextMenu instances don't
coordinate with each other (opening one doesn't close another that's
already open — verified empirically: an instance's outside-dismiss listener
only binds a click handler, which a contextmenu event never fires), so
a scene with two instances CAN end up with two surfaces mounted at once if
a caller opens the second without first closing the first. In that state,
item reads resolve against whichever surface the underlying querySelector
/ page.locator() matches first, not necessarily the intended instance —
so close one ContextMenuDriver before opening another when a scene
renders more than one (mirrors component-driver-radix-v1's
ContextMenuDriver, which documents the same limit for the same
structural reason).
Nested items (a model entry with its own items, rendered as a
role="menu" submenu on hover): out of scope for this driver — item reads
cover the top-level role="menubar" list only, the same one-level scope
MenuDriver has for Menu (which has no nested items at all). Deeper
submenu traversal is TieredMenu territory per #1036's scope note.
Extends​
Constructors​
Constructor​
new ContextMenuDriver(
triggerLocator,interactor,option?):ContextMenuDriver
Defined in: packages/component-driver-primevue-v4/src/components/ContextMenuDriver.ts:65
Parameters​
triggerLocator​
PartLocator
interactor​
Interactor
option?​
Partial<IComponentDriverOption<{ }>>
Returns​
ContextMenuDriver
Overrides​
MenuContentDriverBase.constructor
Accessors​
driverName​
Get Signature​
get driverName():
string
Defined in: packages/component-driver-primevue-v4/src/components/ContextMenuDriver.ts:126
Returns​
string
Overrides​
MenuContentDriverBase.driverName
Methods​
closeByEscape()​
closeByEscape(
timeoutMs?):Promise<boolean>
Defined in: packages/component-driver-primevue-v4/src/components/ContextMenuDriver.ts:99
Dismiss the menu by pressing Escape on the open item list, then wait for
it to close. There is no toggle path: right-clicking the trigger again
while open only repositions the menu, it doesn't close it.
Parameters​
timeoutMs?​
number = defaultTransitionDuration
Returns​
Promise<boolean>
isOpen()​
isOpen():
Promise<boolean>
Defined in: packages/component-driver-primevue-v4/src/components/ContextMenuDriver.ts:75
Whether the menu is open — PrimeVue mounts it only while open.
Returns​
Promise<boolean>
open()​
open():
Promise<void>
Defined in: packages/component-driver-primevue-v4/src/components/ContextMenuDriver.ts:90
Open the menu by dispatching a right-click (contextmenu) on the
trigger — unconditionally, never guarded by isOpen. isOpen
reads the document-rooted, non-instance-scoped surface locator (see the
class doc), so it can't tell "this instance is open" from "some other
ContextMenuDriver's menu is open"; guarding on it would silently no-op
a second instance's open() while a first instance's menu is still
showing. PrimeVue's own show() handles a redundant call safely
(repositions rather than re-opening), so dispatching every time is safe
for the same-instance case too.
Returns​
Promise<void>
waitForClose()​
waitForClose(
timeoutMs?):Promise<boolean>
Defined in: packages/component-driver-primevue-v4/src/components/ContextMenuDriver.ts:117
Wait for the menu to close (unmount).
Parameters​
timeoutMs?​
number = defaultTransitionDuration
Returns​
Promise<boolean>
waitForOpen()​
waitForOpen(
timeoutMs?):Promise<boolean>
Defined in: packages/component-driver-primevue-v4/src/components/ContextMenuDriver.ts:107
Wait for the menu to open (mount).
Parameters​
timeoutMs?​
number = defaultTransitionDuration
Returns​
Promise<boolean>
Inherited members (25)
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​
MenuContentDriverBase.commutableOption
interactor​
readonlyinteractor:Interactor
Defined in: packages/core/dist/index.d.mts:1346
Inherited from​
MenuContentDriverBase.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​
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​
Methods​
click()​
click(
option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1492
Parameters​
option?​
Partial<ClickOption>
Returns​
Promise<void>
Inherited from​
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​
focus()​
focus(
option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1501
Parameters​
option?​
Partial<FocusOption>
Returns​
Promise<void>
Inherited from​
getAttribute()​
getAttribute(
attributeName):Promise<Optional<string>>
Defined in: packages/core/dist/index.d.mts:1486
Parameters​
attributeName​
string
Returns​
Promise<Optional<string>>
Inherited from​
MenuContentDriverBase.getAttribute
getMenuItemByIndex()​
getMenuItemByIndex(
index):Promise<Optional<MenuItemDriver>>
Defined in: packages/component-driver-primevue-v4/src/components/MenuContentDriverBase.ts:68
The item at the given zero-based index (separators excluded), or undefined if out of range.
Parameters​
index​
number
Returns​
Promise<Optional<MenuItemDriver>>
Inherited from​
MenuContentDriverBase.getMenuItemByIndex
getMenuItemByLabel()​
getMenuItemByLabel(
label):Promise<Optional<MenuItemDriver>>
Defined in: packages/component-driver-primevue-v4/src/components/MenuContentDriverBase.ts:38
The item whose visible label matches label, or undefined when absent.
Parameters​
label​
string
Returns​
Promise<Optional<MenuItemDriver>>
Inherited from​
MenuContentDriverBase.getMenuItemByLabel
getMenuItemCount()​
getMenuItemCount():
Promise<number>
Defined in: packages/component-driver-primevue-v4/src/components/MenuContentDriverBase.ts:63
The number of items (role="menuitem") in the open surface, separators excluded.
Returns​
Promise<number>
Inherited from​
MenuContentDriverBase.getMenuItemCount
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​
hover()​
hover(
option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1493
Parameters​
option?​
Partial<HoverOption>
Returns​
Promise<void>
Inherited from​
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​
MenuContentDriverBase.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​
MenuContentDriverBase.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​
MenuContentDriverBase.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​
MenuContentDriverBase.scrollIntoView
selectByLabel()​
selectByLabel(
label):Promise<void>
Defined in: packages/component-driver-primevue-v4/src/components/MenuContentDriverBase.ts:53
Click the item whose visible label matches label.
Parameters​
label​
string
Returns​
Promise<void>
Throws​
when absent.
Inherited from​
MenuContentDriverBase.selectByLabel
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​
MenuContentDriverBase.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​
MenuContentDriverBase.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​
MenuContentDriverBase.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​
MenuContentDriverBase.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​
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​
MenuContentDriverBase.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​
Protected members (19)
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​
MenuContentDriverBase.interiorLocator
itemListLocator​
Get Signature​
get
protecteditemListLocator():PartLocator
Defined in: packages/component-driver-primevue-v4/src/components/ContextMenuDriver.ts:70
The element whose direct children are the role="menuitem"/role="separator" items.
Returns​
PartLocator
Overrides​
MenuContentDriverBase.itemListLocator
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​
MenuContentDriverBase.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​
MenuContentDriverBase.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​
MenuContentDriverBase.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​
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​
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​
MenuContentDriverBase.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​
MenuContentDriverBase.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​
MenuContentDriverBase.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​
MenuContentDriverBase.innerHTML
mouseDown()​
protectedmouseDown(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1495
Parameters​
option?​
Partial<MouseDownOption>
Returns​
Promise<void>
Inherited from​
MenuContentDriverBase.mouseDown
mouseEnter()​
protectedmouseEnter(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1499
Parameters​
option?​
Partial<MouseEnterOption>
Returns​
Promise<void>
Inherited from​
MenuContentDriverBase.mouseEnter
mouseLeave()​
protectedmouseLeave(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1500
Parameters​
option?​
Partial<MouseLeaveOption>
Returns​
Promise<void>
Inherited from​
MenuContentDriverBase.mouseLeave
mouseMove()​
protectedmouseMove(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1494
Parameters​
option?​
Partial<MouseMoveOption>
Returns​
Promise<void>
Inherited from​
MenuContentDriverBase.mouseMove
mouseOut()​
protectedmouseOut(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1498
Parameters​
option?​
Partial<MouseOutOption>
Returns​
Promise<void>
Inherited from​
MenuContentDriverBase.mouseOut
mouseOver()​
protectedmouseOver(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1497
Parameters​
option?​
Partial<HoverOption>
Returns​
Promise<void>
Inherited from​
MenuContentDriverBase.mouseOver
mouseUp()​
protectedmouseUp(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1496
Parameters​
option?​
Partial<MouseUpOption>
Returns​
Promise<void>
Inherited from​
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>