react-progress-label/README.md

progress label component

# react-progress-label

[![npm](https://img.shields.io/npm/v/react-progress-label.svg)](https://www.npmjs.com/package/react-progress-label)
[![npm](https://img.shields.io/npm/dm/react-progress-label.svg)](https://www.npmjs.com/package/react-progress-label)
[![Build Status](https://travis-ci.org/swiftcarrot/react-progress-label.svg?branch=master)](https://travis-ci.org/swiftcarrot/react-progress-label)
[![codecov](https://codecov.io/gh/swiftcarrot/react-progress-label/branch/master/graph/badge.svg)](https://codecov.io/gh/swiftcarrot/react-progress-label)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

Progress component for React and React Native

![screenshot](https://raw.githubusercontent.com/swiftcarrot/react-progress-label/master/screenshot.png)

### Installation

```sh
yarn add react-progress-label
npm install react-progress-label --save
```

### Demo

[https://swiftcarrot.dev/react-progress-label](https://swiftcarrot.dev/react-progress-label)

### Usage

```javascript
<ProgressLabel
  progress={50}
  startDegree={60}
  progressWidth={8}
  trackWidth={20}
  trackBorderWidth={0}
  trackBorderColor="#0000ff"
  cornersWidth={4}
  size={400}
  fillColor="black"
  trackColor="red"
  progressColor="green"
/>
```

### React Native usage

We need to install [react-native-svg](https://github.com/react-native-community/react-native-svg) first. The native version implements the same api as the web version.

```javascript
import ProgressLabel from 'react-progress-label';
```

This project is inspired by [kirualex/KAProgressLabel](https://github.com/kirualex/KAProgressLabel).

### License

ISC