Skip to content

UI Library for Design Engineers. Animated components and effects you can copy and paste into your apps. Free. Open Source.

1.8 KB
Raw Blame
---
title: Animated Circular Progress Bar
date: 2024-05-28
description: Animated Circular Progress Bar is a component that displays a circular gauge with a percentage value.
author: luis-codex
published: true
---

<ComponentPreview name="animated-circular-progress-bar-demo" />

## Installation

<Tabs defaultValue="cli">

<TabsList>
  <TabsTrigger value="cli">CLI</TabsTrigger>
  <TabsTrigger value="manual">Manual</TabsTrigger>
</TabsList>
<TabsContent value="cli">

```bash
npx shadcn@latest add @magicui/animated-circular-progress-bar
```

</TabsContent>

<TabsContent value="manual">

<Steps>

<Step>Copy and paste the following code into your project.</Step>

<ComponentSource name="animated-circular-progress-bar" />

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

</Steps>

</TabsContent>

</Tabs>

## Usage

```tsx showLineNumbers
import { AnimatedCircularProgressBar } from "@/components/ui/animated-circular-progress-bar"
```

```tsx showLineNumbers
<AnimatedCircularProgressBar />
```

## Props

| Prop                  | Type     | Default | Description                                   |
| --------------------- | -------- | ------- | --------------------------------------------- |
| `className`           | `string` | `-`     | The class name to be applied to the component |
| `max`                 | `number` | `100`   | The maximum value of the gauge                |
| `min`                 | `number` | `0`     | The minimum value of the gauge                |
| `value`               | `number` | `0`     | The current value of the gauge                |
| `gaugePrimaryColor`   | `string` | `-`     | The primary color of the gauge                |
| `gaugeSecondaryColor` | `string` | `-`     | The secondary color of the gauge              |

## Credits

- Credit to [@luis-code](https://luis-code.vercel.app/)