Simple, responsive, modern SVG Charts with zero dependencies
Go to file
Arjun Choudhary f333096012 feat: experimental! allow overrriding yAxisLabels 2023-09-27 16:08:01 +05:30
.github chore: update action 2021-03-11 12:07:19 +00:00
docs Merge commit '9f68f1ac5f7e8eb7a089d13b27d44fa0702d7931' 2022-12-20 13:16:17 +05:30
src feat: experimental! allow overrriding yAxisLabels 2023-09-27 16:08:01 +05:30
.babelrc chore: formatting changes 2022-11-24 12:54:27 +05:30
.eslintrc.json chore: formatting changes 2022-11-24 12:54:27 +05:30
.gitignore Merge commit '9f68f1ac5f7e8eb7a089d13b27d44fa0702d7931' 2022-12-20 13:16:17 +05:30
.travis.yml chore: formatting changes 2022-11-24 12:54:27 +05:30
LICENSE Initial commit 2017-09-23 21:27:02 +05:30
Makefile [COV, TEST] Add coveralls 2018-04-18 00:29:43 +05:30
README.md Changing README file 2023-04-17 21:26:54 +05:30
package-lock.json fix: rollup scss fs.writeFile err handling 2022-11-15 13:33:52 +05:30
package.json chore: Updated & cleaned build dependencies 2022-11-19 11:38:54 +05:30
rollup.config.js chore: formatting changes 2022-11-24 12:54:27 +05:30

README.md

Frappe Charts

GitHub-inspired modern, intuitive and responsive charts with zero dependencies

Explore Demos » Edit at CodeSandbox » Documentation »

Contents

Installation

Via NPM

Install via npm:

$ npm install frappe-charts

and include in your project:

import { Chart } from "frappe-charts"

Or include following for es-modules(eg:vuejs):

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
<script src="https://cdn.jsdelivr.net/npm/frappe-charts@1.6.1/dist/frappe-charts.min.umd.js"></script>
<!-- or -->
<script src="https://unpkg.com/frappe-charts@1.6.1/dist/frappe-charts.min.umd.js"></script>

Usage

const data = {
    labels: ["12am-3am", "3am-6pm", "6am-9am", "9am-12am",
        "12pm-3pm", "3pm-6pm", "6pm-9pm", "9am-12am"
    ],
    datasets: [
        {
            name: "Some Data", chartType: "bar",
            values: [25, 40, 30, 35, 8, 52, 17, -4]
        },
        {
            name: "Another Set", chartType: "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()):

- 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 i npm-run-all -D (optional --> might be required for some developers)
  5. npm run dev

License

This repository has been released under the MIT License


Project maintained by Frappe. Used in ERPNext. Read the blog post.