Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/esbullington/react-d3

Modular React charts made with d3.js
https://github.com/esbullington/react-d3

Last synced: 3 months ago
JSON representation

Modular React charts made with d3.js

Awesome Lists containing this project

README 

        
##  Update



**Important update:**  



The actively maintained fork of this project is now at the Github of react-d3 co-creator `yang-wei`, who has recently taken the lead in maintaining the project and moving toward 1.0.



Yang Wei's fork is located [here](https://github.com/yang-wei/rd3).



### react-d3

Modular ReactJS charts made using d3 chart utilities. Work on project documentation has started [here](https://github.com/esbullington/react-d3/wiki). A few examples of the available charts can be seen below, the others can be [viewed here](https://reactiva.github.io/react-d3-website/), side-by-side with the React code that generates the charts.



![react-d3 chart images](https://raw.githubusercontent.com/esbullington/react-d3-website/gh-pages/img/multiseries.png)



[![Build Status](https://travis-ci.org/esbullington/react-d3.svg?branch=master)](https://travis-ci.org/esbullington/react-d3)



### Version

[![npm version](https://badge.fury.io/js/react-d3.png)](https://www.npmjs.com/package/react-d3)



### Basic usage



First, install via `npm`:



`npm install react-d3`



Then, import into your ReactJS project:



```

var rd3 = require('react-d3');

// es6

import rd3 from 'react-d3';

```



The charts are then available under the `rd3` namespace, which you can then use as shown on the [demonstration page](https://reactiva.github.io/react-d3-website/):



If you don't wish to pull in all the charts, you can also require single chart:



```

var BarChart = require('react-d3/barchart').BarChart;

// es6

import { BarChart } from 'react-d3';

```



### Available Charts



```

var BarChart = rd3.BarChart;

var LineChart = rd3.LineChart;

var PieChart = rd3.PieChart;

var AreaChart = rd3.AreaChart;

var Treemap = rd3.Treemap;

var ScatterChart = rd3.ScatterChart;

var CandleStickChart = rd3.CandleStickChart;

```



For usage, please see [here](https://reactiva.github.io/react-d3-website/).  [API documentation](https://github.com/esbullington/react-d3/wiki/API) is also coming online over the coming days.



### JSFiddle

There's a development build available for experimentation on JSFiddle: [http://jsfiddle.net/esbullington/jp9dkh1g/](http://jsfiddle.net/esbullington/jp9dkh1g/).



Please note that this build should probably not be used in production, since it bundles all of react-d3's dependencies in a single bundle (this is also the cause of the "Cannot read property 'firstChild' of undefined" error message on the JS console, which occurs when there are two React libraries in the same namespace).



All the react-d3 charts are available in this JSFiddle fork under the global `rd3` namespace.



### Background

Although there have been [several](http://nicolashery.com/integrating-d3js-visualizations-in-a-react-app/) [different](http://bl.ocks.org/milroc/d22bbf92231876505e5d) approaches proposed for combining the power of d3 with the flexibility and modularity of ReactJS, the approach I'm using here was inspired by [this blog post](http://10consulting.com/2014/02/19/d3-plus-reactjs-for-charting/) by Ben Smith of [Binary Consulting](http://10consulting.com/).



With this approach, React itself is responsible for generating the SVG markup.  d3.js is used for its tremendous collection of utility functions, such as those that calculate the `path` value for various chart types.



### Roadmap



For current roadmap, please see Yang Wei's fork at: https://github.com/yang-wei/rd3



### License

MIT



Copyright (c) 2014-2015 Eric. S Bullington, Lim Yang Wei, and project [contributors](https://github.com/esbullington/react-d3/graphs/contributors)