CircularProgress

Usage

import { CircularProgress } from "@devvy-ui/react";

<CircularProgress label="Preparing export" value={65} showValue />

API reference

Native HTML attributes, className, style and a forwarded ref are supported. Component-specific props:

Prop	Type	Default	Description
label	string	required	Accessible task name.
value / max	number / number	indeterminate / 100	Finite bounded task progress.
size / showValue	sm \| md \| lg / boolean	md / false	Dimensions and visible percentage.

Source ownership

Run npx @devvy-ui/cli init once in your React project, then add the source:

npx @devvy-ui/cli add circular-progress

Make the source yours.

Start from the canonical implementation used by the package and registry. Change the code, keep the MIT notice, and build the behavior your project needs.

CircularProgress.tsxREACT / TSX

import { forwardRef, type HTMLAttributes } from 'react';
import { cx } from '../lib/cx';
export interface CircularProgressProps extends HTMLAttributes<HTMLDivElement> {
  label: string;
  value?: number;
  max?: number;
  size?: 'sm' | 'md' | 'lg';
  showValue?: boolean;
}
export const CircularProgress = forwardRef<HTMLDivElement, CircularProgressProps>(
  function CircularProgress(
    { label, value, max = 100, size = 'md', showValue = false, className, ...props },
    ref,
  ) {
    const limit = Number.isFinite(max) && max > 0 ? max : 100;
    const current =
      value !== undefined && Number.isFinite(value)
        ? Math.min(limit, Math.max(0, value))
        : undefined;
    const percent = current === undefined ? undefined : Math.round((current / limit) * 100);
    return (
      <div
        role="progressbar"
        aria-label={label}
        {...props}
        ref={ref}
        aria-valuemin={0}
        aria-valuemax={limit}
        aria-valuenow={current}
        className={cx('dvy-circular-progress', className)}
        data-size={size}
      >
        <svg viewBox="0 0 48 48" aria-hidden="true" focusable="false">
          <circle className="dvy-circular-track" cx="24" cy="24" r="20" />
          <circle
            className="dvy-circular-value"
            cx="24"
            cy="24"
            r="20"
            pathLength="100"
            strokeDasharray={current === undefined ? '18 12' : (current / limit) * 100 + ' 100'}
            transform="rotate(-90 24 24)"
          />
        </svg>
        {showValue && <span aria-hidden="true">{percent === undefined ? '…' : percent + '%'}</span>}
      </div>
    );
  },
);

Edit your own copy. Downloaded source uses your changes; the component preview above uses the shipped version. Run the source installer first to include shared helpers.

Interactive preview

Usage

API reference

Accessibility & behavior

Platform Behavior & Guidelines

Source ownership

Make the source yours.