ISliderFieldProps

interface
Component Props

Full props contract for <OrigamSliderField> — a range input with three visual variants (field, timer, audio), optional waveform peaks, range mode, tick marks, hover tooltip, and the full design surface.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

disabled
boolean
Disables the slider — prevents interaction and applies a disabled visual state.
required
boolean
Marks the field as required (validation semantic).
label
string
Field label rendered by the wrapping OrigamInput chrome (variant="field" only).
error
boolean
Forces the danger intent on both color channels — drives the error visual state.
readonly
boolean
Makes the slider non-interactive while keeping it visually enabled.
max
number | string
Maximum value of the range. Forwarded to the underlying <input type="range">.
min
number | string
Minimum value of the range.
step
number | string
Step increment for snapping.
trackProps
ISliderFieldTrackProps
Visual props forwarded to the track sub-component (color, size, rounded, ticks).
reverse
boolean
Reverses the start direction of the fill.
modelValue
number | string | Array<number> | Array<string>
Bound value (v-model). Array for range mode.
range
boolean
Enables two-thumb range mode — modelValue must be an array of two values.
showTicks
TAlways
Controls tick mark visibility.
ticks
Array<number> | Record<string, string>
Custom tick positions and optional labels.
tickSize
TSize | number
Size of tick dot markers.
inset
boolean
Compact inset style — the draggable thumb sits inside the track. Defaults to false.
variant
TSliderFieldVariant
Visual variant: "field" (default, with input chrome), "timer" (bare rail, hidden thumb), "audio" (timer + waveform peaks).
buffered
number
Secondary fill from min to buffered (e.g. loaded video buffer). Layered behind active fill at reduced opacity.
showThumbOnHoverOnly
boolean
Hides the thumb at rest and reveals it on hover/focus/drag. Forced on for timer and audio variants.
showHoverTooltip
boolean
Renders a floating tooltip above the rail showing the value under the cursor.
formatHoverTooltip
(value: number) => string
Formatter for the hover tooltip text. Receives the clamped cursor value.
peaks
ReadonlyArray<number>
Waveform peaks in [0, 1]. Used with variant="audio" to paint vertical bars behind the track.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Audio waveform scrubber

vue