# react-native-progress-circle

> A light-weight progress circle indicator for React Native.

Latest version **2.1.0** (published 2019-10-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-progress-circle
pnpm add react-native-progress-circle
yarn add react-native-progress-circle
bun add react-native-progress-circle
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2019-10-24 |
| First published | 2017-05-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 15.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 190 |
| Author | Christoph Michel |
| Maintainers | cmichel |
| Keywords | react, react native, percentage, circle, progress, indicator |

## Links

- npm: https://www.npmjs.com/package/react-native-progress-circle
- Repository: https://github.com/MrToph/react-native-progress-circle
- Homepage: https://github.com/MrToph/react-native-progress-circle#readme
- Issues: https://github.com/MrToph/react-native-progress-circle/issues
- npm.io page: https://npm.io/package/react-native-progress-circle

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.1.0 (latest) — 2019-10-24
- 2.0.1 — 2018-10-28
- 2.0.0 — 2017-09-09
- 1.0.3 — 2017-05-18
- 1.0.2 — 2017-05-14
- 1.0.1 — 2017-05-13
- 1.0.0 — 2017-05-13
- 0.0.1 — 2017-05-10

## README

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()
[![Version](https://img.shields.io/npm/v/react-native-progress-circle.svg)](https://www.npmjs.com/package/react-native-progress-circle)
[![npm](https://img.shields.io/npm/dt/react-native-progress-circle.svg)](https://www.npmjs.com/package/react-native-progress-circle)
[![Twitter Follow](https://img.shields.io/twitter/follow/cmichelio.svg?style=social&label=Follow)](https://twitter.com/cmichelio)

# React Native Progress Circle

![React Native Progress Circles](/README/featured.png?raw=true "React Native Progress Circles")

## Features

* Custom colors
* Custom size and border radius
* Light-weight: No other dependencies besides `react-native`

## Installation

`yarn add react-native-progress-circle`

or

`npm install --save react-native-progress-circle`

## Usage

```javascript
import ProgressCircle from 'react-native-progress-circle'

render() {
    return (
        <ProgressCircle
            percent={30}
            radius={50}
            borderWidth={8}
            color="#3399FF"
            shadowColor="#999"
            bgColor="#fff"
        >
            <Text style={{ fontSize: 18 }}>{'30%'}</Text>
        </ProgressCircle>
    )
}
```

## Props
| Name | Description | Type | Required | Default Value |
| :--- | :----- | :--- | :---: | :---: |
| percent | The percentage used for displaying the progress | Number | ✓ |  |
| radius | The radius in `px` of the component (including border) | Number | ✓ |  |
| borderWidth | The border width in `px` | Number | ✓ |  |
| color | The border color | String |  | ![#f00](https://placehold.it/15/f00/000000?text=+) `'#f00'` |
| shadowColor | The background color of the border | String |  | ![#999](https://placehold.it/15/999/000000?text=+) `'#999'` |
| bgColor | The inner background color of the component  | String |  | ![#e9e9ef](https://placehold.it/15/e9e9ef/000000?text=+) `'#e9e9ef'` |
| children | The children to render inside this component | Node |  | `null` |
| containerStyle | The custom styling which will be applied to the container of the `children` | Style |  | `null` |
| outerCircleStyle | The custom styling which will be applied to the outer circle | Style |  | `null` |

## Author

[Christoph Michel](http://cmichel.io)

## Implementation Details

[React Native Progress Circle](http://cmichel.io/react-native-progress-circle)

## License

MIT

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