> For the complete documentation index, see [llms.txt](https://docs.avonnicomponents.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.avonnicomponents.com/flow/flow-components/navigation.md).

# Navigation

The Avonni Navigation shows a horizontal or vertical menu on a flow screen and tells the flow which item the user picked.

The Avonni Navigation shows a horizontal or vertical menu on a flow screen. The value of the item the user picks is available to the flow, so you can show the matching part of the screen or route to another screen.

<figure><img src="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2FfZ88u9eZxUZQd8jiJnWw%2Fnavigation-result.png?alt=media" alt="A horizontal navigation menu with Overview selected, then Contacts, Opportunities and Cases, the last two with a dropdown chevron"><figcaption><p>A horizontal Navigation with Overview selected.</p></figcaption></figure>

***

## Tutorials

Step-by-step builds with the Navigation, grouped on the [Navigation tutorials](https://docs.avonnicomponents.com/flow/tutorials/components/navigation.md) page.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>New Navigation Item Collection</strong></td><td>Define the menu items once in a flow action and reuse them on every screen.</td><td><a href="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2FNmK1zylT57lT29rzcy0X%2Fcover-new-navigation-item-collection.png?alt=media">cover-new-navigation-item-collection.png</a></td><td><a href="https://docs.avonnicomponents.com/flow/actions/ui-and-navigation/new-navigation-item-collection.md">New Navigation Item Collection</a></td></tr><tr><td><strong>Add Sub-Menus and Columns to a Navigation Menu</strong></td><td>Group open and closed cases under one dropdown, with headings and columns.</td><td><a href="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2FFLLhLQm4uIlEjAonKoiO%2Fcover-add-sub-menus-and-columns-to-a-navigation-menu.png?alt=media">cover-add-sub-menus-and-columns-to-a-navigation-menu.png</a></td><td><a href="https://docs.avonnicomponents.com/flow/tutorials/components/navigation/add-sub-menus-and-columns-to-a-navigation-menu.md">Add Sub-Menus and Columns to a Navigation Menu</a></td></tr><tr><td><strong>Build a Navigation Menu from a Picklist</strong></td><td>Turn Case Status values into a menu that follows the picklist, with counts on each item.</td><td><a href="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2FcsilEus7BkBx8zm0ITM2%2Fcover-build-a-navigation-menu-from-a-picklist.png?alt=media">cover-build-a-navigation-menu-from-a-picklist.png</a></td><td><a href="https://docs.avonnicomponents.com/flow/tutorials/components/navigation/build-a-navigation-menu-from-a-picklist.md">Build a Navigation Menu from a Picklist</a></td></tr><tr><td><strong>Build Tabs on One Screen with Navigation</strong></td><td>Show an account's Overview, Contacts, Opportunities or Cases on one screen, no Next click.</td><td><a href="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2FsbQFi8i17AanW6MgDfTz%2Fcover-build-tabs-on-one-screen-with-navigation.png?alt=media">cover-build-tabs-on-one-screen-with-navigation.png</a></td><td><a href="https://docs.avonnicomponents.com/flow/tutorials/components/navigation/build-tabs-on-one-screen-with-navigation.md">Build Tabs on One Screen with Navigation</a></td></tr><tr><td><strong>Reuse One Menu Across a Multi-Screen Flow</strong></td><td>One side menu on every screen, and a Decision that opens the screen the agent picks.</td><td><a href="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2FZTHclcomNQaCPh66s4Zn%2Fcover-reuse-one-menu-across-a-multi-screen-flow.png?alt=media">cover-reuse-one-menu-across-a-multi-screen-flow.png</a></td><td><a href="https://docs.avonnicomponents.com/flow/tutorials/components/navigation/reuse-one-menu-across-a-multi-screen-flow.md">Reuse One Menu Across a Multi-Screen Flow</a></td></tr><tr><td><strong>Building a Navigation Menu with Related Records</strong></td><td>List an account's open opportunities as a menu and show the one the agent clicks.</td><td><a href="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2F5elu7tRfJ44kDiKqlpr8%2Fcover-building-a-navigation-menu-with-related-records.png?alt=media">cover-building-a-navigation-menu-with-related-records.png</a></td><td><a href="https://docs.avonnicomponents.com/flow/tutorials/components/navigation/building-a-navigation-menu-with-related-records.md">Building a Navigation Menu with Related Records</a></td></tr></tbody></table>

***

## Overview

A service agent opens a screen flow from an account and wants its Contacts, Opportunities and Cases one click apart. A Navigation with those four items gives the agent the menu. The flow reads **Active Navigation Item Value** and decides what to show.

The flow can use that value in three ways:

| Goal                | Flow feature                                    | Tutorial                                                                                                                                                                  |
| ------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Tabs on one screen  | **Set Component Visibility** on each section    | [Build tabs on one screen](https://docs.avonnicomponents.com/flow/tutorials/components/navigation/build-tabs-on-one-screen-with-navigation.md)                            |
| One screen per item | A **Decision** after the screen                 | [Reuse one menu across a multi-screen flow](https://docs.avonnicomponents.com/flow/tutorials/components/navigation/reuse-one-menu-across-a-multi-screen-flow.md)          |
| One item per record | **Variable** data source on a record collection | [Build a navigation menu with related records](https://docs.avonnicomponents.com/flow/tutorials/components/navigation/building-a-navigation-menu-with-related-records.md) |

## Set Up a Navigation

{% stepper %}
{% step %}

### Add the component to a screen

1. In Flow Builder, open a **Screen** element and drag **Avonni Navigation** onto it.
2. Give it an API name you will recognize in conditions, for example `AccountMenu`.
3. Click **Open Component Builder**.
   {% endstep %}

{% step %}

### Add the items

1. In the **Properties** tab, keep the **Manual** data source.
2. Under **Items**, click **Add Items** once per menu entry, then click each item and fill **Label** and **Value**, for example `Overview` / `overview`.

The flow compares the **Value**, never the label. Keep values short, lowercase and unique. To build the items elsewhere, see [Data Source](#data-source).

<figure><img src="https://27923732-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1FUd4apB9YHgCEMUFbVb%2Fuploads%2FYFfuVkDLcbLjpVWuxABV%2Fnavigation-properties.png?alt=media" alt="The Properties tab of the Navigation with Active Navigation Item Value set to overview, Horizontal orientation, and the Manual data source with four items" width="320"><figcaption><p>Items, default item and orientation in the Properties tab.</p></figcaption></figure>
{% endstep %}

{% step %}

### Choose the layout and the default item

1. Set **Orientation**: **Horizontal** (the default) for a bar across the top, **Vertical** for a side menu.
2. Set **Active Navigation Item Value** to the value of the item to highlight when the screen opens, for example `overview`.
   {% endstep %}

{% step %}

### Use the selection in the flow

Pick `AccountMenu` > **Active Navigation Item Value** as the resource of a visibility condition, a Decision outcome or a Get Records filter. Each tutorial in the table above walks through one of these.
{% endstep %}

{% step %}

### Save and test

Click **Done**, save the flow and run it with **Debug**. The menu shows your items with the default item highlighted. Click another item: the highlight moves to it, and any section or Decision based on **Active Navigation Item Value** follows.
{% endstep %}
{% endstepper %}

## Configuration

Click the component on the Flow screen, then **Open Component Builder**. The Edit Navigation Component panel opens with three tabs: **Properties**, **Interactions** and **Style**. The sections below follow the **Properties** tab.

### Data Source

| Data Source                                                                                       | Where the items come from                                                                                                                                                                                        | Use it when                                                                                                                                                                                                                |
| ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [**Manual**](https://docs.avonnicomponents.com/flow/component-builder/data-sources/manual.md)     | Items you type in the panel                                                                                                                                                                                      | The menu is fixed, such as Overview, Contacts, Opportunities, Cases                                                                                                                                                        |
| [**Variable**](https://docs.avonnicomponents.com/flow/component-builder/data-sources/variable.md) | A flow collection: a record collection, or a collection built by the [New Navigation Item Collection](https://docs.avonnicomponents.com/flow/actions/ui-and-navigation/new-navigation-item-collection.md) action | One item per record, or one menu shared by several screens                                                                                                                                                                 |
| [**Picklist**](https://docs.avonnicomponents.com/flow/component-builder/data-sources/picklist.md) | The values of a picklist field                                                                                                                                                                                   | The menu must follow a picklist, such as Case **Status**. See [Build a navigation menu from a picklist](https://docs.avonnicomponents.com/flow/tutorials/components/navigation/build-a-navigation-menu-from-a-picklist.md) |

### Items

With **Manual**, each item has these settings.

| Setting          | What it does                                                                                                                                                                                                                                                                                 |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Label**        | The text shown on the item.                                                                                                                                                                                                                                                                  |
| **Value**        | Required. A unique value for the item. This is what **Active Navigation Item Value** returns.                                                                                                                                                                                                |
| **Description**  | Text under the label. Shown in vertical orientation. In horizontal orientation, shown only for sub items that are not a column or tab name.                                                                                                                                                  |
| **Tag**          | A small badge to the right of the label, for example a count. **Tag Attributes** set its **Background Color**, **Text Color**, **Variant** (Base, Brand, Inverse, Alt-Inverse, Success, Info, Warning, Error, Offline), **Outline** and **Hide Text** (shows the badge as a colored circle). |
| **Tooltip**      | Text shown when the mouse moves over the item.                                                                                                                                                                                                                                               |
| **Avatar**       | An icon or image before the label: **Variant** (Circle, Square), **Icon Name**, **Icon Size**, **Image Source**.                                                                                                                                                                             |
| **Sub Items**    | Items shown in a dropdown under this item. Each sub item can hold **Sub Sub Items**, a third level.                                                                                                                                                                                          |
| **Menu Variant** | How the sub items menu looks: **Base** (a dropdown list), **Columns** or **Tabs**. Requires **Sub Items**. Applies to horizontal orientation.                                                                                                                                                |
| **Unselectable** | The item cannot be selected, only its sub items can. Use it for a heading such as Cases.                                                                                                                                                                                                     |
| **Hide Chevron** | Removes the chevron. A click anywhere on the item opens its sub items. Requires **Sub Items**.                                                                                                                                                                                               |

[Add sub-menus and columns to a navigation menu](https://docs.avonnicomponents.com/flow/tutorials/components/navigation/add-sub-menus-and-columns-to-a-navigation-menu.md) shows **Sub Items**, **Menu Variant**, **Unselectable** and **Hide Chevron** together.

### Data Mapping

With **Variable** and a record collection, **Data Mappings** tells the component which field fills each part of an item: **Label**, **Value**, **Description** (vertical orientation only), **Tag** and **Tag Attributes**, **Tooltip**, **Icon Name**, **Icon Size** (Xxs, Xs, Small, Medium, Large; default Small), **Sub Items**, **Menu Variant**, **Unselectable** and **Hide Chevron**. **Color**, **Disabled** and **Hidden** are under [Advanced Options](#advanced-options).

Map **Value** to a unique field. The record Id is the safest choice.

A collection from the New Navigation Item Collection action already holds labels and values, so it needs no mapping.

### Picklist

With **Picklist**, pick the object in **Object API Name**, then:

| Setting               | What it does                                                                                                 |
| --------------------- | ------------------------------------------------------------------------------------------------------------ |
| **Picklist Field**    | The field whose values become the items.                                                                     |
| **Record Type**       | Shows only the values available for one record type. Appears when the object has record types.               |
| **Picklist Value**    | Shows only the values you select. Leave it empty to show them all.                                           |
| **Controlling Value** | For a dependent picklist, the controlling value that filters the items. Appears when the field is dependent. |
| **Sort Order**        | **Ascending**, **Descending** or **Default Order of Field**.                                                 |

Each item takes the picklist label as its label and the picklist API value as its value. Picklist items have no tag, sub items or disabled state.

### Properties

| Setting                          | What it does                                                                                            |
| -------------------------------- | ------------------------------------------------------------------------------------------------------- |
| **Active Navigation Item Value** | The value of the item selected when the screen opens. It must match a **Value** exactly, case included. |
| **Shaded**                       | Gives the items a shaded background.                                                                    |
| **Orientation**                  | **Horizontal** (default) or **Vertical**.                                                               |
| **Compact**                      | Reduces the spacing between items. Requires **Orientation** = Vertical.                                 |
| **Show Dropdown Nubbin**         | Shows the small arrow on the sub items menu. Requires **Orientation** = Horizontal.                     |
| **Open Menu On Hover**           | Opens the sub items menu when the mouse moves over the item. Requires **Orientation** = Horizontal.     |

### Title

| Setting          | What it does                                    |
| ---------------- | ----------------------------------------------- |
| **Title**        | Text shown with the menu.                       |
| **Icon Name**    | An icon next to the title.                      |
| **Icon Size**    | Size of the title icon. Requires **Icon Name**. |
| **Image Source** | An image shown in the title area.               |

### Item Indicator

| Setting      | What it does                                                                                                           |
| ------------ | ---------------------------------------------------------------------------------------------------------------------- |
| **Show**     | Shows the bar that marks the selected item. On by default.                                                             |
| **Position** | **Top (horizontal) / Left (vertical)** or **Bottom (horizontal) / Right (vertical)**. Requires **Show** to be enabled. |

### Advanced Options

Each item, sub item and sub sub item has three more settings under **Advanced Options**.

| Setting      | What it does                                  |
| ------------ | --------------------------------------------- |
| **Color**    | Shows a colored circle next to the label.     |
| **Disabled** | The item is grayed out and cannot be clicked. |
| **Hidden**   | The item is not displayed.                    |

**Disabled** and **Hidden** accept a Boolean resource, so a formula can switch them per run. Example: hide Cases for a user who has no access to them.

## Interactions

[Interactions](https://docs.avonnicomponents.com/flow/component-builder/interactions-panel.md) define what happens when users interact with the Navigation. Configure them from the **Interactions** tab of the Edit Navigation Component panel.

### Select

Fires when the user selects an item. **Target Name** lists the values of your items:

* Leave it empty and the interaction runs for every item.
* Pick a value and it runs only when that item is selected.

The selected value is available inside the interaction as **Navigation Item Value**. To move to another screen on click, add a [Flow Navigation](https://docs.avonnicomponents.com/flow/component-builder/interactions-panel/flow-navigation.md) interaction.

## Styling

The **Style** tab groups its settings in sections. **Sub Item** and **Sub Item Label** appear in horizontal orientation only.

{% tabs %}
{% tab title="Margin" %}
Space around the component: **Top**, **Right**, **Bottom**, **Left**.
{% endtab %}

{% tab title="Padding" %}
Space inside the component: **Top**, **Right**, **Bottom**, **Left**.
{% endtab %}

{% tab title="Size" %}
**Width** and **Height** of the component.
{% endtab %}

{% tab title="Border" %}
Border around the component: color, size, style and radius.
{% endtab %}

{% tab title="Background" %}
**Color**, and the item background in each state: **Background Color Active**, **Background Color Hover**, **Background Color Disabled**.
{% endtab %}

{% tab title="Bottom Border" %}
**Color** and **Size** of the line under a horizontal menu.
{% endtab %}

{% tab title="Title" %}
**Text Color**, **Font Size**, **Font Weight**, **Font Family**, **Text Shadow**.
{% endtab %}

{% tab title="Title Image" %}
**Object Fit**, **Height**, **Width**.
{% endtab %}

{% tab title="Item" %}
**Width**, **Min Width**, **Max Width** of each item.
{% endtab %}

{% tab title="Item Label" %}
**Text Color**, **Font Size**, **Font Weight**, **Font Family**, **Text Shadow**, each also in an Active, Hover and Disabled version (for example **Text Color Active**).
{% endtab %}

{% tab title="Item Description" %}
**Text Color**, **Font Size**, **Font Weight**, **Font Family**, **Text Shadow**.
{% endtab %}

{% tab title="Item Indicator" %}
**Color Active**, **Size Active**, **Color Hover**, **Size Hover**.
{% endtab %}

{% tab title="Item Border" %}
**Color**, **Size**, **Color Active**, **Size Active**.
{% endtab %}

{% tab title="Menu" %}
Size of the sub items menu: **Width**, **Min Width**, **Max Width**, **Height**, **Min Height**, **Max Height**, **Column Width**, **Spacing Block**, **Spacing Inline**.
{% endtab %}

{% tab title="Menu Border" %}
**Color**, **Size**, **Style**, **Radius**.
{% endtab %}

{% tab title="Menu Icon" %}
**Color**, **Color Active**, **Color Hover**.
{% endtab %}

{% tab title="Menu Group Label" %}
**Text Color**, **Font Size**, **Font Weight**, **Font Family**, **Text Shadow**.
{% endtab %}

{% tab title="Menu Column Label" %}
Column headings of a **Columns** menu: **Text Color**, **Font Size**, **Font Weight**, **Font Family**, **Text Shadow**.
{% endtab %}

{% tab title="Sub Item" %}
**Background Color Selected**, **Background Color Disabled**, **Spacing Block**, **Spacing Inline**.
{% endtab %}

{% tab title="Sub Item Label" %}
**Text Color**, **Text Color Hover**, **Text Color Disabled**, **Font Size**, **Font Weight**, **Font Family**, **Text Shadow**.
{% endtab %}
{% endtabs %}

## Output Variables

After the screen, select the Navigation in any resource picker (for example `AccountMenu`) and pick the output you need.

### Item Selection

| Output variable                    | Type   | What it returns                                                                                                           |
| ---------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------- |
| **Active Navigation Item Value**   | Text   | The **Value** of the selected item. Before any click, the value set in **Active Navigation Item Value**, or empty.        |
| **Active Navigation Item SObject** | Record | The record behind the selected item. Filled only when the items come from a record collection (**Variable** data source). |

> **Example:** A menu lists the open opportunities of an account. After the screen, an **Update Records** element uses **Active Navigation Item SObject** to update the opportunity the agent picked, with no second Get Records.

### Others

| Output variable     | Type    | What it returns                  |
| ------------------- | ------- | -------------------------------- |
| **Number of Items** | Integer | The number of items in the menu. |

### Flow Interaction Output Variables

An [Open Flow Dialog](https://docs.avonnicomponents.com/flow/component-builder/interactions-panel/open-flow-dialog.md) or [Open Flow Panel](https://docs.avonnicomponents.com/flow/component-builder/interactions-panel/open-flow-panel.md) interaction can return values from the flow it launches. See [Flow Interaction Output Variables](https://docs.avonnicomponents.com/flow/component-builder/interactions-panel/flow-interaction-output-variables.md).

## Troubleshooting Common Issues

* **No item is highlighted when the screen opens.** **Active Navigation Item Value** is empty, or it does not match a **Value** exactly. `Cases` and `cases` are different values.
* **A section never appears.** Its visibility condition compares the label. Compare **Active Navigation Item Value** with the item **Value**.
* **The menu is empty with the Variable data source.** The collection is empty at this screen, or, for a record collection, **Data Mappings** has no **Label** and **Value**. Check that the Get Records runs before the screen.
* **Clicking an item with sub items does not open them.** The item is selectable, so a click on the label selects it. Click the chevron, or turn on **Unselectable** or **Hide Chevron** on that item.
* **Columns or Tabs show nothing.** In those variants each sub item is a column or tab name, and a sub item with no **Sub Sub Items** is skipped.
* **A Select interaction runs for the wrong item.** Its **Target Name** is empty (it runs for every item) or set to another value.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.avonnicomponents.com/flow/flow-components/navigation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
