Progress

Progress is a visual indicator showing completion percentage or loading state.

Open in Storybook

Import

import { Progress } from "@tosui/react";

Basic usage

Preview

Code

<Progress value={60} />

Values

Preview

Code

<VStack gap={4}>
  <Progress value={0} />
  <Progress value={25} />
  <Progress value={50} />
  <Progress value={75} />
  <Progress value={100} />
</VStack>

Sizes

Preview

sm (4px)

md (8px)

lg (12px)

Code

<VStack gap={4}>
  <Progress value={60} size="sm" />
  <Progress value={60} size="md" />
  <Progress value={60} size="lg" />
</VStack>

Color schemes

Preview

Code

<VStack gap={4}>
  <Progress value={60} colorScheme="primary" />
  <Progress value={60} colorScheme="accent" />
  <Progress value={60} colorScheme="success" />
  <Progress value={60} colorScheme="warning" />
  <Progress value={60} colorScheme="error" />
  <Progress value={60} colorScheme="info" />
</VStack>

Indeterminate

Use isIndeterminate for loading states where progress is unknown.

Preview

Code

<Progress isIndeterminate />

Custom max value

Preview

3 of 10 complete

Code

<Progress value={3} max={10} />

Common patterns

With a label

<VStack gap={1}>
  <HStack justify="space-between">
    <Text size="sm">Uploading...</Text>
    <Text size="sm">60%</Text>
  </HStack>
  <Progress value={60} />
</VStack>

Step progress

function StepProgress({ currentStep, totalSteps }) {
  return (
    <VStack gap={2}>
      <Text size="sm" color="foreground-muted">
        Step {currentStep} of {totalSteps}
      </Text>
      <Progress value={currentStep} max={totalSteps} />
    </VStack>
  );
}

File upload

function FileUpload() {
  const [progress, setProgress] = useState(0);

  return (
    <VStack gap={2}>
      <HStack justify="space-between" w="100%">
        <Text size="sm">document.pdf</Text>
        <Text size="sm">{progress}%</Text>
      </HStack>
      <Progress value={progress} colorScheme="success" />
    </VStack>
  );
}

Props reference

Prop	Type	Default	Description
value	number	0	Progress value
max	number	100	Maximum value
colorScheme	"primary" | "accent" | "success" | "warning" | "error" | "info"	"primary"	Color scheme
size	"sm" | "md" | "lg"	"md"	Progress bar height
isIndeterminate	boolean	false	Show animated loading state
className	string	-	Additional CSS class

Accessibility

• Uses role="progressbar"
• aria-valuenow, aria-valuemin, aria-valuemax for determinate progress
• Indeterminate mode omits aria-valuenow

TypeScript

import { Progress, type ProgressColorScheme, type ProgressSize, type ProgressProps } from "@tosui/react";