# react-native-speedometer-chart

> Speedometer Chart component for React Native

Latest version **0.7.5** (published 2020-02-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-speedometer-chart
pnpm add react-native-speedometer-chart
yarn add react-native-speedometer-chart
bun add react-native-speedometer-chart
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.7.5 |
| Published | 2020-02-27 |
| First published | 2018-03-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 85.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 45 |
| Author | Lucas Monteiro |
| Maintainers | lucas.monteiro |
| Keywords | React Native, react-native, chart, speedometer, gauge, android, ios |

## Links

- npm: https://www.npmjs.com/package/react-native-speedometer-chart
- Repository: https://github.com/LucasMonteiro1/react-native-speedometer-chart
- Homepage: https://github.com/LucasMonteiro1/react-native-speedometer-chart#readme
- Issues: https://github.com/LucasMonteiro1/react-native-speedometer-chart/issues
- npm.io page: https://npm.io/package/react-native-speedometer-chart

## Dependencies (2)

- [color](https://npm.io/package/color.md) ^3.1.2
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 0.7.5 (latest) — 2020-02-27
- 0.7.4 — 2020-01-31
- 0.7.3 — 2019-03-14
- 0.7.2 — 2019-03-06
- 0.7.1 — 2019-02-20
- 0.7.0 — 2019-02-20
- 0.6.4 — 2018-09-10
- 0.6.3 — 2018-08-02
- 0.6.2 — 2018-05-09
- 0.6.1 — 2018-03-23
- 0.6.0 — 2018-03-22
- 0.5.0 — 2018-03-16
- 0.4.3 — 2018-03-16
- 0.4.0 — 2018-03-16
- 0.3.0 — 2018-03-16
- … 4 more at https://npm.io/package/react-native-speedometer-chart/versions

## README

# React Native Speedometer Chart
[![npm version](https://badge.fury.io/js/react-native-speedometer-chart.svg)](https://badge.fury.io/js/react-native-speedometer-chart) [![npm downloads](https://img.shields.io/npm/dt/react-native-speedometer-chart.svg)](https://npm-stat.com/charts.html?package=react-native-speedometer-chart) [![Publish Package](https://github.com/LucasMonteiro1/react-native-speedometer-chart/workflows/Publish%20Package/badge.svg?branch=master&event=push)](https://github.com/LucasMonteiro1/react-native-speedometer-chart/actions)   
[![NPM](https://nodei.co/npm/react-native-speedometer-chart.png?downloads=true)](https://nodei.co/npm/react-native-speedometer-chart/)
---
Speedometer Chart component for React Native

## Installation

```
npm install --save react-native-speedometer-chart
```
```
yarn add react-native-speedometer-chart
```

## Try it out
You can try out the [Speedometer Chart Example
](https://expo.io/@lucasmonteiro1/speedometer-chart-example) app to get a tease of the functionalities of this lib.


## Props
| Prop | Default | Type | Required | Description |
| --- | --- | --- | --- | --- |
| value | none | number | `yes` | Value to be painted |
| totalValue | none | number | `yes` | Total value |
| size | 200 | number | no | Chart size |
| innerColor | #ffffff | string | no | `value` color |
| outerColor | #e6e6e6 | string | no | `value` color |
| internalColor | #2eb82e | string | no | `totalValue` color |
| style | {} | object | no | Additional style |
| showText | false | bool | no | Show center text |
| text | '' | string/number | no | Center text |
| textStyle | {} | object | no | Center text style |
| showLabels | false | bool | no | Show labels |
| labelStyle | {} | object | no | Label style |
| labelFormatter | number => number | func | no | Label formatter |
| showPercent | false | bool | no | Show center percent |
| percentStyle | {} | object | no | Percent style |
| innerCircleStyle | null | object | no | |
| outerCircleStyle | null | object | no | |
| halfCircleStyle | null | object | no | |
| percentSize | 0.5 | number | no | |
| showIndicator | false | bool | no | Show a needle |
| indicatorColor | #808080 | string | no | `value` color |

## Basic Usage

```javascript
import React, { Component } from 'react';
import Speedometer from 'react-native-speedometer-chart';

export default class Main extends Component {
  render() {
    return (
      <Speedometer value={50} totalValue={100}/>
    );
  }
}
```

## Examples

```javascript
  <Speedometer value={25} totalValue={100}/>
```
![25%](docs/image2.png?raw=true "25% of value")
```javascript
  <Speedometer value={50} totalValue={100}/>
```
![50%](docs/image1.png?raw=true "50% of value")
```javascript
  <Speedometer value={75} totalValue={100}/>
```
![75%](docs/image3.png?raw=true "75% of value")
```javascript
  <Speedometer value={100} totalValue={100}/>
```
![100%](docs/image4.png?raw=true "100% of value")
```javascript
  <Speedometer
    value={50}
    totalValue={150}
    size={250}
    outerColor="#d3d3d3"
    internalColor="#ff0000"
    showText
    text="50.00"
    textStyle={{ color: 'green' }}
    showLabels
    labelStyle={{ color: 'blue' }}
    labelFormatter={number => `${number}%`}
    showPercent
    percentStyle={{ color: 'red' }}
  />
```
![Total usage](docs/image5.png?raw=true "total usage")

```javascript
  <Speedometer value={0} totalValue={100} showIndicator />
  <Speedometer value={25} totalValue={100} showIndicator />
  <Speedometer value={50} totalValue={100} showIndicator />
  <Speedometer value={75} totalValue={100} showIndicator />
  <Speedometer value={100} totalValue={100} showIndicator />
```
![](docs/image6.png?raw=true "Needle indicator")

## License
MIT

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