The Global Navigation Panel
- Last UpdatedMay 10, 2023
- 1 minute read
This section describes the parameters that can be used in the JS file when creating an extension to add a button to the Global Navigation Panel.
Registration
Method: GlobalNavigation.register(id, definition)
Registration Definition Parameters
|
Parameter |
Description |
Required/Optional |
Default Value |
|---|---|---|---|
|
directive |
The name of the directive to use to fulfill the functionality. |
Required |
|
|
order |
The order in which, to display this global navigation function. |
Optional |
10000 |
|
floatWidth |
The percentage width of the screen that the panels floating width will start as. |
Optional |
20 |
|
linkClass |
The class to use for the link to access the panel. Should provide the icon as background image. |
Optional |
global- nav- default- link |
|
containerClass |
The css class that describes the max and min size of the container for the global navigation function. |
Optional |
global- nav- default- cont |
|
when |
A function that can be used to say dynamically, whether the component should be shown returning true or false. This function is called multiple times on the fly, so implement your own caching, if it is a long running function. |
Optional |
true |
Directive
Directive Scope Parameters
|
Parameter |
Description |
Required/Optional |
|---|---|---|
|
docked |
Whether the panel is docked or not. |
Optional |
|
singlePane |
Set to true if the panel is displaying in single pane mode. |
Optional |