Skip to main content

Interface: SidebarEntryProps

Represents an entry in the sidebar menu.

Properties

icon?

optional icon: string | IconifyIcon;

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

See

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

Defined in

src/components/Sidebar/sidebarSlice.ts:58


label

label: string;

Label to display.

Defined in

src/components/Sidebar/sidebarSlice.ts:40


name

name: string;

Name of this SidebarItem.

Defined in

src/components/Sidebar/sidebarSlice.ts:32


parent?

optional parent: null | string;

Name of the parent SidebarEntry.

Defined in

src/components/Sidebar/sidebarSlice.ts:44


optional sidebar: string;

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

Defined in

src/components/Sidebar/sidebarSlice.ts:61


subtitle?

optional subtitle: string;

Text to display under the name.

Defined in

src/components/Sidebar/sidebarSlice.ts:36


url?

optional url: string;

URL to go to when this item is followed.

Defined in

src/components/Sidebar/sidebarSlice.ts:48


useClusterURL?

optional useClusterURL: boolean;

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

Defined in

src/components/Sidebar/sidebarSlice.ts:52