Documentation

Documentation / @zerotal/flow-ui / index / SidebarItem

Interface: SidebarItem

Defined in: flow-ui/src/components/Sidebar.tsx:27

Properties

label

label: unknown

Defined in: flow-ui/src/components/Sidebar.tsx:28

href?

optional href?: string

Defined in: flow-ui/src/components/Sidebar.tsx:29

icon?

optional icon?: unknown

Defined in: flow-ui/src/components/Sidebar.tsx:31

Inline SVG or an icon element.

badge?

optional badge?: unknown

Defined in: flow-ui/src/components/Sidebar.tsx:33

Count or status shown on the right.

badgeClass?

optional badgeClass?: string

Defined in: flow-ui/src/components/Sidebar.tsx:35

Tailwind classes for the badge — a colour per meaning.

children?

optional children?: SidebarItem[]

Defined in: flow-ui/src/components/Sidebar.tsx:37

Nested links, rendered as a collapsible group.

external?

optional external?: boolean

Defined in: flow-ui/src/components/Sidebar.tsx:42

Leaves the app rather than navigating within it — external docs, a standalone dashboard. Opens in a new tab, and skips the client router.