NavBar-HelpSubMenu-doc-link

Overview

Key: “accelerator_navbar-help-documentation” Providing the docName and docUrl in defaultSettings.tsx would automatically create the documnetaion hyperlinks for the respective accelarators in the HelpsSubMenu.

This is a function which generates MenuItem React components which can be used inside of the Help Submenu in the ActiveUI App navbar.

Configuration required

This feature requires some settings, but also requires that you call the function and spread the resulting array into the HelpSubMenu.

import {
  pluginNavbarHelpDocumentation,
} from "@activeviam/accelerator-sdk";
import { defaultSettings } from "./defaultSettings";

const docObjects = defaultSettings["accelerator_navbar-help-documentation"];

if (docObjects) {
  applicationSubMenuHelp.children = [
    applicationMenuItemDocumentation,
    ...pluginNavbarHelpDocumentation(docObjects),
    applicationMenuItemAbout,
  ];
}

const settingsKey = “accelerator_navbar-help-documentation”;

const navbarHelpDocumentationSettings = useAccSdkSettings()[settingsKey];