Version: 5.x

vm-mute-control

A control for toggling whether there is audio output or not. In other words the muted state of the player.

Visual#

Vime mute control component

Usage#

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

Properties#

PropertyDescriptionTypeDefault
hideTooltipWhether the tooltip should not be displayed.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
keysA slash (/) separated string of JS keyboard keys (KeyboardEvent.key), that when caught in a keydown event, will trigger a click event on the control.string ∣ undefined'm'
lowVolumeIconThe name of the low volume icon to resolve from the icon library.string'volume-low'
mutedIconThe name of the muted volume icon to resolve from the icon library.string'volume-mute'
tooltipDirectionThe direction in which the tooltip should grow."left" ∣ "right" ∣ undefinedundefined
tooltipPositionWhether the tooltip is positioned above/below the control."bottom" ∣ "top"'top'

Events#

EventDescriptionType
vmBlurEmitted when the control loses focus.CustomEvent<void>
vmFocusEmitted when the control receives focus.CustomEvent<void>

Dependencies#

Used by#

Depends on#