item
- Syntax
- Parameters
- Title (required)
- url (required)
- icon (optional)
- Available icons
- Navigation and layout
- Configuration and management
- Identity and access
- Network and infrastructure
- Data and metrics
- Miscellaneous
- Examples
- Internal UI route with icon
- Configuration file editor link
- External monitoring system
- External documentation without icon
- Multiple items in a section
- Validation
- Context
- Related
The item statement within a sidebar block defines a single navigation entry. Each item has a title, a URL, and an optional icon.
Links to /radiatordb and its subpaths are included only with an effective RadiatorDB license and at least one configured RadiatorDB backend. Sections with no available items are omitted. Availability follows the active configuration.
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 Radiator UI icons available in Radiator 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.
Navigation and layout
DashboardListFolderInsertDriveFileDescriptionArticleMenuBookAutoStories
Configuration and management
SettingsSettingsApplicationsSettingsEthernetBuildBuildCircleSecurityGppGoodPolicyRuleRuleFolderFactCheck
Identity and access
PeoplePersonGroupGroupsPersonSearchManageAccountsVpnKeyKeyLockLockOpenVerifiedUserVpnLock
Network and infrastructure
RouterDnsStorageCloudCloudQueueCloudDoneCloudCircleCloudDownloadCloudUploadPublicLanguage
Data and metrics
PlusOneTimelineShowChartBarChartAssessmentQueryStatsInsightsTrendingUpHistoryHistoryToggleOff
Miscellaneous
AssignmentContentCopyUpdateHelpOutlineInfoInfoOutlinedBugReport
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";
}
Configuration file editor link
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
urlparameter is required. Configuration fails to load if an item is missing a url. - The
iconparameter is optional. - Duplicate
urloriconstatements within a single item block are rejected. - The item title string cannot be empty.
Context
Valid within a sidebar block inside a ui block.