Class: CodeBlockDriver
Defined in: component-driver-astryx/src/components/CodeBlockDriver.ts:23
Driver for the Astryx CodeBlock (@astryxdesign/core/CodeBlock).
CodeBlock renders a <pre data-language> root (carrying data-testid) around a
<code> whose lines are <div data-line="N">. A header row appears when the
block has a language label or is collapsible; the collapsible header is a
<div role="button" aria-expanded> toggle, and a copy <button aria-label="Copy code"> flips to "Copied" after use. The driver reads the language off the
root, the source off <code>, and counts lines via the data-line markers.
The copied state is clipboard-driven and only flips in a real browser, so it is intentionally NOT exposed here (E2E/clipboard-only).
Extends​
ComponentDriver<{ }>
Constructors​
Constructor​
new CodeBlockDriver(
locator,interactor,option?):CodeBlockDriver
Defined in: core/dist/index.d.mts:1015
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. See the type-level fixture in
@atomic-testing/component-driver-html.
Returns​
CodeBlockDriver
Inherited from​
ComponentDriver<{}>.constructor
Properties​
commutableOption​
readonlycommutableOption:IComponentDriverOption<{ }>
Defined in: core/dist/index.d.mts:999
Option passed to the constructor includes both universal options which can be shared across all component driver tree, and component specific options which are only applicable to the component.
Commutable option is the option that can be shared across all component driver tree.
Inherited from​
ComponentDriver.commutableOption
interactor​
readonlyinteractor:Interactor
Defined in: core/dist/index.d.mts:990
Inherited from​
ComponentDriver.interactor
Accessors​
driverName​
Get Signature​
get driverName():
string
Defined in: component-driver-astryx/src/components/CodeBlockDriver.ts:79
Returns​
string
Overrides​
ComponentDriver.driverName
locator​
Get Signature​
get locator():
PartLocator
Defined in: core/dist/index.d.mts:1044
Return the locator of the component
Returns​
PartLocator
Inherited from​
ComponentDriver.locator
parts​
Get Signature​
get parts():
ScenePartDriver<T>
Defined in: core/dist/index.d.mts:1040
Return driver instance of all the named parts
Returns​
ScenePartDriver<T>
Inherited from​
ComponentDriver.parts
Methods​
activate()​
activate():
Promise<void>
Defined in: core/dist/index.d.mts:1091
Activate the component without relying on pointer geometry. See Interactor.activate.
Returns​
Promise<void>
Inherited from​
ComponentDriver.activate
click()​
click(
option?):Promise<void>
Defined in: core/dist/index.d.mts:1068
Parameters​
option?​
Partial<ClickOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.click
contextMenu()​
contextMenu():
Promise<void>
Defined in: core/dist/index.d.mts:1087
Dispatch a right-click / contextmenu event on the component. See Interactor.contextMenu.
Returns​
Promise<void>
Inherited from​
ComponentDriver.contextMenu
drag()​
drag(
delta):Promise<void>
Defined in: core/dist/index.d.mts:1129
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()​
dragTo(
target):Promise<void>
Defined in: core/dist/index.d.mts:1118
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: core/dist/index.d.mts:1050
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
exists()​
exists():
Promise<boolean>
Defined in: core/dist/index.d.mts:1067
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: core/dist/index.d.mts:1077
Parameters​
option?​
Partial<FocusOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.focus
getAttribute()​
getAttribute(
attributeName):Promise<Optional<string>>
Defined in: core/dist/index.d.mts:1062
Parameters​
attributeName​
string
Returns​
Promise<Optional<string>>
Inherited from​
ComponentDriver.getAttribute
getBoundingRect()​
getBoundingRect():
Promise<BoundingRect>
Defined in: core/dist/index.d.mts:1136
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
getCode()​
getCode():
Promise<Optional<string>>
Defined in: component-driver-astryx/src/components/CodeBlockDriver.ts:40
The full source text.
Returns​
Promise<Optional<string>>
getLanguage()​
getLanguage():
Promise<Optional<string>>
Defined in: component-driver-astryx/src/components/CodeBlockDriver.ts:35
The source language from the root's data-language (e.g. "javascript").
Returns​
Promise<Optional<string>>
getLineCount()​
getLineCount():
Promise<number>
Defined in: component-driver-astryx/src/components/CodeBlockDriver.ts:56
Number of code lines (<div data-line> markers).
Above LINE_CHUNK_THRESHOLD (100) lines, Astryx wraps every chunk of lines in
an intermediate <div>, so the data-line markers are no longer flat children
of <code> — a tag-based :nth-of-type walk stops at the first chunk boundary.
The count therefore uses childListHelper's :nth-child walk with a '*' group
selector, which descends through the chunk wrappers (and reads the flat case too).
Returns​
Promise<number>
getMissingPartNames()​
protectedgetMissingPartNames(partName):Promise<readonlynever[]>
Defined in: core/dist/index.d.mts:1056
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
getText()​
getText():
Promise<Optional<string>>
Defined in: core/dist/index.d.mts:1061
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: core/dist/index.d.mts:1069
Parameters​
option?​
Partial<HoverOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.hover
innerHTML()​
innerHTML():
Promise<string>
Defined in: core/dist/index.d.mts:1168
Get the inner HTML of the component
Returns​
Promise<string>
The inner HTML of the component
Inherited from​
ComponentDriver.innerHTML
isCollapsed()​
isCollapsed():
Promise<boolean>
Defined in: component-driver-astryx/src/components/CodeBlockDriver.ts:65
Whether the block is currently collapsed — true only when a collapsible
header is present and its aria-expanded is "false". A non-collapsible
block has no toggle and reports false.
Returns​
Promise<boolean>
isVisible()​
isVisible():
Promise<boolean>
Defined in: core/dist/index.d.mts:1145
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
mouseDown()​
mouseDown(
option?):Promise<void>
Defined in: core/dist/index.d.mts:1071
Parameters​
option?​
Partial<MouseDownOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseDown
mouseEnter()​
mouseEnter(
option?):Promise<void>
Defined in: core/dist/index.d.mts:1075
Parameters​
option?​
Partial<MouseEnterOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseEnter
mouseLeave()​
mouseLeave(
option?):Promise<void>
Defined in: core/dist/index.d.mts:1076
Parameters​
option?​
Partial<MouseLeaveOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseLeave
mouseMove()​
mouseMove(
option?):Promise<void>
Defined in: core/dist/index.d.mts:1070
Parameters​
option?​
Partial<MouseMoveOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseMove
mouseOut()​
mouseOut(
option?):Promise<void>
Defined in: core/dist/index.d.mts:1074
Parameters​
option?​
Partial<MouseOutOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseOut
mouseOver()​
mouseOver(
option?):Promise<void>
Defined in: core/dist/index.d.mts:1073
Parameters​
option?​
Partial<HoverOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseOver
mouseUp()​
mouseUp(
option?):Promise<void>
Defined in: core/dist/index.d.mts:1072
Parameters​
option?​
Partial<MouseUpOption>
Returns​
Promise<void>
Inherited from​
ComponentDriver.mouseUp
pressKey()​
pressKey(
key,option?):Promise<void>
Defined in: core/dist/index.d.mts:1083
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: core/dist/index.d.mts:1174
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
scrollBy()​
scrollBy(
delta):Promise<void>
Defined in: core/dist/index.d.mts:1107
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
scrollIntoView()​
scrollIntoView():
Promise<void>
Defined in: core/dist/index.d.mts:1098
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
toggleCollapse()​
toggleCollapse():
Promise<void>
Defined in: component-driver-astryx/src/components/CodeBlockDriver.ts:73
Toggle the collapsible header (expand/collapse). No-op when the block is not collapsible.
Returns​
Promise<void>
waitUntil()​
waitUntil<
T>(option):Promise<T>
Defined in: core/dist/index.d.mts:1163
Type Parameters​
T​
T
Parameters​
option​
WaitUntilOption<T>
Returns​
Promise<T>
Inherited from​
ComponentDriver.waitUntil
waitUntilComponentState()​
waitUntilComponentState(
option?):Promise<void>
Defined in: core/dist/index.d.mts:1162
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: core/dist/index.d.mts:1150
Wait until the component is attached and becomes visible to the DOM.
Parameters​
timeoutMs?​
number
The number of milliseconds to wait before timing out
Returns​
Promise<void>
Inherited from​
ComponentDriver.waitUntilVisible
overriddenParentLocator()​
staticoverriddenParentLocator():Optional<PartLocator>
Defined in: core/dist/index.d.mts:1026
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: core/dist/index.d.mts:1036
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