The Navigation component for Retool Apps

A primary navigation menu with nested items to trigger actions.

Navigation supports both horizontal and vertical orientation, and can include an image to display a logo next to menu items.

The component supports linking an item directly to an app. Doing so will automatically highlight the item (or its parent) when currently viewing its linked app, and hide it for any users who do not have access to its linked app.

Refer to the Navigation guide for more information about using this component.

Demo

Settings

Navigation includes the following configurable options when building apps in the IDE.

Alt textDataDisabledEvent handlersHeightHiddenAlignShow on desktopShow on mobileOptionsMaintain space when hiddenMarginOrientationFile inputShow legacy filesAlways show in edit modeSourceHeightSourceWidthStylesHelper text

Properties

All properties for Navigation with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

altText

string

An accessible description for screen readers.

---

appTargetByIndex

number[]

A list of app IDs, by index, for each item.

---

captionByIndex

string

A list of captions for each item, by index.

---

data

any[]

The source data.

---

dbBlobId

string

Self-hosted Retool deployments only. The ID of the uploaded image when srcType is dbBlobId.

---

disabled

boolean

Whether input, interaction, selection, or triggering is disabled.

---

disabledByIndex

boolean[]

A list of boolean values for each item, by index, that reflect whether they are disabled.

---

events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

The event type. Refer to the events section for a list of supported events.

---

method

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

---

type

enum

The type of action to perform.

Values

datasource	Control query.
widget	Control component.
script	Run script.
state	Set variable.
localStorage	Set localStorage.
util	Perform utility action (e.g., Open URL or Confetti).

---

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

heightType

enum

Whether the height automatically resizes to fit content or is a fixed size.

Values

fixed	Fixed height.
auto	Expand to fit content.

---

hidden

boolean

Whether the component is visible.

---

hiddenByIndex

boolean[]

A list of items, by index, and whether they are hidden.

---

highlightByIndex

boolean[]

A list of items, by index, and whether they are highlighted.

---

horizontalAlignment

enum

The horizontal alignment of the contents.

Values

left	Left alignment.
center	Center alignment.
right	Right alignment.
stretched	Justified alignment

---

iconByIndex

enum[]

A list of icons for each item, by index.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

---

iconPositionByIndex

string[]

A list of icon positions for each item, by index, relative to labels.

---

id

string

The unique identifier.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

itemMode

enum

The configuration mode for option lists. Either dynamic for mapped options or static for manual options.

Values

dynamic	Options dynamically mapped from an array.
manual	Options manually configured in the IDE.

---

itemTypeByIndex

number[]

A list of strings, by index, that reflect the type of item.

---

keyByIndex

string[]

A list of IDs, by index, for each item.

---

labels

string

A list of labels for each item. Falls back to the corresponding value if no label is provided.

---

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

orientation

enum

The orientation.

Values

horizontal	Horizontal.
vertical	Vertical.

---

overflowMode

enum

Whether to use a scrolling experience or wrap the visible buttons when heightType is 'auto'.

Values

scroll	Allow scrolling of visible buttons.
wrap	Wrap visible buttons.

---

parentKeyByIndex

string[]

A list of parent keys for each item, by index.

---

pluginType

string

The plugin type.

---

retoolFileObject

object

The file's data when using a file not stored in Retool Storage.

---

retoolStorageDynamicInput

string

Whether retoolStorageFileId is set dynamically.

---

retoolStorageFileId

string

The Retool Storage file ID if srcType is retoolStorageFileId.

---

retoolStorageShowLegacyFiles

boolean

Whether to show legacy files in the file picker.

---

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

---

src

string

The data source.

---

srcHeight

number

The height.

---

srcType

enum

The source type.

Values

url	URL.
retoolStorageFileId	Retool Storage file.
retoolFileObject	A file object.

---

srcWidth

number

The width of the image.

---

storageBlobId

string

The ID of the uploaded image when srcType is storageBlobId.

---

style

object

Custom style options in use. Not all style options may be available for all components.

---

tooltipByIndex

string[]

A list of tooltips for each item, by index.

---

tooltipText

string

The tooltip text to display.

---

Methods

JavaScript API methods for interacting with Navigation. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

scrollIntoView

Scrolls the canvas or parent container so that the selected component appears in the visible area.

navigation.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

---

block

enum

The scroll position relative to the component.

Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

---

---

---

setDisabled

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

navigation.setDisabled(disabled)

Parameters

disabled

boolean

Whether input, interaction, selection, or triggering is disabled.

---

---

setHidden

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

navigation.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

click

The item is clicked or pressed.

---

logoClick

The logo is clicked or pressed.

---