Skip to content
🌏 Translated with the assistance of DeepSeek and ChatGPT

CircleProgress

I feel like this pixel‑style circular progress bar is really hard to draw.

Basic Usage

Set the progress of CircleProgress with the percentage prop (0 - 100). Values outside this range are automatically clamped between 0 and 100.

50%
Hide source code

Themes

CircleProgress offers various themes: 'primary' (default), 'sakura', 'success', 'warning', 'danger' and 'notice'.

20%
35%
50%
65%
80%
100%
Hide source code

Sizes

Control the size of CircleProgress with the size prop (px). The default is 128.

30%
50%
70%
100%
Hide source code

Stroke Width

The strokeWidth prop controls the thickness of the ring of CircleProgress. The default is 12.

60%
60%
60%
60%
Hide source code

Custom Color

Pass a custom color string to CircleProgress to generate a palette used by the ring. The supported color formats are detailed in Supported Color Parsing. Use trackColor to override the track background color.

35%
65%
100%
Hide source code

Text & Custom Content

The percentage text is shown in the center of CircleProgress by default. Set showText to false to hide it, or use the default slot to render custom content. The slot exposes a percentage parameter.

60%
Hide source code

API

CircleProgressProps

AttributeTypeOptionalDefaultDescriptionVersion
percentagenumberTrue0The completion progress (0-100) of CircleProgress, clamped automatically when out of range.0.2.0
theme'primary' | 'sakura' | 'success' | 'warning' | 'danger' | 'notice'True'primary'The theme of CircleProgress.0.2.0
sizenumberTrue128The size of CircleProgress.0.2.0
strokeWidthnumberTrue12The thickness of the ring of CircleProgress.0.2.0
colorstringTrueCustom primary color of CircleProgress. See Supported Color Parsing.0.2.0
trackColorstringTrueThe background color of the ring track of CircleProgress.0.2.0
showTextbooleanTruetrueWhether to show the percentage text in the center of CircleProgress.0.2.0
pollSizeChangebooleanTruefalseWhether to poll for size changes of CircleProgress.0.2.0

CircleProgressSlots

SlotParameterDescriptionVersion
defaultpercentage: numberThe default slot in the center of CircleProgress, used for custom content.0.2.0