Skip to content

NavigationItem

NavigationItem = object

Defined in: packages/ui/src/types.ts:950

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.

optional action: ClientDescriptor

Defined in: packages/ui/src/types.ts:958

If provided, the item is hidden when the user lacks permission for this action.


optional children: NavigationItem[]

Defined in: packages/ui/src/types.ts:960

Nested navigation items for sub-menus.


optional icon: ComponentType<{ className?: string; }>

Defined in: packages/ui/src/types.ts:956

Optional icon component rendered before the label.


label: string

Defined in: packages/ui/src/types.ts:952

Display label for the navigation link.


to: string

Defined in: packages/ui/src/types.ts:954

Route path to navigate to.