Navigation

Overview

List of configuration files

Filename	Short description	Format	Link to documentation
dashboard.view#NavigationWidget	Defines the NavigationWidget widget global settings	json	Link

Features

Navigation widget allows creating links to other dashboards or even external resources.

Example of Navigation widget:

It consists of two parts (both optional):

• Icon: An icon that best represents the navigation button

• Label: A label to describe the navigation button

The following parameters can be used for the navigation button:

Setting	Usage	Type	Default value
url	The URL which the navigation button points to	string
label	The navigation label shown at the bottom of the button	string
icon	The icon based on Material-UI listing displayed at the top of the button	string
showLabel	Whether the label is shown or not	boolean	true
showIcon	Whether the icon is shown or not	boolean	true
foregroundColor	The widget foreground color (text, icon)	string
backgroundColor	The widget background color	string
target	Whether to route internally, to navigate to external target (current page or new page), to refresh the page (similar to F5) or logout user	ROUTER or EXTERNAL or EXTERNAL_NEW or REFRESH or LOGOUT	ROUTER

Example of internal navigation:

{
"navigationWidgetSettings": {
    "url": "/home/root/dashboards",
    "backgroundColor": "#4287f5",
    "foregroundColor": "#FFF",
    "showIcon": true,
    "icon": "meeting_room",
    "label": "Go to office"
}

Example of external navigation with new page creation:

{
"navigationWidgetSettings": {
    "url": "https://www.google.com",
    "target": "EXTERNAL_NEW",
    "label": "Google"
}

The navigation widget settings definition is :

export type NavigationWidgetSettingsTarget = 'ROUTER' | 'REFRESH' | 'LOGOUT' | 'EXTERNAL' | 'EXTERNAL_NEW';

export type NavigationWidgetSettings = {
    url?: string,
    label?: string
    icon?: string,
    showLabel?: boolean,
    showIcon?: boolean,
    backgroundColor?: string
    foregroundColor?: string
    target?: NavigationWidgetSettingsTarget
};