NavVis IVION API
    Preparing search index...

    Interface TopBarItemInterface

    Item of the top bar.

    Custom items are registered through TopBarServiceInterface.items and rendered as buttons in the top bar. An item without any content (child items or a template) only performs its onClick action when clicked; an item with content opens a dropdown panel below the top bar.

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

    Properties

    getClass?: () => string

    Class applied to the menu item element in the DOM

    Info of an icon displayed in the top bar and in the dropdown rows

    isFullscreen?: boolean

    Only meaningful when template is set. false (default): renders the template inside the item's dropdown panel. true: renders the template as a full-viewport takeover below the top bar, with a header carrying the item's title, a close button and — for a nested item — back and root buttons.

    A takeover holds the viewport rather than an anchored panel, so it does not compete with a dropdown: activating another item opens that item's dropdown on top of the page, and the page stays until its own button, its close button or Escape closes it.

    Combining true with items is not supported: a fullscreen item renders its template only, so its children are unreachable. Use false to show children and a template together in the dropdown panel.

    isVisible: () => boolean

    Condition of the item's visibility

    Child items. Pass an empty array for leaf items. An item with visible children opens a dropdown listing them; children can be nested arbitrarily deep.

    onClick?: () => void

    Action performed when clicking the menu item

    onExit?: () => boolean

    Action performed when leaving the menu item (going back, going to the root level, closing the dropdown). Returning true blocks the actual top bar action.

    order?: number

    Order of the item among its siblings. A lower value is rendered first.

    template?: string

    Path to the menu template (absolute or relative). The template is rendered when the item is activated; presentation is controlled by isFullscreen.

    title: string

    Title of the item: rendered as the dropdown row label and as the top bar button tooltip.