Reactochart is a library of React components for creating data visualization charts and graphs. Components include line chart, bar chart, area chart, heat maps, scatterplot, histogram, pie chart, sankey diagram, and tree map.
- Install reactochart using npm.
npm i reactochart --save
- Then you can import an individual Reactochart component:
import LineChart from 'reactochart/LineChart';
- If you prefer, you can import all of Reactochart at once, though this may hinder some optimizations, such as webpack tree-shaking:
import { XYPlot, XAxis, YAxis, LineChart } from 'reactochart';
or
import * as Reactochart from 'reactochart';
- Import reactochart's base styles
import 'reactochart/styles.css';
- Build your first chart and see it rendered! For example, the following code snippet:
import XYPlot from 'reactochart/XYPlot';
import XAxis from 'reactochart/XAxis';
import YAxis from 'reactochart/YAxis';
import LineChart from 'reactochart/LineChart';
import 'reactochart/styles.css';
const MyFirstLineChart = props => (
<XYPlot>
<XAxis title="Phase" />
<YAxis title="Intensity" />
<LineChart
data={Array(100)
.fill()
.map((e, i) => i + 1)}
x={d => d}
y={d => Math.sin(d * 0.1)}
/>
</XYPlot>
);
results in this:
The examples contain more details about each component and the prop-types it accepts. To run the examples locally and play with the different types of charts in a live code editor:
- Clone this repo and
cd
to the newly-created directory - Run
npm run serve
in your terminal (note: if you're running Python in v3 or higher you'll need to runpython -m http.server
) - Go to https://localhost:8000
- AreaBarChart
- AreaChart
- AreaHeatmap
- BarChart
- ColorHeatmap
- FunnelChart
- Histogram
- LineChart
- MarkerLineChart
- RangeBarChart
- ScatterPlot
If you'd like to contribute to the development this project, first fork & clone this repo, and then follow these steps:
- This project uses NPM to manage dependencies and run scripts. Run
npm -v
to check if you already have it installed. If you don't have it, NPM is packaged with Node.js - download and run the install package located on nodejs.org to install. - Babel is used to transpile ES6+ code to ES5 syntax. Install by running
npm install --global babel
- Webpack is used to bundle the JS & styles for the examples. Install by running
npm install --global webpack
- Run
npm install
in the project root directory. This will install all of the project dependencies into thenode_modules
directory.
- Run
npm run dev
to run the development server (webpack-dev-server), which will serve a live development version of the examples at localhost:9876. - Make changes to the library code in the
src
directory, and/or changes to the examples in theexamples/src
directory. - If you'd like to make changes or add further component documentation, follow the example on
react-docgen
. - Once you're happy with your library and/or documentation changes, run
npm run docs
. This allows the documentation build to run with your updatedsrc
code.git add
andgit commit
the updated build. git push
to your forked version of the repo.- Open a Github pull request with your changes against
master
. ๐
If you have an app that depends on reactochart and you want to develop locally, follow the following steps:
- In the folder for this repo, run
npm build
and thennpm link
- In your app folder, run
npm link reactochart
. If you're using webpack, then you also may need the following config:
{
"resolve": {
"symlinks": true,
"alias": {
"react": path.resolve("./node_modules/react"),
"react-dom": path.resolve("./node_modules/react-dom")
}
}
}
- Do not make any changes in the
lib
orexamples/build
directories, as these directories are destroyed and regenerated on each build. - The development server uses react-hot-loader to automatically "hot reload" changes to React components, so refreshing your web browser is not necessary.
This project adheres to the Open Code of Conduct. By participating, you are expected to honor this code.