Class: SliderDriver
Defined in: packages/component-driver-fluent-v9/src/components/SliderDriver.ts:46
Driver for the Fluent v9 Slider component.
DOM audit (@fluentui/react-components@9.74.3): the data-testid/locator you
put on <Slider> forwards straight to a REAL native
<input class="fui-Slider__input" type="range"> — Fluent's own slot docs call
this the slider's PRIMARY slot ("all native properties specified directly on
<Slider> will be applied to this slot"), confirmed against the rendered DOM:
min/max/step/required/aria-label/value/disabled all land on it as
plain native attributes/properties, exactly HTMLRangeInputDriver's existing
contract — so this driver extends it wholesale (native getValue/setValue
via Interactor.getInputValue/setRangeValue, plus isDisabled, already
apply unchanged) and adds only what's Fluent-specific. The visible rail/thumb
render as separate SIBLING <div class="fui-Slider__rail">/
<div class="fui-Slider__thumb"> elements with no interactive semantics of
their own (no role, no tabindex — purely CSS-positioned off the input's
live value via a CSS custom property); the package's own type declarations
describe the thumb slot as "containing role='slider'", but the rendered DOM
has no such attribute anywhere — the accessible slider semantics come for
free from the native <input type="range">'s implicit ARIA mapping, not from
any div. role/aria-value* are therefore never read here (unlike the pure-
ARIA Radix/Astryx sliders, which have no native input to fall back on).
Fluent only stamps the min/max/step attributes when the matching prop is
explicitly passed — a <Slider> rendered with none of them has NEITHER
attribute in the DOM, even though Fluent's own documented defaults (min={0},
max={100}, step={1}) still govern the rendered/clamped value identically
(matching the native <input type="range"> spec's own defaults). getMin,
getMax, and getStep fall back to those same defaults instead of
surfacing NaN/null for an omitted prop that still has real, defined behavior.
Scope: single-thumb only — Fluent v9 ships no multi-thumb/range variant of
Slider (SliderProps.value/defaultValue is a single number, never an
array), so there is no multi-thumb gap to record here.
Extending HTMLRangeInputDriver also inherits its isReadonly(). Fluent's
Slider has no documented readOnly prop, and the native readonly
attribute has no defined effect on type="range" per the HTML spec (the same
restriction CheckboxDriver notes for type="checkbox"), so that method only
reflects an aria-readonly a caller sets directly — inherited, not a genuine
Fluent Slider capability.
Extends
HTMLRangeInputDriver
Implements
IRequirableDriver
Constructors
Constructor
new SliderDriver(
locator,interactor,option?):SliderDriver
Defined in: packages/component-driver-html/dist/index.d.mts:210
Parameters
locator
PartLocator
interactor
Interactor
option?
Partial<IComponentDriverOption<{ }>>
Returns
SliderDriver
Inherited from
HTMLRangeInputDriver.constructor
Accessors
driverName
Get Signature
get driverName():
string
Defined in: packages/component-driver-fluent-v9/src/components/SliderDriver.ts:96
Identifier for this driver.
Returns
string
Overrides
HTMLRangeInputDriver.driverName
Methods
getLabel()
getLabel():
Promise<Optional<string>>
Defined in: packages/component-driver-fluent-v9/src/components/SliderDriver.ts:87
The slider's accessible name, read from a directly-set aria-label on the
input, or undefined when none is present. Fluent's Slider has no label
prop of its own (unlike Checkbox/Radio/Switch) — a caller either sets
aria-label directly (what this reads) or wraps the slider in a Field,
whose own driver owns that label read instead.
Returns
Promise<Optional<string>>
getMax()
getMax():
Promise<number>
Defined in: packages/component-driver-fluent-v9/src/components/SliderDriver.ts:61
The maximum value of the slider (the input's native max attribute),
falling back to Fluent's documented default of 100 when the max prop
was never passed (see class doc).
Returns
Promise<number>
getMin()
getMin():
Promise<number>
Defined in: packages/component-driver-fluent-v9/src/components/SliderDriver.ts:52
The minimum value of the slider (the input's native min attribute),
falling back to Fluent's documented default of 0 when the min prop
was never passed (see class doc).
Returns
Promise<number>
getStep()
getStep():
Promise<number>
Defined in: packages/component-driver-fluent-v9/src/components/SliderDriver.ts:71
The slider's step increment (the input's native step attribute), falling
back to Fluent's documented default of 1 when the step prop was never
passed (see class doc). Fluent's step has no "unset"/free-movement variant
(unlike some other design systems' sliders), so this never returns null.
Returns
Promise<number>
isRequired()
isRequired():
Promise<boolean>
Defined in: packages/component-driver-fluent-v9/src/components/SliderDriver.ts:76
Whether the slider is marked required (native required attribute).
Returns
Promise<boolean>
Implementation of
IRequirableDriver.isRequired
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
HTMLRangeInputDriver.commutableOption
interactor
readonlyinteractor:Interactor
Defined in: packages/core/dist/index.d.mts:1346
Inherited from
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.exists
focus()
focus(
option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1501
Parameters
option?
Partial<FocusOption>
Returns
Promise<void>
Inherited from
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.getText
getValue()
getValue():
Promise<number>
Defined in: packages/component-driver-html/dist/index.d.mts:223
Read the current value of the range input.
Throws ElementNotFoundError when the element is absent, rather than
reporting absence in the return value. A range's value is a number, which has
no spare inhabitant for "nothing found" — the sibling drivers can say
Nullable<string> because null is a legitimate form value for them, whereas
this read previously returned Number.parseFloat('') — NaN — so every
comparison against a missing slider was silently false. See ADR-006 §7.
Returns
Promise<number>
Throws
If the range input is not found.
Inherited from
HTMLRangeInputDriver.getValue
hover()
hover(
option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1493
Parameters
option?
Partial<HoverOption>
Returns
Promise<void>
Inherited from
HTMLRangeInputDriver.hover
isDisabled()
isDisabled():
Promise<boolean>
Defined in: packages/component-driver-html/dist/index.d.mts:233
Check whether the range input is disabled.
Returns
Promise<boolean>
Inherited from
HTMLRangeInputDriver.isDisabled
isReadonly()
isReadonly():
Promise<boolean>
Defined in: packages/component-driver-html/dist/index.d.mts:237
Check whether the range input is read only.
Returns
Promise<boolean>
Inherited from
HTMLRangeInputDriver.isReadonly
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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.scrollIntoView
setValue()
setValue(
value):Promise<boolean>
Defined in: packages/component-driver-html/dist/index.d.mts:229
Set the value of the range input. The browser snaps an off-step target to the nearest valid step; jsdom stores it verbatim. Pass a step-aligned value for assertions that must hold in both environments.
Parameters
value
number
Returns
Promise<boolean>
Inherited from
HTMLRangeInputDriver.setValue
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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.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
HTMLRangeInputDriver.innerHTML
mouseDown()
protectedmouseDown(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1495
Parameters
option?
Partial<MouseDownOption>
Returns
Promise<void>
Inherited from
HTMLRangeInputDriver.mouseDown
mouseEnter()
protectedmouseEnter(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1499
Parameters
option?
Partial<MouseEnterOption>
Returns
Promise<void>
Inherited from
HTMLRangeInputDriver.mouseEnter
mouseLeave()
protectedmouseLeave(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1500
Parameters
option?
Partial<MouseLeaveOption>
Returns
Promise<void>
Inherited from
HTMLRangeInputDriver.mouseLeave
mouseMove()
protectedmouseMove(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1494
Parameters
option?
Partial<MouseMoveOption>
Returns
Promise<void>
Inherited from
HTMLRangeInputDriver.mouseMove
mouseOut()
protectedmouseOut(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1498
Parameters
option?
Partial<MouseOutOption>
Returns
Promise<void>
Inherited from
HTMLRangeInputDriver.mouseOut
mouseOver()
protectedmouseOver(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1497
Parameters
option?
Partial<HoverOption>
Returns
Promise<void>
Inherited from
HTMLRangeInputDriver.mouseOver
mouseUp()
protectedmouseUp(option?):Promise<void>
Defined in: packages/core/dist/index.d.mts:1496
Parameters
option?
Partial<MouseUpOption>
Returns
Promise<void>
Inherited from
HTMLRangeInputDriver.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
HTMLRangeInputDriver.scrollBy