AppMenu
All you need to display and receive user commands from the webOS app menu.
Classes
AppMenu.CommandEvent
An instance of this class is sent to listeners of the mojo-app-menu-command
event.
Class Methods
AppMenu.setup
AppMenu.setup(config) -> undefined
- config (Object) – An object containing the configuration for the App menu.
This function configures the app menu for your application. It takes a configuration that is very similar to the standard Mojo app menu widget.
config
may contain any of the following:
-
omitDefaultItems (Boolean): Whether to include the default app menu items or not.
-
richTextEditItems (Boolean): Whether to include rich text editing options (such as bold, italic, etc.)
-
items (Array): An array of items objects to include in the app menu. Objects in this array may contain the following:
-
label (String): What text to put in the menu.
-
command (String): The string that is placed in the
AppMenu.CommandEvent
event. -
[disabled (Boolean = false)]: Enable or disable this menu item.
-
[icon (String)]: A CSS class that will apply an icon.
-
[iconPath (String)]: A path to an icon to insert into the menu item.
-
[width (Number)]: A width that will override the default.
-
[items: (Array)]: Submenu items, properties are identical to this items array.
-
[toggleCmd (String)]: Only used when
items
is specified. Specify this property to make this group a "toggle group". This string is thecommand
of currently selected 'choice' item. -
[template (String)]: Path to HTML template for rendering custom content to be inserted instead of the standard menu item. Must be absolute.
-