# frappe-charts

> https://frappe.github.io/charts

Latest version **1.6.2** (published 2021-06-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install frappe-charts
pnpm add frappe-charts
yarn add frappe-charts
bun add frappe-charts
```

## Health

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

Positive: esm support; no vulnerabilities; high maintenance score; popular repo.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.6.2 |
| Published | 2021-06-16 |
| First published | 2017-10-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 1005.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15093 |
| Author | Prateeksha Singh |
| Maintainers | netchampfaris, pratu16x7, surajshetty3416, rmehta, scmmishra, prssanna |
| Keywords | js, charts |

## Links

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

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.6.2 (latest) — 2021-06-16
- 2.0.0-rc31 (next) — 2026-10-19
- 2.0.0-rc5 (v2-rc5) — 2021-02-02
- 2.0.0-rc30 — 2026-10-15
- 2.0.0-rc29 — 2026-10-14
- 2.0.0-rc28 — 2026-10-12
- 2.0.0-rc27 — 2025-07-02
- 2.0.0-rc26 — 2025-03-27
- 2.0.0-rc25 — 2025-03-26
- 2.0.0-rc24 — 2025-03-25
- 2.0.0-rc23 — 2022-11-14
- 2.0.0-rc22 — 2022-07-18
- 2.0.0-rc21 — 2022-07-18
- 2.0.0-rc20 — 2021-09-21
- 2.0.0-rc19 — 2021-06-16
- … 47 more at https://npm.io/package/frappe-charts/versions

## README

<div align="center">
    <img src="https://github.com/frappe/design/blob/master/logos/logo-2019/frappe-charts-logo.png" height="128">
    <a href="https://frappe.github.io/charts">
        <h2>Frappe Charts</h2>
    </a>
    <p align="center">
        <p>GitHub-inspired modern, intuitive and responsive charts with zero dependencies</p>
        <a href="https://frappe.io/charts">
            <b>Explore Demos » </b>
        </a>
        <a href="https://codesandbox.io/s/frappe-charts-demo-viqud">
            <b> Edit at CodeSandbox »</b>
        </a>
        <a href="https://frappe.io/charts/docs">
            <b>Documentation » </b>
        </a>
    </p>
</div>

<p align="center">
    <a href="https://bundlephobia.com/result?p=frappe-charts">
        <img src="https://img.shields.io/bundlephobia/minzip/frappe-charts">
    </a>
</p>

<p align="center">
    <a href="https://frappe.github.io/charts">
        <img src=".github/example.gif">
    </a>
</p>

### Contents
* [Installation](#installation)
* [Usage](#usage)
* [Contribute](https://frappe.io/charts/docs/contributing)
* [License](#license)

#### Installation

##### Via NPM
Install via [`npm`](https://www.npmjs.com/get-npm):

```sh
$ npm install frappe-charts
```

and include in your project:
```js
import { Chart } from "frappe-charts"
```

Or include following for es-modules(eg:vuejs):
```js
import { Chart } from 'frappe-charts/dist/frappe-charts.esm.js'
// import css
import 'frappe-charts/dist/frappe-charts.min.css'
```

##### or include within your HTML

```html
<script src="https://cdn.jsdelivr.net/npm/frappe-charts@1.1.0/dist/frappe-charts.min.umd.js"></script>
<!-- or -->
<script src="https://unpkg.com/frappe-charts@1.1.0/dist/frappe-charts.min.umd.js"></script>
```

#### Usage
```js
const data = {
    labels: ["12am-3am", "3am-6pm", "6am-9am", "9am-12am",
        "12pm-3pm", "3pm-6pm", "6pm-9pm", "9am-12am"
    ],
    datasets: [
        {
            name: "Some Data", type: "bar",
            values: [25, 40, 30, 35, 8, 52, 17, -4]
        },
        {
            name: "Another Set", type: "line",
            values: [25, 50, -10, 15, 18, 32, 27, 14]
        }
    ]
}

const chart = new frappe.Chart("#chart", {  // or a DOM element,
                                            // new Chart() in case of ES6 module with above usage
    title: "My Awesome Chart",
    data: data,
    type: 'axis-mixed', // or 'bar', 'line', 'scatter', 'pie', 'percentage'
    height: 250,
    colors: ['#7cd6fd', '#743ee2']
})
```

Or for es-modules (replace `new frappe.Chart()` with `new Chart()`):
```diff
- const chart = new frappe.Chart("#chart", {
+ const chart = new Chart("#chart", {  // or a DOM element,
                                    // new Chart() in case of ES6 module with above usage
    title: "My Awesome Chart",
    data: data,
    type: 'axis-mixed', // or 'bar', 'line', 'scatter', 'pie', 'percentage'
    height: 250,
    colors: ['#7cd6fd', '#743ee2']
})
```


If you want to contribute:

1. Clone this repo.
2. `cd` into project directory
3. `npm install`
4. `npm run dev`

#### License
This repository has been released under the [MIT License](LICENSE)

------------------
Project maintained by [Frappe](https://frappe.io).
Used in [ERPNext](https://erpnext.com). Read the [blog post](https://medium.com/@pratu16x7/so-we-decided-to-create-our-own-charts-a95cb5032c97).

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