Skip to main content

Interface: SidebarEntryProps

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

Represents an entry in the sidebar menu.

Properties​

entryType?​

optional entryType?: "link" | "subheader";

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

The type of sidebar entry to render. Defaults to a clickable link item.

icon?​

optional icon?: string | IconifyIcon;

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

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:43

Label to display.

name​

name: string;

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

Name of this SidebarItem.

parent?​

optional parent?: string | null;

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

Name of the parent SidebarEntry.

optional sidebar?: string;

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

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:39

Text to display under the name.

sx?​

optional sx?: SxProps<Theme>;

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

Custom style overrides for subheader entries.

url?​

optional url?: string;

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

URL to go to when this item is followed.

useClusterURL?​

optional useClusterURL?: boolean;

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

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