jingrow/charts
1
0
Fork 0
Code Pull Requests Activity

chore: simplify usage section

Browse Source
This commit is contained in:
Faris Ansari 2024-12-12 20:36:01 +05:30 committed by GitHub
parent 6d05a89021
commit 7b15424c3a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -35,35 +35,28 @@ ERPNext needed a simple sales history graph for its user company master to help
- **Dynamic data handling**: Add, remove, or update individual data points in place, or refresh the entire dataset to reflect changes. - **Dynamic data handling**: Add, remove, or update individual data points in place, or refresh the entire dataset to reflect changes.
- **Customizable configurations**: Flexible options like colors, animations, and custom titles allow for a highly personalized chart experience. - **Customizable configurations**: Flexible options like colors, animations, and custom titles allow for a highly personalized chart experience.
## Installation ## Usage
Install via [`npm`](https://www.npmjs.com/get-npm):
```sh ```sh
$ npm install frappe-charts npm install frappe-charts
``` ```
and include in your project: Import in your project:
```js
import { Chart } from "frappe-charts"
```
Or include following for es-modules(eg:vuejs):
```js ```js
import { Chart } from 'frappe-charts'
// or esm import
import { Chart } from 'frappe-charts/dist/frappe-charts.esm.js' import { Chart } from 'frappe-charts/dist/frappe-charts.esm.js'
// import css // import css
import 'frappe-charts/dist/frappe-charts.min.css' import 'frappe-charts/dist/frappe-charts.min.css'
``` ```
or include within your HTML Or directly include script in your HTML
```html ```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> <script src="https://unpkg.com/frappe-charts@1.6.1/dist/frappe-charts.min.umd.js"></script>
``` ```
## Usage
```js ```js
const data = { const data = {
labels: ["12am-3am", "3am-6pm", "6am-9am", "9am-12am", labels: ["12am-3am", "3am-6pm", "6am-9am", "9am-12am",
@ -91,20 +84,6 @@ const chart = new frappe.Chart("#chart", { // or a DOM element,
}) })
``` ```
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']
})
```
## Contributing ## Contributing
1. Clone this repo. 1. Clone this repo.