Skip to main content

The Breadcrumbs component for Retool Apps

A secondary navigation menu to trigger actions.

Demo

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

Settings​

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

DataDisabledEvent handlersShow on desktopShow on mobileOptionsMaintain space when hiddenMarginAlways show in edit modeStylesHelper textValue

Properties​

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

appTargetByIndex​

number[]

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

clickable​

boolean

Whether there is an enabled Click event handler.

data​

any[]

The source data.

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.

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.

​

boolean

Whether the component is visible.

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.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

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.

labels​

string

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

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

The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.

pluginType​

string

The plugin type.

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

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.

The tooltip text to display.

value​

string

The value.

Methods​

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

clearValue​

Clear the current values.

breadcrumbs.clearValue()

resetValue​

Reset the current value to the default value.

breadcrumbs.resetValue()

scrollIntoView​

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

breadcrumbs.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.

breadcrumbs.setDisabled(disabled)
Parameters

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.

breadcrumbs.setHidden(hidden)
Parameters

​

boolean

Whether the component is visible.

setValue​

Set the current value.

breadcrumbs.setValue(value)
Parameters

value​

string

The value.

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.