Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/whawker/react-jsx-highcharts
Highcharts built with proper React components
https://github.com/whawker/react-jsx-highcharts
3d-charts chart chart-library charting-library charts data-visualization dataviz graphs highcharts highstock react reactjs visualization
Last synced: 3 days ago
JSON representation
Highcharts built with proper React components
- Host: GitHub
- URL: https://github.com/whawker/react-jsx-highcharts
- Owner: whawker
- License: mit
- Created: 2017-05-21T14:09:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T11:09:58.000Z (18 days ago)
- Last Synced: 2024-11-06T11:54:52.266Z (10 days ago)
- Topics: 3d-charts, chart, chart-library, charting-library, charts, data-visualization, dataviz, graphs, highcharts, highstock, react, reactjs, visualization
- Language: JavaScript
- Homepage: https://whawker.github.io/react-jsx-highcharts/examples
- Size: 6.22 MB
- Stars: 419
- Watchers: 16
- Forks: 94
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/whawker/react-jsx-highcharts)
[Highcharts](https://github.com/highcharts/highcharts) built with **proper React components**. More that just a simple wrapper - utilises the power of React props to create dynamic charts!
React JSX Highcharts offers separate packages for each Highcharts product.
##### [Highcharts](/packages/react-jsx-highcharts)
##### [Highstock](/packages/react-jsx-highstock)
##### [Highmaps](/packages/react-jsx-highmaps)
## Why React JSX Highcharts?
Unlike other React Highcharts wrapper libraries, **React JSX Highcharts** is designed to be dynamic - it is optimised for _interactive_ charts that need to adapt to business logic in your React application.
Other Highcharts wrappers completely destroy and recreate the chart when the configuration options change, which is _very_ wasteful and inefficient.
React JSX Highcharts uses a different approach. By providing React components for each Highcharts component, we can observe exactly which prop has changed and call the optimal Highcharts method behind the scenes. For example, if the `data` prop were to change on a `` component, React JSX Highcharts can follow Highcharts best practices and use the `setData` method rather than the more expensive `update`.
React JSX Highcharts also enables you to write your _own_ Highcharts components, via its exposed hooks.
## Installation
```sh
# Install the appropriate React JSX package
npm install --save react-jsx-highcharts
# or react-jsx-highstock
# or react-jsx-highmaps
# And the peer dependencies
npm install --save react react-dom highcharts@^11.0.0
```
## Licensing
React JSX Highcharts is free to use, however **Highcharts** itself requires a license for **commercial** use. [Highcharts license FAQs](https://shop.highsoft.com/faq).
## [Documentation](https://github.com/whawker/react-jsx-highcharts/wiki)
## [Examples](https://codesandbox.io/s/github/whawker/react-jsx-highcharts-examples)
## Getting started
The intention of this library is to provide a very thin abstraction of Highcharts using React components. This has been achieved by passing Highcharts configuration options as component props.
In the vast majority of cases, the name of the configuration option, and the name of the component prop are the same.
#### Example
`` component
```jsx
```
This corresponds to the Highcharts' [`tooltip`](http://api.highcharts.com/highcharts/tooltip) configuration of
```js
tooltip: {
enabled: true, // This is assumed when component is mounted
padding: 10,
hideDelay: 250,
shape: 'square',
split: true
}
```
We aim to pass all configuration options using the same name, so we use [Highcharts' documentation](http://api.highcharts.com/highcharts) to figure out how to achieve the same with React JSX Highcharts.
### Note:
There are **two** exceptions to the above;
#### Exception 1
Where Highcharts **events** are concerned - instead of passing `events` as an object, we use the React convention _onEventName_.
#### Example
```jsx
```
This would correspond to the Highcharts configuration
```js
series: [
{
type: 'spline',
id: 'my-series',
data: myData,
events: { hide: this.handleHide, show: this.handleShow }
}
];
```
#### Exception 2
`text` configuration options are passed as a React child
#### Example
```jsx
Some Text Here
```
This would correspond to the Highcharts configuration
```js
title: {
text: 'Some Text Here';
}
```
## Acknowledgements
Thanks to [Recharts](https://github.com/recharts/recharts) for the inspiration of building charts with separate components.
Thanks to Highcharts themselves, obviously.
Thanks to @anajavi for all the help and support in maintaining this project.