Skip to content

Progress

Prints either a filled progress bar or a fixed number of square or circular steps.

value must be between 0 and max, inclusive.

Example

{
  "type": "progress",
  "variant": "bar",
  "value": 67,
  "max": 100
}

Fields

variant: "bar"

FieldTypeDescription
typerequired"progress"

Discriminator for progress blocks.

maxrequirednumber

Positive value representing complete progress.

  • Greater than: 0
valuerequirednumber

Current progress value. Must not exceed max.

  • Minimum: 0
variantrequired"bar"

variant: "steps"

FieldTypeDescription
typerequired"progress"

Discriminator for progress blocks.

maxrequirednumber

Positive value representing complete progress.

  • Greater than: 0
valuerequirednumber

Current progress value. Must not exceed max.

  • Minimum: 0
variantrequired"steps"
stepsrequiredinteger

Number of shapes in a stepped indicator.

  • Minimum: 1
  • Maximum: 32
stylerequiredstring

Shape used by a stepped indicator.

  • Allowed: "squares", "circles"