# gauge-animated

> Complex Configurable Gauge

Latest version **2.0.4** (published 2020-03-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install gauge-animated
pnpm add gauge-animated
yarn add gauge-animated
bun add gauge-animated
```

## 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.0.4 |
| Published | 2020-03-12 |
| First published | 2017-02-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 21.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Esbjörn Blomquist |
| Maintainers | ez |
| Keywords | gauge, animation, svg, canvas |

## Links

- npm: https://www.npmjs.com/package/gauge-animated
- Repository: https://github.com/whitelizard/gauge-animated
- Homepage: https://github.com/whitelizard/gauge-animated#readme
- Issues: https://github.com/whitelizard/gauge-animated/issues
- npm.io page: https://npm.io/package/gauge-animated

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 2.0.4 (latest) — 2020-03-12
- 2.0.3 — 2020-03-11
- 2.0.2 — 2020-03-11
- 2.0.1 — 2020-03-11
- 2.0.0 — 2020-03-11
- 1.1.4 — 2019-10-16
- 1.1.3 — 2019-04-15
- 1.1.2 — 2018-02-12
- 1.1.1 — 2018-02-12
- 1.1.0 — 2018-02-10
- 1.0.0 — 2018-02-10
- 0.4.3 — 2017-06-16
- 0.4.2 — 2017-06-16
- 0.4.1 — 2017-06-16
- 0.4.0 — 2017-03-27
- … 7 more at https://npm.io/package/gauge-animated/versions

## README

# Complex Configurable Gauge

A CSS3 animated gauge, with a rather complex & highly configurable gauge face (and SVG needle).

### Install

```bash
npm i -S gauge-animated
```

### Use

```js
import { createGauge } from 'gauge-animated/lib';
createGauge(document.body, {...});
```

### Demo

**Demo [here](http://codepen.io/whitelizard/pen/zRwOaJ?editors=0010)**

The API is rather extensive and allows for a lot of customization to create very different looking gauges, as you can see in the demo. Look at the **bottom section of the JS code window in the demo** to find the configurations (API use) of all the examples.

### Details

The face of the gauge (the scale) is drawn in a `<canvas>`, the text lables are just `<div>`'s (that you can style), and the needle is `<svg>` (which you can override through your own function).

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