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 \| NavLogout \| 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
`kind`	`"NavButton"`	Yes
`frame`	`string`	No
`text`	`string`	Yes
`icon`	Icon	No
`name`	`string`	No

An object for configuring a logout button.

Name	Type	Required	Description
`kind`	`"NavLogout"`	Yes	A constant, `NavLogout`.
`name`	`string`	Yes	A string defining the name of the button. This can be use in either the `NavPanel` layout or in subscriptions that target the buttons in the `NavPanel`.
`text`	`string`	No	A string defining the button text.
`icon`	Icon	No	An object for configuring an icon for the button.

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
`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

Name	Type	Required
`kind`	`"NavIcon"`	Yes
`frame`	`string`	No
`icon`	Icon	Yes
`text`	`string`	No
`name`	`string`	No

Name	Type	Required	Description
`kind`	`"Icon"`	Yes
`icon`	IconConfig	Yes

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

Name	Type	Required
`kind`	`"NavNumber"`	Yes
`frame`	`string`	No
`number`	`number`	Yes
`text`	`string`	No
`name`	`string`	No

Name	Type	Required
`kind`	`"Text"`	Yes
`text`	`string`	Yes
`name`	`string`	No

Name	Type	Required
`kind`	`"Image"`	Yes
`path`	`string`	Yes
`name`	`string`	No

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

Name	Type	Required
`kind`	`"EntityDataStore"`	Yes
`frame`	`string`	Yes
`source`	`string`	Yes
`setTextItem`	`string`	Yes