# react-dashboard-meter

> UI component gauge meter, allowing for thorough customization.

Latest version **0.0.919** (published 2023-05-08) · ISC license · 0 weekly downloads

## Install

```sh
npm install react-dashboard-meter
pnpm add react-dashboard-meter
yarn add react-dashboard-meter
bun add react-dashboard-meter
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.919 |
| Published | 2023-05-08 |
| First published | 2023-05-08 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 51.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jason Cruz |
| Maintainers | jason1642 |
| Keywords | component, UI, progress bar, dashboard, gauge, meter, react-component |

## Links

- npm: https://www.npmjs.com/package/react-dashboard-meter
- Repository: https://github.com/jason1642/react-dashboard-meter
- Homepage: https://github.com/jason1642/react-dashboard-meter#readme
- Issues: https://github.com/jason1642/react-dashboard-meter/issues
- npm.io page: https://npm.io/package/react-dashboard-meter

## Alternatives

- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@progress/kendo-vue-listbox](https://npm.io/package/@progress/kendo-vue-listbox.md) — 932 weekly downloads

## Recent versions

- 0.0.919 (latest) — 2023-05-08

## README

# React Dashboard Meter
  A simple to use, highly customizable gauge meter UI component
  
  
  
 ## Installation 
 ```
    npm i @jason1642/react-dashboard-meter
 ```
 
 
 ## Usage 
 ```jsx
    import {GaugeMeter} from '@jason1642/react-dashboard-meter'
    // IMPORTANT - The minimum width of this component is 150px, you can change it by using the containerStyles prop 
const MyComponent: React.FunctionComponent<IMyComponentProps> = ({ value }) => {
    return(
        <div> 
        <GaugeMeter 
        containerStyles={{
            minWidth: '250px'
        }}
            value={value || 33}
            titleOptions={{
                appendedText: 'km/h',
                toFixedAmount: 0
            }}
            progressBarOptions={{
                fillerTriColors:['#97c4fb', '#5fa7ff', '#60a5fa']
            }}
            range={[0, 40]}
        />
        </div>
    )}
 ```

![](https://github.com/jason1642/react-dashboard-meter/blob/main/Screenshot%202023-04-27%20at%209.40.45%20AM.png)

 ## API
 
 Name |  type | Default | Description
--- | --- | --- | --- 
value (required) | number | undefined | A number that will calculate the percentage of the progress bar that is filled. As well as provide context to the title label.
range |  [number, number] \| number | [0, 100] | Tuple array or number that will be used to calculate the percentage of the progress bar that should be filled using the value prop. If a single number is provided, the range will be assumed to be 0 - range. You can provide any duo set of numbers as long as the first item in the tuple is smaller than the second. 
progressBarOptions |  object | <code>  {  fillerTriColors: <br>["green", "yellow",  "red"],  emptyAreaColor: "#bcbcbc" } </code> | Change the colors of the progress bars filler and empty areas. You can add three colors to get a linear gradient effect on the filler tri colors prop. Options: <br/> ``` fillerTriColors: [string, string, string?] \| string,  emptyAreaColor: string ```
innerAreaColor | string | 'white' | Change the color of the area that the progress bar covers.
containerStyles | object | {} | Styles to pass along to the container of the component. You can change the default min-width value here.
innerAreaSize |  number | 86 |  Change percentage amount that the inner area semi circle takes up, if the entire semi circle including the progress bar is 100%.
titleOptions |  object | <code>{styles: {color: 'black'}, verticalPosition: 'center' }</code> | Change the appearance of the title label inside the inner semi circle area. toFixedAmount changes the amount of numbers after the decimal point in the titles value, default 0. <br/> Options: <br/> ``` {styles:{fontSize: string, color: string, marginBottom: string,fontFamily: string, marginTop: string}, toFixedAmount: number, reactNode: React.ReactElement, appendedText: string, verticalPOsition: string} ```
labelOptions |  object | <code>{size: "default", appendedText: false, labelValueToFixed: 0,labalPosition: 'inward'}</code> | Styles to pass along to the container of the component. You can change the default min-width value here. <br/>  Options: <br/>``` {size: 'small'\|'default'\|'large', appendedTest: string, labelValueToFixed: 0\|1\|2\|3, labelPosition: 'bottom'\|'center'\|'top', numberOfLables: 3\|5 } ```

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