Navigation Bar Component
Navigation Bars The Navigation Bar component takes a custom component and renders it for each page in the application. Components rendered by the navigation bar are provided with information about their associated page title and href. In addition, the navigation bar is aware of both the current page as well as any authentication rules that may prevent a page from being visited by the current user.
Properties
Visible
| Prop | isVisible |
|---|---|
| Type | boolean |
| Default | {{true}} |
Whether or not this node is visible.
Enabled
| Prop | isEnabled |
|---|---|
| Type | boolean |
| Default | {{true}} |
Whether or not this node is enabled.
Tooltip
| Prop | tooltip |
|---|---|
| Type | string |
| Default | undefined |
The tooltip text to display when hovered or focused over this node.
Top
| Prop | top |
|---|---|
| Type | number |
| Default | 1 |
The position of the node from the top side of the grid (grid-row-start).
Left
| Prop | left |
|---|---|
| Type | number |
| Default | 1 |
The position of the node from the left side of the grid (grid-column-start).
Width
| Prop | width |
|---|---|
| Type | string |
| Default | 128px |
The width of the node. When this node is in a grid layout, this should be done using unitless grid column units (specifying 4 will become grid-column-end: span 4). When this node is in a stack layout, the width must be specified using CSS units (e.g. 100px or 100%).
Min Width
| Prop | minWidth |
|---|---|
| Type | string |
| Default | none |
The minimum width of the node. When this node is in a grid layout, this property is ignored.
Max Width
| Prop | maxWidth |
|---|---|
| Type | string |
| Default | none |
The maximum width of the node. When this node is in a grid layout, this property is ignored.
Height
| Prop | height |
|---|---|
| Type | string |
| Default | 32px |
The height of the node. When this node is in a grid layout, this should be done using unitless grid row units (specifying 4 will become grid-row-end: span 4). When this node is in a stack layout, the height must be specified using CSS units (e.g. 100px or 100%).
Min Height
| Prop | minHeight |
|---|---|
| Type | string |
| Default | none |
The minimum height of the node. When this node is in a grid layout, this property is ignored.
Max Height
| Prop | maxHeight |
|---|---|
| Type | string |
| Default | none |
The minimum height of the node. When this node is in a grid layout, this property is ignored.
Overflow
| Prop | overflow |
|---|---|
| Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
| Default | auto |
The strategy used to handle overflow in the horizontal and vertical axes for content that is larger than its container.
Overflow X
| Prop | overflowX |
|---|---|
| Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
| Default | auto |
The strategy used to handle overflow in the horizontal axis for content that is larger than its container.
Overflow Y
| Prop | overflowY |
|---|---|
| Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
| Default | auto |
The strategy used to handle overflow in the vertical axis for content that is larger than its container.
Custom Styles
| Prop | styles |
|---|---|
| Type | string |
| Default | element.styles { } |
Custom CSS styles to be applied to the node. Use element.styles to refer to the current node.
Object Fit
| Prop | objectFit |
|---|---|
| Type | ObjectFit ('none' | 'contain' | 'cover' | 'fill' | 'scale-down') |
| Default | cover |
The strategy used to set how the content of a replaced element should be resized to fit its container.
Component
| Prop | component |
|---|---|
| Type | (string | null) |
| Default | undefined |
The component to render for each item in the data array.
Navigation Item Properties
| Prop | navItemProps |
|---|---|
| Type | unknown |
Each navigation item will get a handful of properties for integration
pageTitle- refers to the name of the page
href- refers to the relative path of that page
isDisabled- integrates with our auth system
isActive- will be true for the current page
Layout Style
| Prop | layoutStyle |
|---|---|
| Type | NodeLayoutStyle ('GRID' | 'HORIZONTAL_STACK' | 'VERTICAL_STACK') |
| Default | HORIZONTAL_STACK |
The layout style of the individual items in the iterator (horizontal or vertical stack).
Padding
| Prop | padding |
|---|---|
| Type | string |
| Default | 0 |
The internal padding of the iterator to place around its children.
Spacing
| Prop | spacing |
|---|---|
| Type | string |
| Default | 0 |
The spacing to use between child nodes of the iterator.