Skip to main content
Version: 4.x

vime-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#

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

Properties#

PropertyAttributeDescriptionTypeDefault
badgebadgeThis 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
checkedcheckedWhether the radio item is selected or not.booleanfalse
checkedIconchecked-iconThe URL to an SVG element or fragment to load.string ∣ undefined'#vime-checkmark'
label (required)labelThe title of the radio item displayed to the user.stringundefined
value (required)valueThe value associated with this radio item.stringundefined

Events#

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

Dependencies#

Used by#

Depends on#

Graph#

graph TD;  vime-menu-radio --> vime-menu-item  vime-menu-item --> vime-icon  vime-default-settings --> vime-menu-radio  style vime-menu-radio fill:#f9f,stroke:#333,stroke-width:4px

Built with StencilJS