NavVis IVION API
    Preparing search index...

    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;
    }
    Index

    Properties

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

    Properties

    getClass?: () => string

    Class applied to the menu item element in the DOM

    icon: IconInfoInterface

    Info of an icon displayed in the menu

    isFullscreen: boolean

    Whether or not the menu item should be fullscreen

    isPreviewIconVisible?: () => boolean

    Condition of the preview icon's visibility

    isVisible: () => boolean

    Condition of the item's visibility

    items: SidebarMenuItemInterface[]

    Child items

    onClick?: () => void

    Action performed when clicking the menu item

    onExit?: () => boolean

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

    order?: number

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

    template?: string

    Path to the menu template (absolute or relative)

    title: string

    Title displayed in the menu

    Settings

    Member Visibility

    On This Page

    Properties