IMediaVolumeControlProps

interface
Component Props

Props for <OrigamMediaVolumeControl> — the mute/unmute button and the YouTube-style vertical scrubber tooltip. Owns the off/low/medium/high icon swap and the resolvedVolume collapse when muted. Does not own the media-side mutations.

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.

volume
required
number
Linear volume in [0, 1]. Typically state.volume.value. Required.
muted
required
boolean
Whether the media is muted. When true, the slider collapses to 0 (resolvedVolume rule) and the icon becomes VOLUME_OFF. Required.
muteLabel
required
string
aria-label rendered on the toggle button when the media is NOT muted (clicking will mute). Already-translated. Required.
unmuteLabel
required
string
aria-label rendered on the toggle button when the media IS muted (clicking will unmute). Already-translated. Required.
volumeLabel
required
string
aria-label rendered on the vertical scrubber inside the tooltip. Already-translated. Required.
dataCy
string
'origam-media-volume-control'
Optional data-cy prefix used on the toggle button. The tooltip wrapper and scrubber expose their own selectors via convention.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Volume control wired to media state

vue