# Progress

> Linear progress indicator with determinate and indeterminate modes.

- Status: stable
- Group: feedback
- Page: https://www.digitaltableteur.com/design-system/components/progress
- Contract: https://www.digitaltableteur.com/contracts/v1/Progress.contract.json

## When to use

Progress is the linear bar for work with visible movement: pass value (against max, default 100) when completion is measurable, or indeterminate when the duration is unknown but you want a bar-shaped affordance (e.g. a full-width page or panel load). The state prop recolors the fill semantically; success for a finished upload, error for a failed one. Rule of thumb across the loading family: Spinner for sub-second unknown waits, Progress for known or long-running work, Skeleton for placeholder layouts.

## When not to use

- Do not use Progress as a skeleton or layout placeholder; Skeleton owns loading layouts.
- Do not leave the generic default "Progress" aria-label on user-facing bars; name the work being done.
- Do not use Progress as a placeholder for content that is loading; Skeleton mirrors the layout; Progress claims measurable work.

## Look-alikes

- Skeleton: Do not use Progress as a skeleton or layout placeholder; Skeleton owns loading layouts.
- Spinner: Do not use Spinner for waits you can measure or that routinely exceed a couple of seconds; that is Progress territory.

## Props

| Prop | Type | Default | Description | Required |
| --- | --- | --- | --- | --- |
| `value` | `number` | `0` | Current progress value, scaled against max and clamped to 0..max. | No |
| `max` | `number` | `100` | Maximum value. | No |
| `label` | `string` | none | Accessible name for the progressbar. Defaults to the translated "Progress" (`progress.label`). | No |
| `size` | `"sm" \| "md" \| "lg"` | `md` | Track height token. | No |
| `state` | `"info" \| "success" \| "warning" \| "error" \| "neutral"` | `neutral` | Semantic fill color. | No |
| `indeterminate` | `boolean` | `false` | Unknown duration: animates a sweeping bar and drops aria-valuenow. | No |
| `className` | `string` | none | Optional utility classes on the root. | No |

## Variants

- Available sizes: `sm`, `md`, `lg` (default `md`).
- Allowed `state` values: `info`, `success`, `warning`, `error`, `neutral` (default `neutral`).

## Invalid combinations

- SHOULD NOT: When `indeterminate` is `true`, then do not set `value`. An indeterminate bar drops aria-valuenow and ignores `value`. Pass `value` only for determinate progress.

## Keyboard

The contract records no keyboard interaction.

## Rules

Every item under When not to use is a MUST NOT. MUST and SHOULD follow RFC 2119.

| Level | Rule | How it is checked |
| --- | --- | --- |
| SHOULD NOT | When `indeterminate` is `true`, then do not set `value`. An indeterminate bar drops aria-valuenow and ignores `value`. Pass `value` only for determinate progress. | Checked by the MCP tool validate_component_usage (rule `progress-indeterminate-ignores-value`). Also enforced in code: Progress.tsx: aria-valuenow and scale are skipped when indeterminate. |
| MUST | ARIA: Role=progressbar with aria-valuemin/aria-valuemax. | Not yet verified: no evidence record. WCAG 4.1.2. |
| MUST | ARIA: Aria-valuenow is value clamped to 0..max and rounded, matching the visual fill; omitted in indeterminate mode. | Not yet verified: no evidence record. WCAG 4.1.2. |
| MUST | ARIA: Aria-label from the label prop, which defaults to the translated "Progress" (`progress.label`) | Not yet verified: no evidence record. WCAG 4.1.2. |
| MUST | Required stories produce no axe violations at the configured severity. | Automated by `npm run test:stories:matrix:ci`. WCAG 2.5.8. |
| MUST | The accessibility tree (role, name, state) matches the committed snapshot for every required story. | Automated by `npm run test:stories:matrix:ci`. WCAG 1.3.1, 4.1.2. |
| MUST | The component remains legible and operable under a real browser forced-colors: active pass. | Automated by `npm run test:stories:hc`. |
| MUST | A human completed an end-to-end accessibility review of this component. | Manual review, last on 2026-11-04. |
| SHOULD | Name the work in the label prop ("Upload progress", "Profile completeness"); it is the aria-label AT users hear. | Not stated in the contract. |
| SHOULD | Switch state to success or error at completion so the outcome is visible without reading numbers. | Not stated in the contract. |
| SHOULD | Use indeterminate for unknown durations that deserve a bar (panel or page loads); the sweep keeps motion under reduced-motion by slowing, not freezing. | Not stated in the contract. |
| SHOULD | Pair the bar with a visible Text value or label when precision matters; the bar alone communicates proportion, not numbers. | Not stated in the contract. |
| SHOULD NOT | Do not animate value backwards or reset it mid-task; regressing progress reads as an error even when it is not. | Not stated in the contract. |

## Install and import

- Install: `npm install @digitaltableteur/react` (version 0.9.1, restricted access on npm).
- Import: `import { Progress } from "@digitaltableteur/react";`
- Entry point: `@digitaltableteur/react/feedback` exports it too.
- Styles: import `@digitaltableteur/react/style.css` once at the app boundary.
- Also available as the custom element `<dt-progress>`; see the custom elements manifest.

## Links

- Machine-readable contract (Design System Contract 1.0): https://www.digitaltableteur.com/contracts/v1/Progress.contract.json
- Markdown version of this page: https://www.digitaltableteur.com/design-system/components/progress.md
- Component index as JSON: https://www.digitaltableteur.com/design-system/components.json
- All components: https://www.digitaltableteur.com/design-system/components
- Source: The implementation lives in a private repository. This page, its Markdown twin and the contract are generated from it at build time and are the public source of truth.