Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NavItem

Hierarchy

  • NavItem

Index

Properties

appIframeUrl

appIframeUrl: string

Absolute URL for loading the app which hosts this navigation item. navigation items with the same appBaseUrl value belong to the same app, and only one iframe is loaded for that app. The value of this field will be put into the src attribute of that iframe.

appPath

appPath: string

Field expressing the navigation item’s path inside the app referred to by the appBaseUrl field. This value has no meaning to nav-app, it is used to pass to the corresponding app in order to navigate to the desired path/route/location. Also, when an app signals that it has internally navigated to a different location, the navigation application compares that path to the path of all navigation items for that application, in order to update which navigation item is currently active. The path value must be unique across all navigation items for a given application (identified by appBaseUrl), AND for all navigation items of an application, no path can be a prefix-match (startsWith) of another path.

Optional displayName

displayName: string

Optional Human-readable name to represent the navigation item in the menu. Where available/applicable, displayName must be localized to the logged-in user’s locale, before the navigation item is provided to nav-app.

id

id: string

Unique identifier for the navigation item. Uniqueness should be taken care of by a unique application-prefix, followed by a suffix unique within that application. Non-unique navigation items will be dropped at registration time. navigationItems with id unknown to the nav-app will be put in a “Extensions” menu item (sorted by their displayName).