# rgauge

> Gauges in React using SVG

Latest version **0.1.3** (published 2019-11-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install rgauge
pnpm add rgauge
yarn add rgauge
bun add rgauge
```

## 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.1.3 |
| Published | 2019-11-04 |
| First published | 2019-11-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | adamhalasz |
| Maintainers | adamhalasz |
| Keywords | react, gauge, svg, graph, visualization, meter |

## Links

- npm: https://www.npmjs.com/package/rgauge
- Repository: https://github.com/adamhalasz/rgauge
- Homepage: https://github.com/adamhalasz/rgauge#readme
- Issues: https://github.com/adamhalasz/rgauge/issues
- npm.io page: https://npm.io/package/rgauge

## 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

- 0.1.3 (latest) — 2019-11-04
- 0.1.2 — 2019-11-04

## README

# React Radial Gauge 2

This is a fork of the original react-radial-gauge repository with some additional progress font options.

![Gauge 1](https://veerasundar.com/img/gauges/opt-1.png) ![Gauge 2](https://veerasundar.com/img/gauges/opt-2.png) ![Gauge 3](https://veerasundar.com/img/gauges/opt-3.png)

Create beautiful gauges in React. Customize each part of the gauge components to your need. 

## Installation

```javascript
npm install rgauge
```

## Usage

```javascript
import Gauge from 'rgauge';

class AwesomeComponent esteds React.Component {
    render() {
        let opts = {/* Gauge customization */}
        return (
            <Gauge {...opts} />
        )
    }
}
```

## Customizing the Gauge

In order you see a demo of how to customize the Gauge, have a look at the [online Gauge generator](https://veerasundar.com/gauge-generator).

You can pass in the below props to the `<Gauge/>` component to customize the Radial Gauge look.

| prop | Description | Value |
|------|-------------|------|
| size | Size of the gauge. 200 Will render a 200x200 Gauge. | Integer |
|currentValue | Gauges value. The progress and needle will be rendered according to this value. | Integer (1 to 100) |
| dialWidth|  Size of the radial dial| Integer |
| dialColor| Color of the radial dial| Hex code  |
| progressWidth| Size of the progress bar | Integer |
| progressColor| Color of the progress bar | Hex code |
| tickLength| Length of the ticks | Integer|
| tickWidth| Width of the ticks | Integer|
| tickColor| Color of the ticks | Hex code |
| needleColor| Color of the needle | Hex code |
| needleBaseSize| Needle base size | Integer|
| needleBaseColor| Needle base color | Hex code |
| needleWidth| Width of the needle | Integer|
| needleSharp| Should the needle be arrow or a line. If true, an arrow will be drawn, else a line.| true / false |
| progressFontColor| What color should the text be for current value.| Hex code |
| progressFontSize| How big should the text be for the current value.| Integer |
| progressFontPosition| Should the progress text be positioned in the center or the bottom of the gauge.| "center / false |

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