Skip to content

Commit 09abe7d

Browse files
committed
chore: 1.0.1 release - update README file
1 parent 8a06641 commit 09abe7d

File tree

2 files changed

+23
-3
lines changed

2 files changed

+23
-3
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
1-
# coreui-vue-chartjs
2-
CoreUI Vue Chart.js http://coreui.io
1+
# Coreui Vue Chartjs library
2+
![NPM](https://img.shields.io/badge/npm-1.0.0-brightgreen)
3+
![Downloads](https://img.shields.io/npm/dm/@coreui/coreui-vue-chartjs.svg?style=flat-square)
4+
![Chart.js](https://img.shields.io/badge/Chart.js-^2.9.3-brightgreen.svg)
5+
![Vue](https://img.shields.io/badge/Vue-^2.6.10-brightgreen.svg)
6+
7+
## CoreUI icons vue - CIcon component
8+
9+
Dedicated component used to implement [Chart.js](https://www.chartjs.org/) in Vue.js.
10+
11+
## Features
12+
- Implementation with ease - <b>You only need to pass 'datasets' prop and you have your chart working</b>. Optionally you can pass labels, options and plugins according to
13+
[Chart.js docs](https://www.chartjs.org/docs/latest/getting-started/usage.html)
14+
15+
The rest of chart.js configuration issues are already resolved,
16+
- Chart will be rendered, even if you don't pass the labels, as empty labels will be generated automatically. You can also assign months or numeric indexes to labels (see prop description),
17+
- If you don't pass tooltip options, coreui-custom-tooltips, would be used by default. They are resolving the chart.js issue with tooltip beeing cut, when exceeding the canvas.
18+
- Dynamic updates of passed configuration. This feature makes your chart.js configuration automatically reactive to changes.
19+
20+
## Documentation
21+
22+
You can find the library documentation [here](https://coreui.io/vue/docs/components/charts)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@coreui/coreui-vue-chartjs",
33
"description": "Vue component wrapper for chart.js",
4-
"version": "1.0.0",
4+
"version": "1.0.1",
55
"license": "MIT",
66
"main": "dist/coreui-vue-chartjs.common.js",
77
"types": "src/index.d.ts",

0 commit comments

Comments
 (0)