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

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 can be specified using CSS units (e.g. 100px or 100%), or be left unitless to be treated as flex-grow for the node.

Min Width

Prop	`minWidth`
Type	`string`
Default	`undefined`

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

The maximum width of the node. When this node is in a grid layout, this property is ignored.

Height

Prop	`height`
Type	`string`
Default	`64px`

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 can be specified using CSS units (e.g. 100px or 100%), or be left unitless to be treated as flex-grow for the node.

Min Height

Prop	`minHeight`
Type	`string`
Default	`undefined`

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

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	`::component { } ::wrapper { }`

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	`COMPONENT/com.dynaboard.navbars:1729caf1-5304-4d30-a2ff-a78d8cc4e78a`

The component to render for each item in the data array.

Navigation Item Properties

Prop	`navItemProps`
Type	`array`
Default	`[]`

Each navigation item will get a handful of properties for integration

Component Props

Prop	`navItemProps[]`
Type	`object`
Default	`undefined`

The values which will be passed to the component as $props

Layout Style

Prop	`layoutStyle`
Type	`NodeLayoutStyle ('GRID' \| 'HORIZONTAL_STACK' \| 'VERTICAL_STACK')`
Default	`HORIZONTAL_STACK`

The layout style of the items in the navigation bar (horizontal or vertical stack).

Padding

Prop	`padding`
Type	`string`
Default	`0`

The padding of the navigation bar.

Spacing

Prop	`spacing`
Type	`string`
Default	`0`

The spacing to use between items of the navigation bar.

Item Width

Prop	`itemWidth`
Type	`string`
Default	`undefined`

The width of the items in the navigation bar, in pixels or percentage.

Item Height

Prop	`itemHeight`
Type	`string`
Default	`undefined`

The height of the items in the navigation bar, in pixels or percentage.

Item Min Width

Prop	`itemMinWidth`
Type	`string`
Default	`undefined`

The min width of the items in the navigation bar, in pixels or percentage.

Item Max Width

Prop	`itemMaxWidth`
Type	`string`
Default	`undefined`

The max width of the items in the navigation bar, in pixels or percentage.

Item Min Height

Prop	`itemMinHeight`
Type	`string`
Default	`undefined`

The min height of the items in the navigation bar, in pixels or percentage.

Item Max Height

Prop	`itemMaxHeight`
Type	`string`
Default	`undefined`

The max height of the items in the navigation bar, in pixels or percentage.

Navbar Items

Prop	`navBarItems`
Type	`array`
Default	`[]`

The item configuration for the navigation bar.

Item Configuration

Prop	`navBarItems[]`
Type	`object`
Default	`undefined`

Options for each item

Title

Prop	`navBarItems[].title`
Type	`string`
Default	`undefined`

The title of the item

Key

Prop	`navBarItems[].accessor`
Type	`string`
Default	`undefined`

The property in the data to read for this item

ID

Prop	`navBarItems[].id`
Type	`string`
Default	`undefined`

A unique ID for this item

Is Visible

Prop	`navBarItems[].isVisible`
Type	`boolean`
Default	`undefined`

Whether the item should be showing in the navigation bar

Order Key

Prop	`navBarItems[].orderKey`
Type	`string`
Default	`undefined`

The key specifying the fractional index of this item

Media Page