The Progress Bar component for Retool Apps

A content area to display a horizontal progress bar.

Demo

For more information about this component, refer to the Informational components guide.

Settings

Progress Bar includes the following configurable options when building apps in the IDE.

HiddenHide outputShow on desktopShow on mobileLabelAlignmentLabelsPositionWidthWidth (units)Allow wrappingMaintain space when hiddenMarginAlways show in edit modeStylesHelper textValue

Properties

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

global

boolean

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

---

hidden

boolean

Whether the component is visible.

---

hideOutput

Whether to hide the caption displayed with the value.

---

id

string

The unique identifier.

---

indeterminate

boolean

Whether to show a loading state with unknown progress.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

label

string

The text label to display.

---

labelAlign

enum

The horizontal alignment of the label.

Values

left	Left of the input field.
top	Above the input field.

---

labelCaption

string[]

The label for the node.

---

labelPosition

enum

The position of the label relative to the input field or value.

Values

top	Above the input field or value.
left	Left of the input field or value.

---

labelWidth

number

The label width, in the unit specified in labelWidthUnit.

---

labelWidthUnit

enum

The specified units for labelWidth, if labelPosition is left.

Values

%	Percent.
px	Pixels.
col	Columns.

---

labelWrap

boolean

Whether the label can wrap to multiple lines.

---

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.

---

pluginType

string

The plugin type.

---

showInEditor

boolean

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.

---

tooltipText

string

The tooltip text to display.

---

value

number

The value.

---

Methods

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

clearValue

Clear the current values.

progressBar.clearValue()

---

resetValue

Reset the current value to the default value.

progressBar.resetValue()

---

scrollIntoView

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

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

---

---

---

setHidden

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

progressBar.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---