The Progress Bar web component
A content area to display a horizontal progress bar.
Settings
Progress Bar includes the following configurable options when building apps in the IDE.
Show 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
Whether the object is globally scoped for use in all app pages.
Whether to hide the caption displayed with the value.
id
The unique identifier.
indeterminate
Whether to show a loading state with unknown progress.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
labelAlign
The horizontal alignment of the label.
Values
left | Left of the input field. |
top | Above the input field. |
labelCaption
The label for the node.
labelPosition
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
The label width, in the unit specified in labelWidthUnit
.
labelWidthUnit
The specified units for labelWidth
, if labelPosition
is left
.
Values
% | Percent. |
px | Pixels. |
col | Columns. |
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
tooltipText
The tooltip text to display.
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
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
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)