IMediaScrubberProps

interface
Component Props

Props for <OrigamMediaScrubber> — a headless, media-agnostic value-on-a-track widget. Stateless: the parent controls modelValue and listens to update:modelValue, change, drag*, and hover events. Used for the timeline and the volume slider.

TypeScript

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

Héritage

Hérite de

Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

modelValue
requis
number
Current value between min and max. Supports v-model. The component never mutates this directly.
min
number
0
Lower bound of the value range.
max
requis
number
Upper bound of the value range. Required to compute thumb position. Passing 0 or a value <= min freezes the scrubber at the start.
step
number
0
Discrete step. 0 means continuous (pointer events emit the raw float); positive values snap each emission to the nearest multiple.
buffered
number
Optional buffered position (end of the browser media buffer). Renders the __buffer bar from min up to buffered. Pass undefined to hide the bar.
orientation
TMediaScrubberOrientation
'horizontal'
Layout axis. 'horizontal' = YouTube timeline shape, 'vertical' = volume / level meter shape (top = max, bottom = min).
disabled
boolean
false
Disables pointer + keyboard interaction. The element drops out of the tab order and pointer events become no-ops.
showThumbOnHoverOnly
boolean
false
Hides the thumb at rest and reveals it on hover / focus / drag — the YouTube pattern.
showHoverTooltip
boolean
false
Shows a tooltip above the cursor (horizontal only) reflecting the hovered value. Content can be overridden via the #tooltip slot.
formatHoverTooltip
(value: number) => string
Formatter for the default hover tooltip label. Receives the hovered value and returns the string to render.
ariaLabel
string
Required accessibility label — read by screen readers when the scrubber gains focus. Always pass a translated string.
ariaValueText
string
Optional human-readable representation of the current value (e.g. "1:23" for a timestamp, "45 %" for a volume). Mapped to aria-valuetext.
dataCy
string

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Video timeline scrubber with buffer display

vue