# Progress Bar

Determinate progress bar with percent and value/total display



<ComponentPreview base="opentui" name="progress-bar-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/opentui-progress-bar
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource base="opentui" name="progress-bar" title="components/ui/progress-bar.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { ProgressBar } from "@/components/ui/progress-bar";
```

```tsx
<ProgressBar value={42} total={100} label="Uploading" />
```

Examples [#examples]

Custom Characters and Color [#custom-characters-and-color]

<ComponentPreview base="opentui" name="progress-bar-custom" />

API Reference [#api-reference]

ProgressBar [#progressbar]

| Prop          | Type      | Default    |
| ------------- | --------- | ---------- |
| `value`       | `number`  | `required` |
| `total`       | `number`  | -          |
| `width`       | `number`  | `30`       |
| `showPercent` | `boolean` | `true`     |
| `showEta`     | `boolean` | `false`    |
| `fillChar`    | `string`  | `"█"`      |
| `emptyChar`   | `string`  | `"░"`      |
| `color`       | `string`  | -          |
| `label`       | `string`  | -          |
