Config: UI Base ui-base
Properties
| Prop | Description |
|---|---|
| Path | The endpoint proceeding the host of Node-RED where your UI will be accessible |
| Include Page Path in Label | The side navigation lists all available Pages for the Dashboard. By default, this will just show the page name, but this option allows you to also show the page's path. |
| Side Navigation Style | The style the side navigation menu should use (default, fixed, icon, temporary, none) |
Title Bar Style Options Added In: v1.10.0
Title Bar - Default
The title bar will appear as the first element, and scroll with the content, meaning that on longer pages, the title bar will not be visible when the page is scrolled.
Example of how the 'Default' option looks
Title Bar - Fixed
The title bar will always be visible, even when the page is scrolled. This is useful for when you want to always have access to the title bar, regardless of the page's length.
Example of how the 'Fixed' option looks
Title Bar - Hidden
The title bar is not visible at all. Note that it is still possible to see the navigation menu in this state by choosing the Fixed option.
Example of how the 'Hidden' option looks
Navigation Style Options Added In: v1.2.0
Navigation - Collapsing (default)
This open will shift the entire content of the Dashboard when opened, and not be visisble at all when closed.
Navigation - Fixed
Example of how the 'Fixed' option looks at all times
Will always remain open. At our mobile breakdpoint (768px), this value is overriden, and an "Appear Over" option is used. Note that at mobile-scale (screen width less than 768px), then the Fixed layout will revert back to the "Default" option.
Navigation - Collapse to Icons
Similar to "Collapsing" when opened, but when closed, the icons for each page still show.
Navigation - Appear over Content
Not visible when closed, and when open, will appear over the Dashboard content, without shifting it.
Navigation - Always Hide
Example of how the 'Always Hide' option looks
The sidebar will not be visible under any circumstances. All pages are still accesible via their direct links or a ui-control node.