Version: 5.x

vm-settings-control

A control for toggling the visiblity of the settings menu. This control is not displayed if no settings (vime-settings) has been provided for the current player.

Visual#

Vime settings control component

Usage#

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

Properties#

PropertyDescriptionTypeDefault
expandedWhether the settings menu this control manages is open.booleanfalse
iconThe name of the settings icon to resolve from the icon library.string'settings'
iconsThe name of an icon library to use. Defaults to the library defined by the icons player property.string ∣ undefinedundefined
menuThe DOM id of the settings menu this control is responsible for opening/closing.string ∣ undefinedundefined
tooltipDirectionThe direction in which the tooltip should grow."left" ∣ "right" ∣ undefinedundefined
tooltipPositionWhether the tooltip is positioned above/below the control."bottom" ∣ "top"'top'

Methods#

MethodDescriptionSignature
blurControlRemoves focus from the control.blurControl() => Promise<void>
focusControlFocuses the control.focusControl() => Promise<void>

Dependencies#

Used by#

Depends on#