Recharts

Redefined chart library built with React and D3

ChartingReactD3SVG
recharts/rechartsrecharts.orgrecharts

README

Recharts

storybook Build Status Coverage Status npm version npm downloads MIT License

Introduction


Recharts is a Redefined chart library built with React and D3.

The main purpose of this library is to help you to write charts in React applications without any pain. Main principles of Recharts are:

1. Simply deploy with React components.
1. Native SVG support, lightweight depending only on some D3 submodules.
1. Declarative components, components of charts are purely presentational.

Examples


  1. ``` js
  2. <LineChart
  3.   width={400}
  4.   height={400}
  5.   data={data}
  6.   margin={{ top: 5, right: 20, left: 10, bottom: 5 }}
  7. >
  8.   <XAxis dataKey="name" />
  9.   <Tooltip />
  10.   <CartesianGrid stroke="#f5f5f5" />
  11.   <Line type="monotone" dataKey="uv" stroke="#ff7300" yAxisId={0} />
  12.   <Line type="monotone" dataKey="pv" stroke="#387908" yAxisId={1} />
  13. </LineChart>
  14. ```

All the components of Recharts are clearly separated. The lineChart is composed of x axis, tooltip, grid, and line items, and each of them is an independent React Component. The clear separation and composition of components is one of the principle Recharts follows.

Installation


npm


NPM is the easiest and fastest way to get started using Recharts. It is also the recommended installation method when building single-page applications (SPAs). It pairs nicely with a CommonJS module bundler such as Webpack.

  1. ```sh
  2. # latest stable
  3. $ npm install recharts
  4. ```

umd


The UMD build is also available on unpkg.com:

  1. ``` html
  2.  <script src="https://unpkg.com/react/umd/react.production.min.js"></script>
  3.  <script src="https://unpkg.com/react-dom/umd/react-dom.production.min.js"></script>
  4.  <script src="https://unpkg.com/recharts/umd/Recharts.min.js"></script>
  5. ```

Then you can find the library on window.Recharts.

dev build


  1. ```sh
  2. $ git clone https://github.com/recharts/recharts.git
  3. $ cd recharts
  4. $ npm install
  5. $ npm run build
  6. ```

Demo


To examine the demos in your local build, execute:

  1. ```sh
  2. $ npm run[-script] demo
  3. ```

and then browse to http://localhost:3000.

Module Formats


- babel-plugin-recharts A simple transform to cherry-pick Recharts modules so you don’t have to.

License


MIT

Copyright (c) 2015-2022 Recharts Group.