3.3.2. <routes> Section

The <routes> element defines how the Dashboard constructs your menu entries (and nested sub-entries). Each <route>:

<route name="products" node="menu" canvas="productsList">
    <label>Products</label>
</route>
  • name: Required. Unique internal identifier for this route.

  • node: Required. Specific node identifier: menu for normal routes or notifications for dashboard notifications section.

  • canvas: Required. The name of a <canvas> (defined in the <canvases> section) to display when the user clicks this route.

  • icon: Optional. A URL for a route-specific icon.

  • parent: Optional. If you want this route to be nested under another route, specify the other route’s name here.

  • <label> inside <route>: Displayed, possibly multi-language label. Typically:

    <label lang="en">Home</label>

Example with Nested Routes (use of parent="..."):

xml<routes>
    <route name="main" node="menu" canvas="homeCanvas">
        <label>Home</label>
    </route>
    <route name="products" node="menu" parent="main" canvas="productsList">
        <label>Products</label>
    </route>
    <route name="categories" node="menu" parent="main" canvas="categoriesList">
        <label>Product Categories</label>
    </route>
</routes>

Here, products and categories will appear as sub-menu items under a top-level "main" parent route.

Last updated