Skip to main content

Interface: SidebarEntryProps

Defined in: components/Sidebar/sidebarSlice.ts:29

Represents an entry in the sidebar menu.

Properties​

icon?​

optional icon?: string | IconifyIcon;

Defined in: components/Sidebar/sidebarSlice.ts:59

An iconify string or icon object that will be used for the sidebar's icon

See​

https://icon-sets.iconify.design/mdi/ for icons.

label​

label: string;

Defined in: components/Sidebar/sidebarSlice.ts:41

Label to display.

name​

name: string;

Defined in: components/Sidebar/sidebarSlice.ts:33

Name of this SidebarItem.

parent?​

optional parent?: string | null;

Defined in: components/Sidebar/sidebarSlice.ts:45

Name of the parent SidebarEntry.

optional sidebar?: string;

Defined in: components/Sidebar/sidebarSlice.ts:62

The sidebar to display this item in. If not specified, it will be displayed in the default sidebar.

subtitle?​

optional subtitle?: ReactNode;

Defined in: components/Sidebar/sidebarSlice.ts:37

Text to display under the name.

url?​

optional url?: string;

Defined in: components/Sidebar/sidebarSlice.ts:49

URL to go to when this item is followed.

useClusterURL?​

optional useClusterURL?: boolean;

Defined in: components/Sidebar/sidebarSlice.ts:53

Should URL have the cluster prefix? (default=true)