Skip to main content

Progress

Rocket 2.0

The Progress component is a horizontal bar that fills to show how far along something is, such as an upload, a task list or a goal.

Properties​

Property
Description
Expected Value
LabelText shown above the bar.Text
PercentHow full the bar is, from 0 to 100.Number. Default: 60
Show percentShows the percent as a number above the bar, on the right.On or off. Default: Off
ColorColor of the bar: the theme's accent, or green for success, amber for warning and red for destructive. A Bar color style overrides it.default, success, warning, destructive. Default: default
Loading lookWhat shows while the component is loading: a spinner or a skeleton bar.Spinner, Skeleton. Default: Spinner

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Set valueSets the bar to the given Value, kept between 0 and 100.components.progress1.setValue("")
Set visibilityShows the component when true, hides it when false.components.progress1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.progress1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.progress1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown above the bar.{{components.progress1.label}}
valueHow full the bar is, from 0 to 100.{{components.progress1.value}}
showValueShows the percent as a number above the bar, on the right.{{components.progress1.showValue}}
variantColor of the bar: the theme's accent, or green for success, amber for warning and red for destructive. A Bar color style overrides it.{{components.progress1.variant}}
loadingIndicatorWhat shows while the component is loading: a spinner or a skeleton bar.{{components.progress1.loadingIndicator}}
isVisibleWhether the component is visible.{{components.progress1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.progress1.isLoading}}
isDisabledWhether the component is disabled.{{components.progress1.isDisabled}}

Styles​

Style
Default
Bar colorTheme: Brand primary
Track colorTheme: Brand primary
Label colorTheme: Primary text
Percent text colorTheme: Placeholder text
Bar height8
Fill—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.