Interface SidebarMenuItemInterface

Item of the side menu

interface SidebarMenuItemInterface {
    getClass?: (() => string);
    icon: IconInfoInterface;
    isFullscreen: boolean;
    isPreviewIconVisible?: (() => boolean);
    isVisible: (() => boolean);
    items: SidebarMenuItemInterface[];
    onClick?: (() => void);
    onExit?: (() => boolean);
    order?: number;
    template?: string;
    title: string;
}

Properties

getClass? icon isFullscreen isPreviewIconVisible? isVisible items onClick? onExit? order? template? title

Properties

Optional getClass

getClass?: (() => string)

Class applied to the menu item element in the DOM

Type declaration

    • (): string

    • Class applied to the menu item element in the DOM

      Returns string

icon

icon: IconInfoInterface

Info of an icon displayed in the menu

isFullscreen

isFullscreen: boolean

Whether or not the menu item should be fullscreen

Optional isPreviewIconVisible

isPreviewIconVisible?: (() => boolean)

Condition of the preview icon's visibility

Type declaration

    • (): boolean

    • Condition of the preview icon's visibility

      Returns boolean

isVisible

isVisible: (() => boolean)

Condition of the item's visibility

Type declaration

    • (): boolean

    • Condition of the item's visibility

      Returns boolean

items

items: SidebarMenuItemInterface[]

Child items

Optional onClick

onClick?: (() => void)

Action performed when clicking the menu item

Type declaration

    • (): void

    • Action performed when clicking the menu item

      Returns void

Optional onExit

onExit?: (() => boolean)

Action performed when leaving the menu item (going back, switching items, closing menu). Returning true blocks an actual side menu action.

Type declaration

    • (): boolean

    • Action performed when leaving the menu item (going back, switching items, closing menu). Returning true blocks an actual side menu action.

      Returns boolean

Optional order

order?: number

Order of the item inside the side menu. A lower value goes to the top.

Optional template

template?: string

Path to the menu template (absolute or relative)

title

title: string

Title displayed in the menu

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc