Breadcrumbs

Breadcrumbs allow you to show users how the page they are on is categorized or the path the user took to find it. With modules, you can even reuse your Breadcrumb across multiple apps.

Properties

Available properties for Breadcrumbs with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.

NameTypeDescriptionvaluestring

The current value.

appTargetByIndexstring[]

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

clickableboolean

Whether the component has an enabled Click event handler.

data{ [key: string]: unknown }[]

The source data for the component.

disabledboolean

Whether user input, interaction, or selection is disabled.

disabledByIndexboolean[]

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

hiddenboolean

Whether the component is visible.

iconByIndexIconKey[]

A list of icons for each item, by index.

iconPositionByIndex('left' | 'right')[]

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

itemMode'dynamic' | 'static'

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

itemTypeByIndex('app' | 'custom')[]

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

labelsstring[]

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

maintainSpaceWhenHiddenboolean

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

marginstring

The amount of margin to render outside of the component.

showInEditorboolean

Whether the component remains visible in the editor if hidden is true.

tooltipByIndexstring[]

A list of tooltips for each item, by index.

tooltipTextstring

The text to display in a tooltip on hover or focus.

Events

Events are triggered by user interactions with Breadcrumbs. Use event handling to trigger queries or other actions in response to events.

NameDescriptionClick

A user clicks the component.

Methods

Methods for interacting with Breadcrumbs. You can write JavaScript almost anywhere in Retool and use methods to manipulate data or components.

NameDescriptionsetValue(value: boolean | string | number | void)

Set the current value.

clearValue()

Clear the current value.

scrollIntoView(options: any)

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

setHidden(hidden: boolean)

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

setDisabled(disabled: boolean)

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

resetValue()

Reset value to the default value.