Menu
This component displays a list of choices on temporary surfaces. |  |
Public Variables (Properties)
[?]
The Menu component has the following basic properties and property groups that are common to all components:
Name, Advanced Properties, Container Properties, Styles, Preloader, Events, Bindings.
Toggle Collapsed Menu
If enabled, submenus in Inline menu mode will open horizontally, not vertically.
Variable Name: | inlineCollapsed |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
inlineCollapsed | Boolean | Toggle Collapsed Menu |
Inline Collapsed Menu Width
Defines maximum width of the collapsed menu items in Inline menu mode.
Variable Name: | toggledMenuWidth |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
toggledMenuWidth | Integer | Inline Collapsed Menu Width |
Menu Items
This property defines hierarchy and visual representation of menu items.
Variable Name: | menuItems |
Records: | 0..unlimited |
Record Format:
Field Name | Field Type | Field Description |
image | Data Block | Image. The image for the menu item icon. |
key | String | Key. Unique key of the menu item. |
value | String | Value. Displayed name of the menu item. |
disabled | String | Disabled. Disables particular menu item. Disabled items are rendered as grayed-out and cannot be selected. |
parent | String | Parent Key. The key of the parent menu item. |
Selected Items
This property defines keys of menu items which will be displayed in the selected state.
Variable Name: | selectedKeys |
Records: | 0..unlimited |
Record Format:
Field Name | Field Type | Field Description |
key | String | Key |
Expanded Items
This property defines keys of menu items which will be displayed in the expanded state.
Variable Name: | openKeys |
Records: | 0..unlimited |
Record Format:
Field Name | Field Type | Field Description |
key | String | Key |
Menu Mode
Defines the menu's display mode:
Vertical
Horizontal
Inline
Variable Name: | mode |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
mode | String | Menu Mode |
Multiple Selection
If enabled, allows multiple menu items selection.
Variable Name: | multiple |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
multiple | Boolean | Multiple Selection |
Menu Theme
Defines pre-configured visual style of the menu, one of the following:
Light
Dark
Variable Name: | theme |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
theme | String | Menu Theme |
Submenu Open Delay on Hover
Defines the delay before the collapsed menu will be opened when the mouse cursor has hovered on corresponding menu item.
Variable Name: | subMenuOpenDelay |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
subMenuOpenDelay | Long | Submenu Open Delay on Hover |
Submenu Close Delay on Hover
Defines the delay before the collapsed menu will be closed when mouse hover is lost.
Variable Name: | subMenuCloseDelay |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
subMenuCloseDelay | Long | Submenu Close Delay on Hover |
Selectable
If enabled, allows selecting menu items using checkboxes.
Variable Name: | selectable |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
selectable | Boolean | Selectable |
Submenu Trigger
Defines default action to open collapsed menu item. This property has two selection values:
Click
Hover
Variable Name: | triggerSubMenuAction |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
triggerSubMenuAction | String | Submenu Trigger |
Overflow Threshold
Defines maximum count to display on menu item badge. If the badge has value bigger than specified in this property, count will be displayed as the Overflow Threshold field's value with plus symbol, e.g. "10+".
Variable Name: | overflowCount |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
overflowCount | Integer | Overflow Threshold |
Offset X
Defines horizontal offset of menu item badge, in pixels.
Variable Name: | offsetX |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
offsetX | Integer | Offset X |
Offset Y
Defines vertical offset of menu item badge, in pixels.
Variable Name: | syncTime |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
syncTime | Integer | Offset Y |
Show Zero
If enabled, zero values also will be displayed on the badges.
Variable Name: | showZero |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
showZero | Boolean | Show Zero |
Custom Badges
This property allows to define custom badges displaying on corresponding menu items.
Variable Name: | menuCustomBadges |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
key | String | Key. Unique ID of the badge. |
color | String | Color. The badge color. |
count | Integer | Count. The numeric value to display on the badge. |
dot | Boolean | Dot. If enabled, replaces the badge to small static dot. |
status | String | Status. If selected, replaces the badge to small dot which can be displayed with set of statuses. This property has several selection values:
Take note, dot field must be disabled to use this property. |
statusText | String | Status Text. Defines the text displaying right from the dot. |
tooltipText | String | Count Tooltip Text. Defines the badge tooltip text. |
Public Events
[?]
Custom Events
No custom events.
Was this page helpful?