Skip to content
v0.2.10

Progress

Completion of a task, with a determinate or unknown value.

Preview
Uploading files

Use Progress

Progress is a named export of @flood-md/react. Connect the package once, then import what you use.

First time here? Connect Flood
Example import style
progress.tsxTSX
"use client";

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

export function Example() {
  return (
    <FloodRoot>
      <Progress label="Uploading files" value={60} valueText="60%" />
    </FloodRoot>
  );
}

Design notes

  • Omit value for indeterminate progress. The accessible progressbar omits aria-valuenow in that state.
  • Max defaults to 100; values must be finite and inside 0..max. Invalid ranges throw instead of silently inventing a percentage.
  • hideLabel removes the caption visually while keeping the accessible name. valueText supplies human-readable units.
  • This is not a live region or a task manager. Native div props, className/style and ref target the wrapper. Available in 0.2.4.

API reference

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