Skip to main content
Version: 0.46

Progress

The Progress component is a visual indicator that represents task completion, processes, or status in either linear or circular form. It supports various styles, types, and customization options for a dynamic and informative user interface.

Image


Properties

The following properties are available to configure the behavior of the component from the form editor (this is in addition to common properties).

Common

Percent number

Sets the current progress percentage (0 to 100).

Type object

Visual type of the progress bar.

OptionDescription
Line (default)Horizontal bar.
CircleCircular progress.
DashboardSemi-circular gauge-like view.

Status object

Indicates the progress status.

OptionDescription
NormalNeutral, in-progress appearance.
ActiveShows an animated stripe to indicate the process is running.
SuccessShows a success colour.
ExceptionShows an error colour.

Show Info boolean

Whether to display the percentage inside the progress bar.


Appearance

Progress Style

Stroke Color object

The active bar color.

Trail Color object

The background (trail) color of the progress track.

Stroke Linecap object

Line ending style.

OptionDescription
Round (default)Rounded ends.
ButtFlat, flush ends.
SquareFlat ends that extend slightly past the track.

Stroke Width number

Thickness of the progress stroke, as a percentage of the canvas width (default is 6).

Width number

The canvas width of the progress indicator, in pixels. Shown only when Type is Circle or Dashboard.

Type Specific Settings

The following properties only appear for certain progress Types.

Steps number

The total number of discrete steps to divide the bar into. Shown only when Type is Line.

Gap Degree number

The gap degree of the circle, from 0 to 295. Shown only when Type is Circle or Dashboard.

Gap Position object

The position of the gap around the circle: Top, Bottom, Left, or Right. Shown only when Type is Circle or Dashboard.