Progress ring
Circular pixel progress ring with the percentage counting up in its centre; it turns green and throws a few sparks when it reaches 100%.
Playground
Change a prop and the component re-renders. Props marked remounts set an initial value, so the component starts over.
<PxRing value={72} size={120}>Weekly usage</PxRing>Installation
pnpm dlx shadcn@latest add @lumesec/px-ringFirst timeRegister the @lumesec registry once, or install by URL
Adds @lumesec to your components.json:
pnpm dlx shadcn@latest registry add @lumesec=https://elements.lumesec.ai/r/{name}.jsonOr skip the setup and install by URL:
npx shadcn@latest add https://elements.lumesec.ai/r/px-ring.jsonUsage
import { PxRing } from "@/components/lumesec/px-ring";
export function Example() {
return <PxRing value={72}>Weekly usage</PxRing>;
}Behaviour
A circular version with the percentage counting up in its centre. It turns green and throws a few sparks at 100%.
API reference
Props
Also accepts every prop of <div> (React.ComponentProps<"div">), spread onto the root element.
valueTypenumber | nullProgress from 0 to 100, clamped; the ring animates to it. null or leaving it out shows a spinning arc.
sizeTypenumberDefault120Diameter in pixels.
childrenTypeReact.ReactNodeCaption under the ring; it also labels the progress bar.
onCompleteType() => voidCalled when value reaches 100, and again each time it drops below 100 and returns, also while the ring is off screen. Not called when the ring starts at 100.
Ref
ref points at the root HTMLDivElement.
Accessibility
- The ring is a
divwithrole="progressbar",aria-valuemin="0",aria-valuemax="100"andaria-valuenow, which is left out when indeterminate. - The canvas and the percentage inside it are
aria-hidden; the number is the visible form ofaria-valuenow. - With a caption the ring is labelled by it through
aria-labelledby; without one itsaria-labelis "Progress". - There is no live region.
- Reduced motion: the ring and the number jump to the value, no sparks fire at 100%, and the indeterminate arc holds still.
Theming
Styled with Tailwind classes on your shadcn theme tokens, so light and dark follow your theme. The accent comes from --lumesec. See Theming.
This component reads --lumesec, --lumesec-shine, --lumesec-success, --foreground and --muted-foreground.
Notes
- The ring starts at the first
valueinstead of filling up from 0. - The percentage is text in the mono font with tabular figures, 27% of
sizehigh, and counts along with the fill. It turns green at 100%; the indeterminate ring shows no number.
Related
Was this page helpful?