...
| property | type | default value | restricted values | description | example |
|---|---|---|---|---|---|
| displayName | string | Text that will be displayed in the menu item. | "My Menu Item" | ||
| appId | string | "" | Used to identify the menu-item and highlighting. | "myMenuItem" | |
| action | string | "" | The action to take when the user has clicked on the menu item. This string will be ran as JavaScript. | "window.app.ObtainMenu('su', '{{targetRef}}', 'myMenu', "+ setttingsDict.toAxonCode+")""window.app.LoadApplication('someUriPath')"finstack.eval('myForm()')" | |
| icon | string | "" | Icon that will appear to the left of the displayName. | "icon-battery-full" | |
| iconType | string | "class" | Type of icon. This will typically be "class". | "class" | |
| iconClass | string | "" | |||
| rightIcon | string | "" | Icon that will appear to the right of the displayName, between the displayName and badge. | "icon-battery-full" | |
| rightIconType | string | "class" | Type of icon. | "class" | |
| rightIconTooltip | string | "" | Tooltip that will appear when the mouse cursor hovers over the icon. | "This is an icon." | |
| hasBadge | bool | false | <true|false> | Adds a badge to the right of the displayName | true |
| badgeValue | string or int | "" | The value that will be displayed within the badge. Can be a number or a string. | "In fault" or 10 | |
| badgeType | string | "normal" | "<normal|error|success|focus>" | Adds color to the badge. Normal is no color, error is red, success is green, focus is blue. | "normal" |
| badgeTooltip | string | "" | Tooltip that will appear when the mouse cursor hovers over the badge. | "This is a badge." | |
| keepOpen | bool | false | <true|false> | Keeps the right-side menu open after clicking on menu item. | |
| classes | string | "" | "<mobile-hidden|tablet-hidden|desktop-hidden>" | Hides a menu item on certain devices. Based after pixel length. NOTE: "tablet-hidden" hides on tablet screens and larger. | "mobile-hidden" |
level | int | 0 | The level of indentation of a menu item. | ||
| order | int | 99 | The order in which menu-items are sorted before being sorted alphabetically. On the main menu: The "End User Apps" divider is -1000, the "System Integrator Apps" divider is 10, the "Advanced Apps" is 9990. In all menu's that include the pre-defined back button, the main divider is set to -1000 and the back button to -1100. | ||
| isDivider | bool | false | <true|false> | If set to true, the menu item will be rendered as a divider. In this case only a displayName is required. | |
| ignoreSettings | marker | null | no value | If this tag is present, the menu items will not be apply the passed settings to the menu item. (See settings properties below) | |
| submenu | JSON formatted string | "" | A dict with 2 properties: startOpen: <true|false> items: List of dicts where each dict is a submenu-item. | Adds a sliding feature that houses a submenu. In axon, This will be a dict that is run through the toJSON() function. NOTE: On desktops this can fit up to 4 sub-menu items before closing the slider becomes difficult. On smaller devices such as phones, 3 is the max. | { |
| progressBar | JSON formatted string | "" | A list of dics. | Adds a bar that is filled based of a percentage. In axon this will be a list of dicts that is ran through the toJSON() function. | [{percent:48, label: "Amount Used" }].toJSON() |
| body | string | "" | string | The contents of the string get added into the menu item as embedded HTML. NOTE: This requires that the ignoreSettings tag is on the menu item. | "<p>This is a paragraph with an image <img src=\"image.png\"></p>" |
...