Skip to main content
Version: 5.x

vm-menu-radio

Menu radio buttons are presented in radio groups (a collection of radio buttons describing a set of related options). Only one radio button in a group can be selected at the same time.

Visual#

Vime settings menu radio component

Usage#

<vm-player>  <!-- ... -->  <vm-ui>    <!-- ... -->    <vm-settings>      <vm-submenu label="Playback Rate">        <vm-menu-radio-group value="1">          <vm-menu-radio label="0.5" value="0.5" />          <vm-menu-radio label="Normal" value="1" />          <vm-menu-radio label="2" value="2" />        </vm-menu-radio-group>      </vm-submenu>    </vm-settings>  </vm-ui></vm-player>

Properties#

PropertyDescriptionTypeDefault
badgeThis can provide additional context about the value. For example, if the option is for a set of video qualities, the badge could describe whether the quality is UHD, HD etc.string ∣ undefinedundefined
checkIconThe URL to an SVG element or fragment to load.string ∣ undefined'check'
checkedWhether the radio item is selected or not.booleanfalse
iconsThe name of an icon library to use. Defaults to the library defined by the icons player property.string ∣ undefinedundefined
label (required)The title of the radio item displayed to the user.stringundefined
value (required)The value associated with this radio item.stringundefined

Events#

EventDescriptionType
vmCheckEmitted when the radio button is selected.CustomEvent<void>

Dependencies#

Used by#

Depends on#