vime-submenu

A menu that is to be nested inside another menu. A submenu is closed by default and it provides a menu item that will open/close it. It's main purpose is to organize a menu by grouping related sections/options together that can be navigated to by the user.

Visual

Vime submenu component

Usage

<vime-player>
<!-- ... -->
<vime-ui>
<!-- ... -->
<vime-settings>
<vime-submenu label="Title">
<!-- ... -->
</vime-submenu>
</vime-settings>
</vime-ui>
</vime-player>

Properties

PropertyAttributeDescriptionTypeDefault
activeactiveWhether the submenu is open/closed.booleanfalse
hiddenhiddenWhether the submenu should be displayed or not.booleanfalse
hinthintThis can provide additional context about the current state of the submenu. For example, the hint could be the currently selected option if the submenu contains a radio group.string โˆฃ undefinedundefined
label (required)labelThe title of the submenu.stringundefined

Slots

SlotDescription
Used to pass in the body of the submenu which is usually a set of choices in the form of a radio group (vime-menu-radio-group).

Dependencies

Used by

Depends on

Graph

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

Built with StencilJS