Skip to content

Components

ProgressRing

Exporting project files

Component reference

Properties

Use ProgressRing

Circular task progress for compact rows, cards and panels.

Example import style
progress-ring.tsxTSX
"use client";

import { FloodRoot, ProgressRing } from "@flood-md/react";
import "@flood-md/react/styles.css";

export function Example() {
  return (
    <FloodRoot>
      <ProgressRing label="Exporting files" value={60} valueText="6 of 10 files" />
    </FloodRoot>
  );
}

Design notes

  • Use ProgressRing for a single task with a compact circular track. Use Progress when a horizontal track can use the available width, and DonutChart for categories as parts of a whole.
  • The ring shares Progress range semantics. Max defaults to 100. Omit value for indeterminate progress; 0 and max represent empty and complete tracks.
  • Supply localized valueText for a visible amount or an indeterminate state. hideLabel hides the caption and keeps its accessible name and value text. Size accepts sm, md and lg.
  • Progress is host-owned. The ring has no tab stop or live announcement. Reduced motion keeps an indeterminate arc visible without rotation.

API reference

PropValuesDefault
labelstringRequired
valuenumber—
maxnumber100
valueTextstring—
size"sm" | "md" | "lg""md"
tone"neutral" | "accent" | "error" | "warning" | "success" | "info""accent"
hideLabelbooleanfalse
Native HTML propsOmit<Omit<HTMLAttributes<HTMLDivElement>, "children" | "role">, "layout">Forwarded
View TypeScript source