chartjs-adapter-date-fns

Overview

This adapter allows the use of date-fns with Chart.js.

Requires Chart.js 2.8.0 or later and date-fns 2.0.0-alpha.27 or later.

Note: once loaded, this adapter overrides the default date-adapter provided in Chart.js (as a side-effect).

Installation

npm

1npm install date-fns@next chartjs-adapter-date-fns2 --save

1import Chart from 'chart.js';
2import 'chartjs-adapter-date-fns';

Configuration

Locale support via scale options

date-fns requires a date-fns locale object to be tagged on to each format() call, which requires the locale to be explicitly set via the adapters.date option: Chart.js documentation on adapters.date

For example:

1// import date-fns locale:
2import {de} from 'date-fns/locale';
3
4// scale options:
5{
6    adapters: {
7        date: {
8            locale: de
9        }
10    }
11}

Further, read the Chart.js documentation for other possible date/time related options. For example, the time scale time.* options can be overridden using the date-fns tokens.

Development

You first need to install node dependencies (requires Node.js):

1> npm install

The following commands will then be available from the repository root:

1> gulp build            // build dist files
2> gulp build --watch    // build and watch for changes
3> gulp lint             // perform code linting

License

chartjs-adapter-date-fns is available under the MIT license.