Skip to content

RouteGroups

The route groups section allows you to configure specific child routes settings.

Fields

A route group contains the following fields to be defined:

Type

The type of the route group vary accordingly to which UiStructure type it's linked to in menu configuration.

Possible types are:

  • List: Route configuration for CRUD - List structure
  • Edit: Route configuration for CRUD - Edit structure
  • Index: Route configuration for CHART, DASHBOARD structures

Requirements Rules:

  • Is Required;
  • Must be an Allowed valid type, according to the types informed above

Example:

1
2
3
4
5
RouteGroups:
- Type: List
...
- Type: Edit
...


Label

The label used to render this specific route at breadcrumbs component.

Requirements Rules:

  • Is Required;
  • Max length of 100 chars

Example:

1
2
3
4
5
6
7
RouteGroups:
- Type: List
  Label: Crud list structure
...
- Type: Edit
  Label: Edit list structure
...


Roles

The list of roles which are authorized to access these routes. Using this configuration you can set a basic access control for application. The user who access these routes should have at least one of the roles configured to have the access granted, otherwise a 'Denied access' message will throw.

Requirements Rules:

  • This field is optional. If provided, each role name listed should be a valid role name

Example 1 - Crud:

1
2
3
4
5
6
7
8
9
RouteGroups:
- Type: List
  Label: Crud list structure
  Roles: ['admin','user']
...
- Type: Edit
  Label: Edit list structure
  Roles: ['admin']
...

Example 2 - Chart:

1
2
3
4
5
RouteGroups:
- Type: Index
  Label: Chart structure
  Roles: ['admin','user']
...

Example 3 - Dashboard:

1
2
3
4
5
RouteGroups:
- Type: Index
  Label: Dashboard structure
  Roles: ['admin','user']
...


Back to top