Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SidebarMenuItemInterface

Item of the side menu

Hierarchy

  • SidebarMenuItemInterface

Index

Properties

Methods

Properties

icon

icon: IconInfoInterface

Info of an icon displayed in the menu

isFullscreen

isFullscreen: boolean

Whether or not the menu item should be fullscreen

items

items: SidebarMenuItemInterface[]

Child items

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

Methods

Optional getClass

  • getClass(): string

  • Class applied to the menu item element in the DOM

    Returns string

Optional isPreviewIconVisible

  • isPreviewIconVisible(): boolean

  • Condition of the preview icon's visibility

    Returns boolean

isVisible

  • isVisible(): boolean

  • Condition of the item's visibility

    Returns boolean

Optional onClick

  • onClick(): 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.

    Returns boolean

Generated using TypeDoc