Menus

The menu section allows you configure your application routes and to which structure those routes should point to, also provides extra configuration data which will be used to render a main application menu properly.

Fields

A menu contains the following fields to be defined:

Path

The route path to render linked menu structure;

Requirements Rules:

Is Required;
Must be a valid url part (Only letters, numbers, underline (_) and trace (-));
Max length of 50 chars;
Must be unique in Ui

Example:

1 2	`Menus: - Path: my_first_menu_path`

Label

The label used to render this specific menu option at main application menu.

Requirements Rules:

Is Required;
Max length of 100 chars

Example:

1
2
3

Menus:
- Path: my_first_menu_path
  Label: My first menu

Description

The description to be included at menu option.

Example:

Menus:
- Path: my_first_menu_path
  Label: My first menu
  Description: First menu option included at my first UI

UiStructure

The name of the UiStructure that should be presented when this menu is accessed.

Requirements Rules:

Is Required;
The name must exist in UiStructures list in the current model;
- See UiStructure section for more details.

Example:

Menus:
- Path: my_first_menu_path
  Label: My first menu
  Description: First menu option included at my first UI
  UiStructure: my_first_ui_structure

RouteGroups

The route configuration for each child route provided by UiStructure. The configuration types available may vary accordingly to UiStructure linked.

Requirements Rules:

Is Required;
Each route group on list must follows rules as specified in RouteGroup

For Crud UiStructures:

Must contains 1 RouteGroup with type 'List';
Must contains 1 RouteGroup with type 'Edit';

For Chart or Dashboard UiStructures:

Must contains 1 RouteGroup with type 'Index';

Example:

Menus:
- Path: my_first_menu_path
  Label: My first menu
  Description: First menu option included at my first UI
  UiStructure: my_first_ui_structure
  RouteGroups:
  - Type: List
  - Type: Edit