sidebar

The sidebar block within a ui block defines custom navigation items that appear in the management UI sidebar. Items are organised into named sections and appear in the order they are declared.

Items can link to internal UI routes or external URLs. The sidebar aggregates items from multiple ui blocks across configuration files.

Syntax

ui {
    sidebar {
        section "Section Name";
        item "Item Title" {
            url "/path/or/url";
            icon "IconName";
        }
        # Additional items...
    }
}

Sections

Use the section statement to define or switch to a named section. All subsequent item statements are added to the current section until another section statement appears.

sidebar {
    section "Configuration";
    item "Users" {
        url "/ui/users";
        icon "People";
    }
    item "Policies" {
        url "/ui/policies";
        icon "Policy";
    }

    section "Monitoring";
    item "Dashboard" {
        url "/monitoring/dashboard";
        icon "Dashboard";
    }
}

Default section

If no explicit section statement appears before the first item, items are placed in a default section named "Configuration".

sidebar {
    # Uses default "Configuration" section
    item "Settings" {
        url "/ui/settings";
        icon "Settings";
    }
}

Section merging

Items from multiple ui blocks with the same section name are merged into a single section in the aggregated sidebar. Items appear in the order they were declared across all configuration files.

# First file
ui {
    sidebar {
        section "Tools";
        item "Tool A" { url "/tool-a"; }
    }
}

# Second file
ui {
    sidebar {
        section "Tools";
        item "Tool B" { url "/tool-b"; }
    }
}

# Result: single "Tools" section with both items

Items

Each item represents a clickable navigation entry in the sidebar. Items are defined with the item statement followed by the item title and a block containing url and optional icon.

See sidebar item for detailed item configuration.

Context

Valid within a ui block.

Related

• ui - Top-level UI configuration block
• sidebar item - Individual sidebar item configuration