# ReadingProgress

> Scroll-linked reading progress indicator for long content.

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

## When to use

Scroll-linked progress indicator for long articles. Visual affordance only; it must never be the sole navigation or position cue.

## When not to use

The contract records no forbidden uses.

## Look-alikes

The contract names no look-alike with a deciding condition.

## Props

| Prop | Type | Default | Description | Required |
| --- | --- | --- | --- | --- |
| `targetRef` | `RefObject<HTMLElement \| null>` | none | Ref to the content container to track. | Yes |
| `showPercentage` | `boolean` | `false` | Show percentage text. Defaults to `false`. | No |
| `className` | `string` | none | No description in the contract. | No |

## Variants

No variant dimensions and no props with a fixed set of values.

## Invalid combinations

The contract records no invalid combinations.

## 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 |
| --- | --- | --- |
| MUST | ARIA: Progressbar role with aria-valuenow 0-100. | Not yet verified: no evidence record. WCAG 4.1.2. |
| MUST | ARIA: The progressbar's aria-label is the translated "Reading progress" (`readingProgress.label`: "Lukemisen edistyminen" in FI, "Läsförlopp" in SV) | 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. |
| MUST NOT | Maintainers: Do not bypass design tokens or skip forced-colors verification at beta. | Release review; not machine-checked. |

## Install and import

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

## Links

- Machine-readable contract (Design System Contract 1.0): https://www.digitaltableteur.com/contracts/v1/ReadingProgress.contract.json
- Markdown version of this page: https://www.digitaltableteur.com/design-system/components/reading-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.