Version: 5.x

vm-volume-control

A control for adjusting the volume of the player and toggling the muted state.

Visual#

Vime volume control component

Usage#

<vm-player>
<!-- ... -->
<vm-ui>
<!-- ... -->
<vm-controls>
<!-- ... -->
<vm-volume-control></vm-volume-control>
</vm-controls>
</vm-ui>
</vm-player>

Properties#

PropertyDescriptionTypeDefault
hideTooltipWhether the tooltip should be hidden.booleanfalse
highVolumeIconThe name of the high volume icon to resolve from the icon library.string'volume-high'
iconsThe name of an icon library to use. Defaults to the library defined by the icons player property.string ∣ undefinedundefined
lowVolumeIconThe name of the low volume icon to resolve from the icon library.string'volume-low'
muteKeysA pipe (/) separated string of JS keyboard keys, that when caught in a keydown event, will toggle the muted state of the player.string ∣ undefined'm'
mutedIconThe name of the muted volume icon to resolve from the icon library.string'volume-mute'
noKeyboardPrevents the volume being changed using the Up/Down arrow keys.booleanfalse
tooltipDirectionThe direction in which the tooltip should grow."left" ∣ "right" ∣ undefinedundefined
tooltipPositionWhether the tooltip is positioned above/below the control."bottom" ∣ "top"'top'

Dependencies#

Used by#

Depends on#