Skip to main content

Navigation

The Navigation component lets you build custom navigation menus with horizontal or vertical orientation. Menu items can be organized into groups and configured with icons, labels, and visibility rules. It fits well for scenarios like a top navigation bar across pages of an internal tool, a sidebar for an admin dashboard, or a bottom navigation menu in a mobile app.

Content

The Content section lists the navigation entries displayed in the component.

Adding Items and Groups

Click + New menu item to open a dropdown with two options: Add new menu item to add a standalone entry, or Add new group to add a group that can hold child items. Items and groups can be reordered by dragging.

Item Properties

Click any item or group to open its settings:

PropertyDescriptionExpected Value
LabelText displayed for the menu item.String (e.g., Dashboard). Supports {{ expressions.
IconIcon shown alongside the label.Icon name (e.g., IconArchive). Toggle icon visibility with the eye icon.
Hide this itemHides the item from the rendered navigation.Enable/disable the toggle or click fx to enter a logical expression.
Disable itemPrevents interaction with the item.Enable/disable the toggle or click fx to enter a logical expression.

Groups share the same properties and additionally hold child items that can be added from inside the group's settings.

Properties

Property
Description
Expected Value
OrientationSets the layout direction of the menu.Horizontal or Vertical.
StyleControls what each nav item displays.Text and icon, Text only, or Icon only.
Nav item sizeDetermines how items fill the available width.Auto sizes items to their content; Equal width distributes space evenly.
AlignmentHorizontal alignment of items within the navigation.Left, Center, or Right.

Events

EventDescription
On clickTriggers whenever the user clicks a navigation item.
info

Check the Action Reference docs to get detailed information about all the Actions.

Component Specific Actions (CSA)

The following actions of the Navigation component can be controlled using component-specific actions (CSA). You can trigger them using an event or a RunJS query.

Action
Description
How To Access
setVisibility()Sets the visibility of the component.components.navigation1.setVisibility(false)
setDisable()Enables or disables the component.components.navigation1.setDisable(true)
setLoading()Sets the loading state of the component.components.navigation1.setLoading(true)
selectItem()Programmatically selects a menu item by its ID.components.navigation1.selectItem('item1')

Exposed Variables

Variable
Description
How To Access
selectedItemThe currently selected navigation item object.{{components.navigation1.selectedItem}}
previousSelectedItemThe previously selected navigation item object.{{components.navigation1.previousSelectedItem}}
isVisibleIndicates if the component is visible.{{components.navigation1.isVisible}}
isDisabledIndicates if the component is disabled.{{components.navigation1.isDisabled}}
isLoadingIndicates if the component is in a loading state.{{components.navigation1.isLoading}}

Additional Actions

Action
Description
Configuration Options
Loading stateEnables a loading spinner on the component.Enable/disable the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.
VisibilityControls component visibility.Enable/disable the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.
DisableEnables or disables the component.Enable/disable the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.

Devices

Property
Description
Expected Value
Show on desktopMakes the component visible in desktop view.You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.
Show on mobileMakes the component visible in mobile view.You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.

Styles

Property
Description
Configuration Options
TextColor of the label for unselected items.Select the color or click on fx and input code that programmatically returns a Hex color code.
IconColor of the icon for unselected items.Select the color or click on fx and input code that programmatically returns a Hex color code.
Hover pill backgroundBackground color of the pill when an item is hovered.Select the color or click on fx and input code that programmatically returns a Hex color code.
Selected textColor of the label for the active/selected item.Select the color or click on fx and input code that programmatically returns a Hex color code.
Selected iconColor of the icon for the active/selected item.Select the color or click on fx and input code that programmatically returns a Hex color code.
Selected pill backgroundBackground color of the pill for the active/selected item.Select the color or click on fx and input code that programmatically returns a Hex color code.
Pill border radiusCorner radius of the selection pill.Enter a number (default: 6) or click on fx and enter a code that programmatically returns a numeric value.

Container

Property
Description
Configuration Options
BackgroundBackground color of the navigation container.Select the color or click on fx and input code that programmatically returns a Hex color code.
BorderBorder color of the navigation container.Select the color or click on fx and input code that programmatically returns a Hex color code.
Border radiusCorner radius of the navigation container.Enter a number (default: 8) or click on fx and enter a code that programmatically returns a numeric value.
PaddingInner padding of the navigation container.Enter a number (default: 8) or click on fx and enter a code that programmatically returns a numeric value.