NavigationItem
NavigationItem =
object
Defined in: packages/ui/src/types.ts:1074
A navigation item for sidebar or menu rendering.
Items can be permission-filtered: when action is provided, the item is
automatically hidden if the current user lacks permission for that action.
Supports nested children for sub-menu hierarchies.
- SidebarSlotProps which renders an array of these items.
- BreadcrumbItem for the breadcrumb-specific navigation type.
Properties
Section titled “Properties”action?
Section titled “action?”
optionalaction:ClientDescriptor
Defined in: packages/ui/src/types.ts:1082
If provided, the item is hidden when the user lacks permission for this action.
children?
Section titled “children?”
optionalchildren:NavigationItem[]
Defined in: packages/ui/src/types.ts:1084
Nested navigation items for sub-menus.
optionalicon:ComponentType<{className?:string; }>
Defined in: packages/ui/src/types.ts:1080
Optional icon component rendered before the label.
label:
string
Defined in: packages/ui/src/types.ts:1076
Display label for the navigation link.
to:
string
Defined in: packages/ui/src/types.ts:1078
Route path to navigate to.