progress Component

Use the progress component to convey an ongoing task until task completion.

{
  "type": "progress"
}

Properties

style
ENUM
Default: "linear"

The type of progress display you would like.

Value Description
"linear" A linear progress.
"round" A circular progress.
thickness
INTEGER
Default 0. Range 0-32

How thick the progress bar should be.

If set to 0, the default thickness per style is used.

progress
DOUBLE [getter]
Default 0.0, Range 0.0-1.0

The current progress.

colour
COLOUR | null
null sets the default accent colour

The foreground COLOUR of the progress.

background
COLOUR | null
null removes the background

The background COLOUR of the progress.

Also see Shared Properties.

Examples

An orange circular progress, 50% complete

{
  "id": "remaining",
  "type": "progress",
  "style": "round",
  "color": "systemOrangeColor",
  "progress": 0.5
}

The amount of progress can be updated using an update JSON action.

"action": {
  "type": "json",
  "src": {
    "update": {
      "ids": {
        "remaining": {
          "progress": 0.6
        }
      }
    }
  }
}