Mon 21 Jul 22:43:21 CEST 2025
This commit is contained in:
parent
4a46000969
commit
55465177b1
101
js/ui/chart/docs/getting-started/integration.md
Normal file
101
js/ui/chart/docs/getting-started/integration.md
Normal file
|
@ -0,0 +1,101 @@
|
|||
# Integration
|
||||
|
||||
Chart.js can be integrated with plain JavaScript or with different module loaders. The examples below show how to load Chart.js in different systems.
|
||||
|
||||
## Script Tag
|
||||
|
||||
```html
|
||||
<script src="path/to/chartjs/dist/Chart.js"></script>
|
||||
<script>
|
||||
var myChart = new Chart(ctx, {...});
|
||||
</script>
|
||||
```
|
||||
|
||||
## Common JS
|
||||
|
||||
```javascript
|
||||
var Chart = require('chart.js');
|
||||
var myChart = new Chart(ctx, {...});
|
||||
```
|
||||
|
||||
## Bundlers (Webpack, Rollup, etc.)
|
||||
|
||||
```javascript
|
||||
import Chart from 'chart.js';
|
||||
var myChart = new Chart(ctx, {...});
|
||||
```
|
||||
|
||||
**Note:** Moment.js is installed along Chart.js as dependency. If you don't want to use Moment.js (either because you use a different date adapter or simply because don't need time functionalities), you will have to configure your bundler to exclude this dependency (e.g. using [`externals` for Webpack](https://webpack.js.org/configuration/externals/) or [`external` for Rollup](https://rollupjs.org/guide/en#peer-dependencies)).
|
||||
|
||||
```javascript
|
||||
// Webpack
|
||||
{
|
||||
externals: {
|
||||
moment: 'moment'
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```javascript
|
||||
// Rollup
|
||||
{
|
||||
external: {
|
||||
['moment']
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Require JS
|
||||
|
||||
**Important:** RequireJS [can **not** load CommonJS module as is](https://requirejs.org/docs/commonjs.html#intro), so be sure to require one of the UMD builds instead (i.e. `dist/Chart.js`, `dist/Chart.min.js`, etc.).
|
||||
|
||||
```javascript
|
||||
require(['path/to/chartjs/dist/Chart.min.js'], function(Chart){
|
||||
var myChart = new Chart(ctx, {...});
|
||||
});
|
||||
```
|
||||
|
||||
**Note:** starting v2.8, Moment.js is an optional dependency for `Chart.js` and `Chart.min.js`. In order to use the time scale with Moment.js, you need to make sure Moment.js is fully loaded **before** requiring Chart.js. You can either use a shim:
|
||||
|
||||
```javascript
|
||||
require.config({
|
||||
shim: {
|
||||
'chartjs': {
|
||||
deps: ['moment'] // enforce moment to be loaded before chartjs
|
||||
}
|
||||
},
|
||||
paths: {
|
||||
'chartjs': 'path/to/chartjs/dist/Chart.min.js',
|
||||
'moment': 'path/to/moment'
|
||||
}
|
||||
});
|
||||
|
||||
require(['chartjs'], function(Chart) {
|
||||
new Chart(ctx, {...});
|
||||
});
|
||||
```
|
||||
|
||||
or simply use two nested `require()`:
|
||||
|
||||
```javascript
|
||||
require(['moment'], function() {
|
||||
require(['chartjs'], function(Chart) {
|
||||
new Chart(ctx, {...});
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
## Content Security Policy
|
||||
|
||||
By default, Chart.js injects CSS directly into the DOM. For webpages secured using [Content Security Policy (CSP)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP), this requires to allow `style-src 'unsafe-inline'`. For stricter CSP environments, where only `style-src 'self'` is allowed, the following CSS file needs to be manually added to your webpage:
|
||||
|
||||
```html
|
||||
<link rel="stylesheet" type="text/css" href="path/to/chartjs/dist/Chart.min.css">
|
||||
```
|
||||
|
||||
And the style injection must be turned off **before creating the first chart**:
|
||||
|
||||
```javascript
|
||||
// Disable automatic style injection
|
||||
Chart.platform.disableCSSInjection = true;
|
||||
```
|
Loading…
Reference in New Issue
Block a user