Spectrum Components API

Schema version: 6.0.0

Progress bar

Progress bars show the progression of a system operation: downloading, uploading, processing, etc., in a visual way. They can represent either determinate or indeterminate progress.

PropertyValuesDefault valueRequired
variant
default / over background
default
static color
white
Static color can only be white, otherwise it is default.
label
text
-
label position
top / side
top
hide label
yes / no
no
value
yes / no
nono
min value
yes / no
nono
max value
yes / no
nono
value label
text
-
width
yes / no
nono
size
s / m / l / xl
m
is indeterminate
yes / no
no
{
  "slug": "progress-bar",
  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/progress-bar.json",
  "title": "Progress bar",
  "description": "Progress bars show the progression of a system operation: downloading, uploading, processing, etc., in a visual way. They can represent either determinate or indeterminate progress.",
  "meta": {
    "category": "status",
    "documentationUrl": "https://spectrum.adobe.com/page/progress-bar/"
  },
  "type": "object",
  "properties": {
    "variant": {
      "type": "string",
      "enum": [
        "default",
        "over background"
      ],
      "default": "default"
    },
    "staticColor": {
      "type": "string",
      "enum": [
        "white"
      ],
      "description": "Static color can only be white, otherwise it is default."
    },
    "label": {
      "type": "string"
    },
    "labelPosition": {
      "type": "string",
      "enum": [
        "top",
        "side"
      ],
      "default": "top"
    },
    "hideLabel": {
      "type": "boolean",
      "default": false
    },
    "value": {
      "type": "number",
      "description": "Not applicable when indeterminate."
    },
    "minValue": {
      "type": "number",
      "default": 0,
      "description": "Not applicable when indeterminate."
    },
    "maxValue": {
      "type": "number",
      "default": 1,
      "description": "Not applicable when indeterminate."
    },
    "valueLabel": {
      "type": "string"
    },
    "width": {
      "type": "number"
    },
    "size": {
      "type": "string",
      "enum": [
        "s",
        "m",
        "l",
        "xl"
      ],
      "default": "m"
    },
    "isIndeterminate": {
      "type": "boolean",
      "default": false
    }
  }
}
← Back to home