# vue-doughnut-progress

> An animated responsive circular progress for Vue 3

Latest version **1.0.7** (published 2022-05-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-doughnut-progress
pnpm add vue-doughnut-progress
yarn add vue-doughnut-progress
bun add vue-doughnut-progress
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2022-05-29 |
| First published | 2022-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=12 |
| Dependencies | 0 |
| Unpacked size | 19.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Bizhan Hejazi |
| Maintainers | bizhan.he1996 |
| Keywords | vue, vue3, progress, circular-progress, doughnut-progress |

## Links

- npm: https://www.npmjs.com/package/vue-doughnut-progress
- Repository: https://github.com/bizhanhe1996/vue-doughnut-progress
- Homepage: https://github.com/bizhanhe1996/vue-doughnut-progress#readme
- Issues: https://github.com/bizhanhe1996/vue-doughnut-progress/issues
- npm.io page: https://npm.io/package/vue-doughnut-progress

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.0.7 (latest) — 2022-05-29
- 1.0.6 — 2022-05-29
- 1.0.5 — 2022-05-23
- 1.0.4 — 2022-05-23
- 1.0.3 — 2022-05-17
- 1.0.2 — 2022-05-16
- 1.0.1 — 2022-05-16

## README

<p style="text-align:center">
    <img src="https://github.com/bizhanhe1996/vue-doughnut-progress/blob/master/demo.gif?raw=true" width="250" height="250">
</p>

# vue-doughnut-progress
An animated responsive Circular Progress Bar for Vue 3

## Demo
A demo of the package is available <a href="https://bz06xb.csb.app/">HERE</a>

## Getting started
1. Install it using npm: 
```
npm i vue-doughnut-progress
```
2. Import it into your vue file:
```
import VueDoughnutProgress from 'vue-doughnut-progress';
```
3. Register it (Locally or Globally)
```
components: {
    VueDoughnutProgress
}
```
4. Add it to your template with the properties:
```
<VueDoughnutProgress
    radius="50"
    thickness="5"
    color="red"
    percent="23"
    :text="{
        text:'<p style=`text-align:center`>Doughnut<br/>Progress</p>',
        bold: true,
        size: 14
    }" 
/>
```
    
## Properties
| name | type | map | description |
| ---- | ---- | --- | ------------|
| radius | Integer | | radius of the progress circle, no need to add px |
| thickness | Integer | | thickness of circle, no need to add px|
| color | String | | color of progress, could be a color name or a HEX color code|
| percent | Integer | | an integer ranging from 0 to 100, no need to add % |
| text | Object | {<br>text: String,<br/>bold: Boolean,<br/>size: Integer<br/>} | An object with properties about the text inside the progress circle <br/> <ul><li>**text**: the text inside the progress cirlce, could be simple string or HTML </li><li> **bold**: whether the text inside the circle is bold or not, either true or false </li><li> **size**: font-size of the text inside the circle, no need to add px</li></ul> |

---
_Source: https://npm.io/package/vue-doughnut-progress · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._