Skip to main content

Progress

Used to display one of the following:

  • the length of time a process will take
  • a visual percentage value (referred to as a determinate state)
  • a visual representation of an unspecified wait time (referred to as an indeterminate state). Can be thought of as a loading animation.

Progress components are typically visually represented by a circular or linear animation. When the value attribute is passed, the state is determinate; otherwise, it is indeterminate.

Use cases:

  • Progress indicators
  • Metric visualisation

Example

Declaration

<rapid-progress></rapid-progress>

Usage

@customElement({
name: 'my-element',
template: html`
<rapid-progress></rapid-progress>
`,
})
export class MyElement extends GenesisElement {
}

API

Property and attribute binding examples for Genesis Component syntax. Closing tag omitted.

Attributes

NameTypeDescriptionExample
valuenumberThe value of progress to be shown.
<rapid-progress value="75">
minnumberThe minimum value of progress.
<rapid-progress value="0">
maxnumberThe maximum value of progress.
<rapid-progress max="100">

Properties

This component doesn't have any properties which are not also controlled via attributes.

Slots

NameDescription
indeterminateThe content shown when no value is set (no progress is made).
determinateThe content shown when a value is set (some progress is made).

Parts

NameDescription
progressAvailable for the determinate progress slot.

Events fired

This component doesn't fire any events.

Events listened to

This component doesn't listen to any events.