react-chartjs-2
React wrapper for ChartJs 2
Open for PR's and contributions!
Demo & Examples
Live demo: gor181.github.io/react-chartjs-2
To build the examples locally, run:
npm install
npm start
Then open localhost:8000 in a browser.
Installation via NPM
npm install react-chartjs-2 chart.js --save
Usage
Check example/src/components/* for usage.
import {Doughnut} from 'react-chartjs-2';
<Doughnut data={...} />
Properties
- data: PropTypes.object.isRequired,
- height: PropTypes.number,
- legend: PropTypes.object,
- onElementsClick: PropTypes.func,
- options: PropTypes.object,
- redraw: PropTypes.bool,
- width: PropTypes.number
Custom size
In order for Chart.js to obey the custom size you need to set maintainAspectRatio to false, example:
<Bar
data={data}
width={100}
height={50}
options={{
maintainAspectRatio: false
}}
/>
Chart instance
Chart instance can be accessed by placing a ref to the element as:
render() {
componentDidMount() {
console.log(this.refs.chart.chart_instance); // returns a Chart.js instance reference
}
return (
<Doughnut ref='chart' data={data} />
)
}
Events
onElementsClick (function)
A function to be called when mouse clicked on chart elememts, will return all element at that point as an array. Check
{
onElementsClick: (elems) => {}
// `elems` is an array of chartElements
}
Development (src, lib and the build process)
NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.
To build, watch and serve the examples (which will also watch the component source), run npm start. If you just want to watch changes to src and rebuild lib, run npm run watch (this is useful if you are working with npm link).
Thanks
Jed Watson for making react-component yo builder!
License
MIT Licensed
Copyright (c) 2016 Goran Udosic && Headstart App.