https://github.com/chartjs/chartjs-adapter-date-fns

date-fns adapter for Chart.js
https://github.com/chartjs/chartjs-adapter-date-fns

adapter chartjs date-fns datetime

Last synced: 2 days ago
JSON representation

date-fns adapter for Chart.js

• Host: GitHub
• URL: https://github.com/chartjs/chartjs-adapter-date-fns
• Owner: chartjs
• License: mit
• Created: 2019-01-08T20:14:47.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-19T01:41:03.000Z (11 months ago)
• Last Synced: 2024-05-17T08:42:21.093Z (about 1 month ago)
• Topics: adapter, chartjs, date-fns, datetime
• Language: JavaScript
• Size: 472 KB
• Stars: 100
• Watchers: 5
• Forks: 35
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Lists

• awesome - date-fns - fns adapter (Adapters / Data Sources)

README

        
# chartjs-adapter-date-fns

[![release](https://img.shields.io/github/release/chartjs/chartjs-adapter-date-fns.svg?style=flat-square)](https://github.com/chartjs/chartjs-adapter-date-fns/releases/latest) [![travis](https://img.shields.io/travis/chartjs/chartjs-adapter-date-fns.svg?style=flat-square&maxAge=60)](https://travis-ci.org/chartjs/chartjs-adapter-date-fns) [![awesome](https://awesome.re/badge-flat2.svg)](https://github.com/chartjs/awesome)

## Overview

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

Requires [Chart.js](https://github.com/chartjs/Chart.js/releases) **2.8.0** or later and [date-fns](https://date-fns.org/) **2.0.0** or later.

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

## Installation

### npm

```bash

npm install date-fns chartjs-adapter-date-fns --save

```

```javascript

import { Chart } from 'chart.js';

import 'chartjs-adapter-date-fns';

```

### CDN

By default, `https://cdn.jsdelivr.net/npm/chartjs-adapter-date-fns` returns the latest (minified) version, however it's [highly recommended](https://www.jsdelivr.com/features) to always specify a version in order to avoid breaking changes. This can be achieved by appending `@{version}` to the url:

```html

```

Read more about jsDeliver versioning on their [website](http://www.jsdelivr.com/).

## 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](https://www.chartjs.org/docs/next/axes/cartesian/time#date-adapters)

For example:

```javascript

// import date-fns locale:

import {de} from 'date-fns/locale';

// scale options:

{

    adapters: {

        date: {

            locale: de

        }

    }

}

```

Further, read the [Chart.js documentation](https://www.chartjs.org/docs/next) for other possible date/time related options. For example, the time scale [`time.*` options](https://www.chartjs.org/docs/next/axes/cartesian/time#configuration-options) can be overridden using the [date-fns tokens](https://date-fns.org/docs/format).

## Development

You first need to install node dependencies (requires [Node.js](https://nodejs.org/)):

```bash

> npm install

```

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

```bash

> npm run build         // build dist files

> npm run lint          // perform code linting

```

## License

`chartjs-adapter-date-fns` is available under the [MIT license](LICENSE.md).