Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IBaseNavigationRegistrationRequest

A request that the integration sends to register a base navigation route.

An example request to register:

example

{
  type: 'basenav:register',
  displayName: 'My Integration',
  routeName: 'myIntegration'
  contents: {
    "tag": "Link",
    "to": "myIntegration",
    "children": "My Integration"
  }
}

Hierarchy

  • IBaseNavigationRegistrationRequest

Index

Properties

displayName

displayName: string

The display name to be used for the navigation.

Optional initialContents

initialContents: IStandardElement

The initial contents to render

routeName

routeName: string

The route name to be used for the navigation

type

type: "basenav:register"

Generated using TypeDoc