Block: NavPanel
The NavPanel block is used to create a panel with navigation buttons.
NavPanelConfig
A NavPanel allows users to change navigate between routes
| Name |
Type |
Required |
Description |
kind |
"NavPanel" |
Yes |
NavPanel allows users to change navigate between routes |
type |
"button" |
Yes |
The type of the nav, can be either a button, an icon, or a number |
items |
List<NavButton | NavText | NavImage> |
Yes |
A list of items to display in the nav |
orientation |
"vertical" | "horizontal" |
No |
The orientation of the nav, horizontal for side nav, vertical for top nav |
layout |
LayoutConfig |
No |
|
style |
"light" | "dark" |
No |
The background and item style of the nav. Default is light |
card |
boolean |
No |
Card is used to display items in a way that is easily readable |
subscribe |
List<NavPanelSubscribe> |
No |
Subscribe to one or more sources |
| Name |
Type |
Required |
Description |
kind |
"NavButton" |
Yes |
|
frame |
string |
No |
|
text |
string |
Yes |
|
icon |
Icon |
No |
|
name |
string |
No |
|
NavPanelIcon
A NavPanel allows users to change navigate between routes
| Name |
Type |
Required |
Description |
kind |
"NavPanel" |
Yes |
NavPanel allows users to change navigate between routes |
type |
"icon" |
Yes |
@deprecated
Type icon is deprecated. Use type button or number instead |
items |
List<NavIcon | NavText | NavImage> |
Yes |
A list of items to display in the nav |
orientation |
"vertical" | "horizontal" |
No |
The orientation of the nav, horizontal for side nav, vertical for top nav |
layout |
LayoutConfig |
No |
|
style |
"light" | "dark" |
No |
The background and item style of the nav. Default is light |
card |
boolean |
No |
Card is used to display items in a way that is easily readable |
subscribe |
List<NavPanelSubscribe> |
No |
Subscribe to one or more sources |
NavIcon
| Name |
Type |
Required |
Description |
kind |
"NavIcon" |
Yes |
|
frame |
string |
No |
|
icon |
Icon |
Yes |
|
text |
string |
No |
|
name |
string |
No |
|
Icon
| Name |
Type |
Required |
Description |
kind |
"Icon" |
Yes |
|
icon |
IconConfig |
Yes |
|
NavPanelNumber
A NavPanel allows users to change navigate between routes
| Name |
Type |
Required |
Description |
kind |
"NavPanel" |
Yes |
NavPanel allows users to change navigate between routes |
type |
"number" |
Yes |
The type of the nav, can be either a button, an icon, or a number |
items |
List<NavNumber | NavText | NavImage> |
Yes |
A list of items to display in the nav |
orientation |
"vertical" | "horizontal" |
No |
The orientation of the nav, horizontal for side nav, vertical for top nav |
layout |
LayoutConfig |
No |
|
style |
"light" | "dark" |
No |
The background and item style of the nav. Default is light |
card |
boolean |
No |
Card is used to display items in a way that is easily readable |
subscribe |
List<NavPanelSubscribe> |
No |
Subscribe to one or more sources |
NavNumber
| Name |
Type |
Required |
Description |
kind |
"NavNumber" |
Yes |
|
frame |
string |
No |
|
number |
number |
Yes |
|
text |
string |
No |
|
name |
string |
No |
|
CommonNavItem
NavText
| Name |
Type |
Required |
Description |
kind |
"Text" |
Yes |
|
text |
string |
Yes |
|
name |
string |
No |
|
NavImage
| Name |
Type |
Required |
Description |
kind |
"Image" |
Yes |
|
path |
string |
Yes |
|
name |
string |
No |
|
NavPanelSubscribe
NavPanelRouterOutletSubscribe
| Name |
Type |
Required |
Description |
kind |
"RouterOutlet" |
Yes |
Subscribe to the a router outlet to highlight nav items with matching frame names |
frame |
string |
Yes |
The frame name that the router outlet you wish to subscribe to lives |
source |
string |
Yes |
The router outlet name, this is the same name as provided to the frame contents |
NavPanelEntityDataStoreSubscription
| Name |
Type |
Required |
Description |
kind |
"EntityDataStore" |
Yes |
|
frame |
string |
Yes |
|
source |
string |
Yes |
|
setTextItem |
string |
Yes |
|