item

Sidebar navigation item configuration

The item statement within a sidebar block defines a single navigation entry. Each item has a title, a URL, and an optional icon.

Syntax

item "Item Title" {
    url "/path/or/url";
    icon "IconName";
}

Parameters

Title (required)

The display text for the navigation item. Specified immediately after the item keyword before the opening brace.

item "User Management" {
    url "/ui/users";
}

url (required)

The destination when the item is clicked. Can be an internal UI route (starting with /) or an external absolute URL.

Internal route:

item "Logs" {
    url "/logs";
}

External URL:

item "Grafana Dashboard" {
    url "https://grafana.example.com:3000/dashboard";
}

Query parameters:

item "Client Configuration" {
    url "/configuration/files/details/?filename=data/local-clients.json5&template-hint=local-clients.json5.radtmpl";
}

icon (optional)

The icon name to display next to the item title. Icon names correspond to Material UI icons available in the management UI.

item "Settings" {
    url "/ui/settings";
    icon "Settings";
}

If omitted, a default icon is used.

item "External Link" {
    url "https://example.com";
    # No icon specified - uses default
}

Available icons

The following icon names are supported. Icon names are case-sensitive and must match exactly.

  • Dashboard
  • List
  • Folder
  • InsertDriveFile
  • Description
  • Article
  • MenuBook
  • AutoStories

Configuration and management

  • Settings
  • SettingsApplications
  • SettingsEthernet
  • Build
  • BuildCircle
  • Security
  • GppGood
  • Policy
  • Rule
  • RuleFolder
  • FactCheck

Identity and access

  • People
  • Person
  • Group
  • Groups
  • PersonSearch
  • ManageAccounts
  • VpnKey
  • Key
  • Lock
  • LockOpen
  • VerifiedUser
  • VpnLock

Network and infrastructure

  • Router
  • Dns
  • Storage
  • Cloud
  • CloudQueue
  • CloudDone
  • CloudCircle
  • CloudDownload
  • CloudUpload
  • Public
  • Language

Data and metrics

  • PlusOne
  • Timeline
  • ShowChart
  • BarChart
  • Assessment
  • QueryStats
  • Insights
  • TrendingUp
  • History
  • HistoryToggleOff

Miscellaneous

  • Assignment
  • ContentCopy
  • Update
  • HelpOutline
  • Info
  • InfoOutlined
  • BugReport

If an unsupported icon name is specified, the UI displays a default fallback icon.

Examples

Internal UI route with icon

item "Counters" {
    url "/counters";
    icon "PlusOne";
}
item "User Database" {
    url "/configuration/files/details/?filename=data/local-users.json5&template-hint=local-users.json5.radtmpl";
    icon "People";
}

External monitoring system

item "Grafana" {
    url "http://grafana.example.com:3000";
    icon "Assessment";
}

External documentation without icon

item "Support Portal" {
    url "https://support.example.com/kb";
}

Multiple items in a section

ui {
    sidebar {
        section "User Management";

        item "Local Users" {
            url "/configuration/files/details/?filename=data/local-users.json5";
            icon "People";
        }

        item "Administrators" {
            url "/configuration/files/details/?filename=data/local-admins.json5";
            icon "ManageAccounts";
        }

        item "External Directory" {
            url "https://ldap-admin.example.com";
            icon "CloudQueue";
        }
    }
}

Validation

  • The url parameter is required. Configuration fails to load if an item is missing a url.
  • The icon parameter is optional.
  • Duplicate url or icon statements within a single item block are rejected.
  • The item title string cannot be empty.

Context

Valid within a sidebar block inside a ui block.

  • sidebar - Sidebar navigation configuration
  • ui - Top-level UI configuration block
Navigation
Parents