react-native-gifted-charts/README.md

The most complete library for Bar, Line, Area, Pie, Donut, Stacked Bar, Population Pyramid and Radar charts in React Native. Allows 2D, 3D, gradient, animations and live data updates.

# react-native-gifted-charts

<p align="center">
  <a href="https://gifted-charts.web.app">
    <img src="/demos/favicon.png" height="auto" width="26" height="26" />
  </a> &nbsp; &nbsp; &nbsp;
  <a href="https://www.npmjs.com/package/react-native-gifted-charts">
    <img src="/demos/npmIcon.png" height="auto" width="28" height="28" />
  </a> &nbsp; &nbsp; &nbsp;
  <a href="https://github.com/Abhinandan-Kushwaha/react-native-gifted-charts">
    <img src="/demos/gitLogo.png" height="auto" width="28" height="28" />
  </a> &nbsp; &nbsp; &nbsp;
  <a href="https://stackoverflow.com/questions/tagged/react-native-gifted-charts?tab=Newest">
    <img src="/demos/stackOverflow.png" height="auto" width="28" height="28" />
  </a> &nbsp; &nbsp; &nbsp;
  <a href="https://discord.gg/FBbu9duJxs">
    <img src="/demos/discord.png" height="auto" width="30" height="30" />
  </a> &nbsp; &nbsp; &nbsp;
  <a href="https://www.reddit.com/r/gifted_charts/">
    <img src="/demos/redditLogo.png" height="auto" width="32" height="32" />
  </a>
</p>
The most complete library for Bar, Line, Area, Pie, Donut, Stacked Bar, Population Pyramid and Radar charts in React Native. Allows 2D, 3D, gradient, animations and live data updates.

### Yet another chart library? Why?

**_To bring Life to your data_**

- Plenty of features with minimal code
- Apply animations to your charts on load and on value change, just by adding a prop
- Smooth animations implemented using the `Animated` API (no external library used for animations)
- Clickable and scrollable
- Three-D and gradient effects
- Fully customizable (see the [props](docs/docs.md))
- Detailed [documentation](https://gifted-charts.web.app/) with examples
- Support for **_combined_** Bar and Line charts
- Tested to be pixel perfect using [react-native-screenshot-test](https://www.npmjs.com/package/react-native-screenshot-test). See [the screenshot tests here](https://abhinandan-kushwaha.github.io/TestingCharts/ss-test/test.html)
- Detailed and illustrated [dev docs](docs/dev/index.md) that explain the architecture and working of the library

The web counterpart of this library is public now. Try out our new reactJS library- [react-gifted-charts](https://www.npmjs.com/package/react-gifted-charts) <br />
The exact same piece of code that you write to render charts in react-native, can be used to render charts in reactJS using this library!

## [Release notes (Changelog) 🎉](release-notes/release-notes.md)

See the **[release changes by version here.](release-notes/release-notes.md)**

<img src='/demos/bars.png' alt=''/>
<img src='/demos/lineArea.png' alt=''/>
<img src='/demos/blues.png' alt=''/>
<table>
  <tr>
    <td><img src='/demos/scrollLine.gif' alt='' width=320 height=280/></td>
    <td><img src='/demos/animatedDataLine.gif' alt='' width=320 height=260/></td>
  </tr>
  
  <tr>
    <td><img src='/demos/crossHair.gif' alt='' height=280 /></td>
    <td><img src='/demos/movingBars.gif' alt='' width=270 height=300/></td>
  <tr>
    <td><img src='/demos/radar.png' alt='' height=280 width=320/></td>
    <td><img src='/demos/ppnLabelled.png' alt='' height=280 width=300/></td>
  </tr>
</table>
<img src='/demos/pieExt.png' alt='' height=280 />

---

## Installation

### React Native CLI

```sh
npm install react-native-gifted-charts react-native-linear-gradient react-native-svg
```

### Expo

```sh
npx expo install react-native-gifted-charts expo-linear-gradient react-native-svg
```

Please note that `react-native-svg` and `react-native-linear-gradient`/`expo-linear-gradient` are needed for the library to work, so make sure they are installed in your project. <br />
**[gifted-charts-core](https://www.npmjs.com/package/gifted-charts-core)** contains the mathematical and logical utilities used by this library.

# 📚 Docs & Demos 🎦

- [Documentation and gallery](https://gifted-charts.web.app/) <br />
- [Architecture and working (dev docs)](docs/dev/index.md)
- [Demo repo and snacks list](https://github.com/Abhinandan-Kushwaha/GiftedChartsDemo?tab=readme-ov-file#gifted-charts-demo)
- [Demo app on Play Store](https://play.google.com/store/apps/details?id=com.giftedcharts.demo)

## Usage

The simplest usage of various types of charts can be done as below-

```js
import { BarChart, LineChart, PieChart, PopulationPyramid, RadarChart } from "react-native-gifted-charts";

// ...
const data=[ {value:50}, {value:80}, {value:90}, {value:70} ]

<BarChart data = {data} />
<LineChart data = {data} />
<PieChart data = {data} />
<PopulationPyramid data = {[{left:10,right:12}, {left:9,right:8}]} />
<RadarChart data = {[50, 80, 90, 70]} />

// For Horizontal Bar chart, just add the prop horizontal to the <BarChart/> component

<BarChart data = {data} horizontal />

// For Area chart, just add the prop areaChart to the <LineChart/> component

<LineChart data = {data} areaChart />

// For Donut chart, just add the prop donut to the <PieChart/> component

<PieChart data = {data} donut />
```

## Props tables

**1. [BarChart, Horizontal BarChart and Stacked Bar Chart props](docs/BarChart/BarChartProps.md)** \
**2. [LineChart and AreaChart props](docs/LineChart/LineChartProps.md)** \
**3. [PieChart and DonutChart props](docs/PieChart/PieChartProps.md)** \
**4. [Population Pyramid props](docs/PopulationPyramid/PopulationPyramid.md)** \
**5. [RadarChart props](docs/RadarChart/RadarChartProps.md)**

## 🤝 Contributing

This project exists thanks to all the people who contribute.

<a href="https://github.com/Abhinandan-Kushwaha/react-native-gifted-charts/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=Abhinandan-Kushwaha/react-native-gifted-charts" />
</a>
<br/><br/>

_Dear developers_! Your small contribution can make someone's day 😊

One of the ways you can contribute is to address an [open issue](https://github.com/Abhinandan-Kushwaha/react-native-gifted-charts/issues).

Sometimes people report issues which don't exist, or request for features which are already present. Such issues can be addressed without pushing any code to the repo. Just show them in the comments how to do it.

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

📝 [To do list](./src/todos.md)

## 🧐 Test cases

- Test strategy and cases are discussed here- [TESTS.md](./TESTS.md) <br />
- Pixel perfection is assured using [react-native-screenshot-test](https://www.npmjs.com/package/react-native-screenshot-test). <br/>
- 290+ screenshot tests have been written. See the [Reports here](https://abhinandan-kushwaha.github.io/TestingCharts/ss-test/test.html).
- Screenshot tests are written in a separate repo named [TestingCharts](https://github.com/Abhinandan-Kushwaha/TestingCharts)

## 🏆 Showcase

Showcase your dashing charts on [Expo snack](https://snack.expo.dev/) and list them on the [Demo app repo](https://github.com/Abhinandan-Kushwaha/GiftedChartsDemo?tab=readme-ov-file#gifted-charts-demo).<br />
Your snack might get published in the [Demo app on Play Store!](https://play.google.com/store/apps/details?id=com.giftedcharts.demo)

## License

MIT