You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-15Lines changed: 34 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,40 @@ If you're looking for v1 check this [branch](https://github.com/apertureless/vue
32
32
33
33
## Install
34
34
35
-
Simply run `npm install vue-chartjs`
35
+
Simply run `yarn add vue-chartjs chart.js`
36
+
37
+
Or if you want to use it directly in the browser add `https://unpkg.com/[email protected]/dist/vue-chartjs.full.min.js` to your scripts. See [Codepen](https://codepen.io/apertureless/pen/vxWbqB?editors=1010)
38
+
39
+
## Explanation of Different Builds
40
+
There are three different entry points. It depends on which build setup do you have. The dependencies are bundled or required as a peerDependency.
You can use `vue-chartjs` directly in the browser without any build setup. Like in this [codepen](https://codepen.io/apertureless/pen/vxWbqB?editors=1010). For this case, please use the `vue-chartjs.full.min.js` which is the minified version. It has Vue.js and Chart.js bundled into it. And bundled to a UMD Module. So you only need that one file.
57
+
58
+
59
+
### Browserify / Webpack 1
60
+
61
+
If you're using Gulp, Browserify or Webpack 1 the entry is `vue-chartjs.js` which is __transpiled__ and __bundled__ UMD Module.
62
+
63
+
However Vue.js and Chart.js are `deerDependencies` so you have to install them seperately. In most projects you will have `Vue.js` already installed anyways. This way, you can have different versions of Vue.js and Chart.js then in this package.
64
+
65
+
### Webpack 2
66
+
If you're using Webpack 2 it will automatically use the `jsnext:main` / `module` entry point. Which is `es/index.js`
67
+
It is a __transpiled__ es version of the source. And is not __bundled__ to a module. This way you three shaking will work. Like in the bundled version, `Vue.js` and `Chart.js` are `peerDependencies` and need to be installed.
68
+
36
69
37
70
## How to use
38
71
@@ -178,20 +211,6 @@ export default Line.extend({
178
211
})
179
212
```
180
213
181
-
## Webpack, Browserify and dist files.
182
-
183
-
If you use `import VueCharts from 'vue-chartjs'` you will mostly import the UMD build of vue-chart.js
184
-
This is because of compatibility reasons. This approach however has a downside: vue.js and chart.js are bundled into the file.
185
-
And you end up with two vue instances.
186
-
187
-
If you're using webpack 2 however, it will automatically import the transpiled ES sources.
188
-
If you know what you're doing you can import directly from the transpiled es sources:
0 commit comments