IMediaVolumeControlProps
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
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.
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.
- volumerequisnumber
- Linear volume in [0, 1]. Typically state.volume.value. Required.
- mutedrequisboolean
- Whether the media is muted. When true, the slider collapses to 0 (resolvedVolume rule) and the icon becomes VOLUME_OFF. Required.
- muteLabelrequisstring
- aria-label rendered on the toggle button when the media is NOT muted (clicking will mute). Already-translated. Required.
- unmuteLabelrequisstring
- aria-label rendered on the toggle button when the media IS muted (clicking will unmute). Already-translated. Required.
- volumeLabelrequisstring
- aria-label rendered on the vertical scrubber inside the tooltip. Already-translated. Required.
- dataCystring'origam-media-volume-control'
- Optional data-cy prefix used on the toggle button. The tooltip wrapper and scrubber expose their own selectors via convention.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Volume control wired to media state