Skip to main content
zerotal

Documentation

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

Interface: SidebarProps

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

Indexable

[key: string]: unknown

Properties

brand?

optional brand?: unknown

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

Content at the top — a wordmark, a workspace switcher.

tagline?

optional tagline?: unknown

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

Line under the brand.

brandHref?

optional brandHref?: string

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

Where the brand links to.

groups

groups: SidebarGroup[]

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

current?

optional current?: string

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

The current path, for marking the active item.

optional footer?: unknown

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

Content pinned to the bottom — a user menu, a version string.

collapsible?

optional collapsible?: boolean

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

Render the mobile drawer toggle.

collapsibleGroups?

optional collapsibleGroups?: boolean

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

Let a labelled group be folded away by its heading.

Built on <details>, so the fold works before any JavaScript runs and the browser's find-on-page can open a closed group to reveal a match — neither of which a hand-rolled toggle gets.

beforeNav?

optional beforeNav?: unknown

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

Content between the brand and the nav — banners, a search box.

afterNav?

optional afterNav?: unknown

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

Content below the nav, above the footer.

class?

optional class?: string

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