-
Notifications
You must be signed in to change notification settings - Fork 11.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
54 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,57 +1,65 @@ | ||
# Installation | ||
|
||
## Package Manager | ||
|
||
Chart.js can be installed via npm or bower. It is recommended to get Chart.js this way. | ||
|
||
## npm | ||
### npm | ||
[![npm](https://img.shields.io/npm/v/chart.js.svg?style=flat-square&maxAge=600)](https://npmjs.com/package/chart.js) | ||
[![npm](https://img.shields.io/npm/dm/chart.js.svg?style=flat-square&maxAge=600)](https://npmjs.com/package/chart.js) | ||
|
||
```bash | ||
npm install chart.js --save | ||
``` | ||
|
||
## Bower | ||
### Bower | ||
[![bower](https://img.shields.io/bower/v/chartjs.svg?style=flat-square&maxAge=600)](https://libraries.io/bower/chartjs) | ||
|
||
```bash | ||
bower install chart.js --save | ||
``` | ||
|
||
## CDN | ||
### CDNJS | ||
|
||
### Selecting the Correct Build | ||
|
||
Chart.js provides two different builds for you to choose: **Stand-Alone Build**, **Bundled Build**. | ||
|
||
#### Stand-Alone Build | ||
Files: | ||
* `dist/Chart.js` | ||
* `dist/Chart.min.js` | ||
|
||
The stand-alone build includes Chart.js as well as the color parsing library. If this version is used, you are required to include [Moment.js](https://momentjs.com/) before Chart.js for the functionality of the time axis. | ||
|
||
#### Bundled Build | ||
Files: | ||
* `dist/Chart.bundle.js` | ||
* `dist/Chart.bundle.min.js` | ||
|
||
The bundled build includes Moment.js in a single file. You should use this version if you require time axes and want to include a single file. You should not use this build if your application already included Moment.js. Otherwise, Moment.js will be included twice which results in increasing page load time and possible version compatibility issues. The Moment.js version in the bundled build is private to Chart.js so if you want to use Moment.js yourself, it's better to use Chart.js (non bundled) and import Moment.js manually. | ||
|
||
### CDNs | ||
|
||
Chart.js is available on the following CDNs | ||
|
||
#### CDNJS | ||
[![cdnjs](https://img.shields.io/cdnjs/v/Chart.js.svg?style=flat-square&maxAge=600)](https://cdnjs.com/libraries/Chart.js) | ||
|
||
Chart.js built files are available on [CDNJS](https://cdnjs.com/): | ||
|
||
https://cdnjs.com/libraries/Chart.js | ||
|
||
### jsDelivr | ||
#### jsDelivr | ||
[![jsdelivr](https://img.shields.io/npm/v/chart.js.svg?label=jsdelivr&style=flat-square&maxAge=600)](https://cdn.jsdelivr.net/npm/chart.js@latest/dist/) [![jsdelivr hits](https://data.jsdelivr.com/v1/package/npm/chart.js/badge)](https://www.jsdelivr.com/package/npm/chart.js) | ||
|
||
Chart.js built files are also available through [jsDelivr](https://www.jsdelivr.com/): | ||
|
||
https://www.jsdelivr.com/package/npm/chart.js?path=dist | ||
|
||
## Github | ||
#### Github | ||
[![github](https://img.shields.io/github/release/chartjs/Chart.js.svg?style=flat-square&maxAge=600)](https://github.com/chartjs/Chart.js/releases/latest) | ||
|
||
You can download the latest version of [Chart.js on GitHub](https://github.com/chartjs/Chart.js/releases/latest). | ||
|
||
If you download or clone the repository, you must [build](../developers/contributing.md#building-and-testing) Chart.js to generate the dist files. Chart.js no longer comes with prebuilt release versions, so an alternative option to downloading the repo is **strongly** advised. | ||
|
||
# Selecting the Correct Build | ||
|
||
Chart.js provides two different builds for you to choose: **Stand-Alone Build**, **Bundled Build**. | ||
|
||
## Stand-Alone Build | ||
Files: | ||
* `dist/Chart.js` | ||
* `dist/Chart.min.js` | ||
|
||
The stand-alone build includes Chart.js as well as the color parsing library. If this version is used, you are required to include [Moment.js](https://momentjs.com/) before Chart.js for the functionality of the time axis. | ||
|
||
## Bundled Build | ||
Files: | ||
* `dist/Chart.bundle.js` | ||
* `dist/Chart.bundle.min.js` | ||
|
||
The bundled build includes Moment.js in a single file. You should use this version if you require time axes and want to include a single file. You should not use this build if your application already included Moment.js. Otherwise, Moment.js will be included twice which results in increasing page load time and possible version compatibility issues. The Moment.js version in the bundled build is private to Chart.js so if you want to use Moment.js yourself, it's better to use Chart.js (non bundled) and import Moment.js manually. |