Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 37 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,58 +24,57 @@ This service is deployed on **[Vercel](https://vercel.com)** and accessible via

## βš™οΈ Parameters

| πŸ”§ Parameter | πŸ“œ Description | 🎯 Default Value |
|-------------|---------------|------------------|
| `title` | Adds a title to the progress bar | None |
| `scale` | The maximum value that the progress bar represents | 100 |
| `prefix` | A string to add before the progress number | None |
| `suffix` | A string to add after the progress number | `%` |
| `width` | The width of the progress bar in pixels | 100 |
| `color` | The color of the progress bar (hex code without `#`) | `00ff00` (green) |
| `progress_background` | The background color of the progress bar (hex code without `#`) | `ffffff` (white) |
| `progress_number_color` | The color of the progress number (hex code without `#`) | `000000` (black) |
| `progress_color` | The color of the progress bar (hex code without `#`) | Depends on percentage |
| `show_text` | If should display or hide the progress text | `true` |
| `style` | The style. One of: `default`, `flat`, `square`, `plastic`, `for-the-badge` | `default` |
| πŸ”§ Parameter | πŸ“œ Description | 🎯 Default Value |
| ----------------------- | -------------------------------------------------------------------------- | --------------------- |
| `title` | Adds a title to the progress bar | None |
| `scale` | The maximum value that the progress bar represents | 100 |
| `prefix` | A string to add before the progress number | None |
| `suffix` | A string to add after the progress number | `%` |
| `width` | The width of the progress bar in pixels | 100 |
| `color` | The color of the progress bar (hex code without `#`) | `00ff00` (green) |
| `progress_background` | The background color of the progress bar (hex code without `#`) | `ffffff` (white) |
| `progress_number_color` | The color of the progress number (hex code without `#`) | `000000` (black) |
| `progress_color` | The color of the progress bar (hex code without `#`) | Depends on percentage |
| `show_text` | Whether to display or hide the progress text | `true` |
| `style` | The style. One of: `default`, `flat`, `square`, `plastic`, `for-the-badge` | `default` |

### Examples

Below are several examples showcasing different ways to generate progress bars.

| πŸ“Œ Preview | 🌐 URL |
|---------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|
| ![Progress](https://progress-bar.xyz/28/) | [https://progress-bar.xyz/28/](https://progress-bar.xyz/28/) |
| ![Progress](https://progress-bar.xyz/28/?title=progress) | [https://progress-bar.xyz/28/?title=progress](https://progress-bar.xyz/28/?title=progress) |
| ![Progress](https://progress-bar.xyz/58/) | [https://progress-bar.xyz/58/](https://progress-bar.xyz/58/) |
| ![Progress](https://progress-bar.xyz/58/?title=completed) | [https://progress-bar.xyz/58/?title=completed](https://progress-bar.xyz/58/?title=completed) |
| ![Progress](https://progress-bar.xyz/91/) | [https://progress-bar.xyz/91/](https://progress-bar.xyz/91/) |
| ![Progress](https://progress-bar.xyz/91/?title=done) | [https://progress-bar.xyz/91/?title=done](https://progress-bar.xyz/91/?title=done) |
| ![Progress](https://progress-bar.xyz/180/?scale=10&title=mark&prefix=R$&suffix=)| [https://progress-bar.xyz/180/?scale=10&title=mark&prefix=R$&suffix=](https://progress-bar.xyz/180/?scale=10&title=mark&prefix=R$&suffix=) |
| ![Progress](https://progress-bar.xyz/420/?scale=500&title=funds&width=200&color=babaca&prefix=R$&suffix=) | [https://progress-bar.xyz/420/?scale=500&title=funds&width=200&color=babaca&prefix=R$&suffix=](https://progress-bar.xyz/420/?scale=500&title=funds&width=200&color=babaca&prefix=R$&suffix=) |
| ![Progress](https://progress-bar.xyz/7/?scale=10&title=mark&suffix=X) | [https://progress-bar.xyz/7/?scale=10&title=mark&suffix=X](https://progress-bar.xyz/7/?scale=10&title=mark&suffix=X) |
| ![Progress](https://progress-bar.xyz/420/?scale=500&title=funds&width=200&color=babaca&suffix=$) | [https://progress-bar.xyz/420/?scale=500&title=funds&width=200&color=babaca&suffix=$](https://progress-bar.xyz/420/?scale=500&title=funds&width=200&color=babaca&suffix=$) |
| πŸ“Œ Preview | 🌐 URL |
| ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ![Progress](https://progress-bar.xyz/28/) | [https://progress-bar.xyz/28/](https://progress-bar.xyz/28/) |
| ![Progress](https://progress-bar.xyz/28/?title=progress) | [https://progress-bar.xyz/28/?title=progress](https://progress-bar.xyz/28/?title=progress) |
| ![Progress](https://progress-bar.xyz/58/) | [https://progress-bar.xyz/58/](https://progress-bar.xyz/58/) |
| ![Progress](https://progress-bar.xyz/58/?title=completed) | [https://progress-bar.xyz/58/?title=completed](https://progress-bar.xyz/58/?title=completed) |
| ![Progress](https://progress-bar.xyz/91/) | [https://progress-bar.xyz/91/](https://progress-bar.xyz/91/) |
| ![Progress](https://progress-bar.xyz/91/?title=done) | [https://progress-bar.xyz/91/?title=done](https://progress-bar.xyz/91/?title=done) |
| ![Progress](https://progress-bar.xyz/180/?scale=10&title=mark&prefix=R$&suffix=) | [https://progress-bar.xyz/180/?scale=10&title=mark&prefix=R$&suffix=](https://progress-bar.xyz/180/?scale=10&title=mark&prefix=R$&suffix=) |
| ![Progress](https://progress-bar.xyz/420/?scale=500&title=funds&width=200&color=babaca&prefix=R$&suffix=) | [https://progress-bar.xyz/420/?scale=500&title=funds&width=200&color=babaca&prefix=R$&suffix=](https://progress-bar.xyz/420/?scale=500&title=funds&width=200&color=babaca&prefix=R$&suffix=) |
| ![Progress](https://progress-bar.xyz/7/?scale=10&title=mark&suffix=X) | [https://progress-bar.xyz/7/?scale=10&title=mark&suffix=X](https://progress-bar.xyz/7/?scale=10&title=mark&suffix=X) |
| ![Progress](https://progress-bar.xyz/420/?scale=500&title=funds&width=200&color=babaca&suffix=$) | [https://progress-bar.xyz/420/?scale=500&title=funds&width=200&color=babaca&suffix=$](https://progress-bar.xyz/420/?scale=500&title=funds&width=200&color=babaca&suffix=$) |
| ![Progress](https://progress-bar.xyz/58/?title=colorful&progress_background=ffc0cb&progress_number_color=000) | [https://progress-bar.xyz/58/?title=colorful&progress_background=ffc0cb&progress_number_color=000](https://progress-bar.xyz/58/?title=colorful&progress_background=ffc0cb&progress_number_color=000) |
| ![Progress](https://progress-bar.xyz/100/?progress_color=ff3300) | [https://progress-bar.xyz/58/?progress_color=ff3300](https://progress-bar.xyz/58/?progress_color=ff3300) |
| ![Progress](https://progress-bar.xyz/100/?width=100&title=Fixed+color&progress_color=ff3300) | [https://progress-bar.xyz/58/?width=100&title=Fixed+color&progress_color=ff3300](https://progress-bar.xyz/58/?width=100&title=Fixed+color&progress_color=ff3300) |
| ![Progress](https://progress-bar.xyz/28/?show_text=false) | [https://progress-bar.xyz/28/?show_text=false](https://progress-bar.xyz/28/?show_text=false) |
| ![Progress](https://progress-bar.xyz/90/?show_text=false) | [https://progress-bar.xyz/90/?show_text=false](https://progress-bar.xyz/90/?show_text=false) |
| ![Progress](https://progress-bar.xyz/100/?progress_color=ff3300) | [https://progress-bar.xyz/100/?progress_color=ff3300](https://progress-bar.xyz/100/?progress_color=ff3300) |
| ![Progress](https://progress-bar.xyz/100/?width=100&title=Fixed+color&progress_color=ff3300) | [https://progress-bar.xyz/100/?width=100&title=Fixed+color&progress_color=ff3300](https://progress-bar.xyz/100/?width=100&title=Fixed+color&progress_color=ff3300) |
| ![Progress](https://progress-bar.xyz/28/?show_text=false) | [https://progress-bar.xyz/28/?show_text=false](https://progress-bar.xyz/28/?show_text=false) |
| ![Progress](https://progress-bar.xyz/90/?show_text=false) | [https://progress-bar.xyz/90/?show_text=false](https://progress-bar.xyz/90/?show_text=false) |

---

## 🎨 Styles

We currently support:

| 🎨 Style | πŸ“Œ Preview | 🌐 URL |
|----------|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------|
| 🎨 Style | πŸ“Œ Preview | 🌐 URL |
| --------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| 🟒 **flat** (default) | ![Progress](https://progress-bar.xyz/100/?style=flat) | [https://progress-bar.xyz/100/?style=flat](https://progress-bar.xyz/100/?style=flat) |
| πŸ”² **square** |![Progress](https://progress-bar.xyz/100/?style=square) | [https://progress-bar.xyz/100/?style=square](https://progress-bar.xyz/100/?style=square) |
| πŸ›‘οΈ **plastic** | ![Progress](https://progress-bar.xyz/100/?style=plastic) | [https://progress-bar.xyz/100/?style=plastic](https://progress-bar.xyz/100/?style=plastic) |
| πŸ”– **for-the-badge** | ![Progress](https://progress-bar.xyz/100/?style=for-the-badge) | [https://progress-bar.xyz/100/?style=for-the-badge](https://progress-bar.xyz/100/?style=for-the-badge) |
| 🎭 **thin-rounded** |![Progress](https://progress-bar.xyz/100/?style=thin-rounded) | [https://progress-bar.xyz/100/?style=thin-rounded](https://progress-bar.xyz/100/?style=thin-rounded) |
| πŸͺž **neo-glass** | ![Progress](https://progress-bar.xyz/100/?style=neo-glass) | [https://progress-bar.xyz/100/?style=neo-glass](https://progress-bar.xyz/100/?style=neo-glass) |
| 🎨 **minimal-matte** | ![Progress](https://progress-bar.xyz/100/?style=minimal-matte) | [https://progress-bar.xyz/100/?style=minimal-matte](https://progress-bar.xyz/100/?style=minimal-matte) |

| πŸ”² **square** | ![Progress](https://progress-bar.xyz/100/?style=square) | [https://progress-bar.xyz/100/?style=square](https://progress-bar.xyz/100/?style=square) |
| πŸ›‘οΈ **plastic** | ![Progress](https://progress-bar.xyz/100/?style=plastic) | [https://progress-bar.xyz/100/?style=plastic](https://progress-bar.xyz/100/?style=plastic) |
| πŸ”– **for-the-badge** | ![Progress](https://progress-bar.xyz/100/?style=for-the-badge) | [https://progress-bar.xyz/100/?style=for-the-badge](https://progress-bar.xyz/100/?style=for-the-badge) |
| 🎭 **thin-rounded** | ![Progress](https://progress-bar.xyz/100/?style=thin-rounded) | [https://progress-bar.xyz/100/?style=thin-rounded](https://progress-bar.xyz/100/?style=thin-rounded) |
| πŸͺž **neo-glass** | ![Progress](https://progress-bar.xyz/100/?style=neo-glass) | [https://progress-bar.xyz/100/?style=neo-glass](https://progress-bar.xyz/100/?style=neo-glass) |
| 🎨 **minimal-matte** | ![Progress](https://progress-bar.xyz/100/?style=minimal-matte) | [https://progress-bar.xyz/100/?style=minimal-matte](https://progress-bar.xyz/100/?style=minimal-matte) |

---

Expand Down Expand Up @@ -176,4 +175,3 @@ Check out [CONTRIBUTING.md](CONTRIBUTING.md) to learn how to contribute!
This project is licensed under the **MIT License**.

πŸ“„ See [LICENSE](LICENSE) for details.