Shoalrun documentation framework
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
Reference

Progress

Show a bounded count with a visible label and native progress bar.

Updated
Read as Markdown

Use <Progress> for a published count in a tutorial or migration guide. It shows the amount completed as text and as a bar. Update the source and rebuild the site when the shared state changes.

Syntax

<Progress label="Migration tasks" value="3" max="5" />

Migration tasks: 3 of 5 complete

3 of 5
Attribute Required Meaning
label Yes Nonempty name shown beside the count and used as the bar's accessible name.
value Yes A number from zero through max.
max Yes A number greater than zero.

<Progress> is a block element without a body. All three attributes must be literal values. The build rejects a value outside the range or a maximum of zero.

When to use it

Use this component when a count has a known maximum, such as 3 of 5 migration tasks complete. It is a read-only display: readers cannot mark a task complete or move the bar. For a process with named stages and descriptions, use a timeline.

HTML, Markdown, and agents

HTML shows “Migration tasks: 3 of 5 complete” alongside a native <progress> element. The text carries the count even without CSS or color. There is no JavaScript behavior or keyboard control.

Markdown states the same label and count in a sentence. An agent does not need to estimate completion from the bar.

Often confused with