Skip to content

Commit

Permalink
Add a README for react-jsx-highstock
Browse files Browse the repository at this point in the history
  • Loading branch information
William Hawker committed Jul 26, 2017
1 parent 050a131 commit 6b0c41e
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions packages/react-jsx-highstock/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# react-jsx-highstock

This package exposes everything from `react-jsx-highcharts`, but additionally provides components for building **Highstock** charts.

N.B. You can build *both* Highcharts **and** Highstock charts from this package.

## Example

```jsx
<HighchartsStockChart>
<Chart onClick={this.handleClick} zoomType="x" />

<Title>Highstocks Example</Title>

<Legend>
<Legend.Title>Key</Legend.Title>
</Legend>

<RangeSelector>
<RangeSelector.Button count={1} type="day">1d</RangeSelector.Button>
<RangeSelector.Button count={7} type="day">7d</RangeSelector.Button>
<RangeSelector.Button count={1} type="month">1m</RangeSelector.Button>
<RangeSelector.Button type="all">All</RangeSelector.Button>
<RangeSelector.Input boxBorderColor="#7cb5ec" />
</RangeSelector>

<Tooltip />

<XAxis>
<XAxis.Title>Time</XAxis.Title>
</XAxis>

<YAxis id="price">
<YAxis.Title>Price</YAxis.Title>
<AreaSplineSeries id="profit" name="Profit" data={data1} />
</YAxis>

<YAxis id="social" opposite>
<YAxis.Title>Social Buzz</YAxis.Title>
<SplineSeries id="twitter" name="Twitter mentions" data={data2} />
</YAxis>

<Navigator>
<Navigator.Series seriesId="profit" />
<Navigator.Series seriesId="twitter" />
</Navigator>
</HighchartsStockChart>
```

## More info

[See here](https://www.npmjs.com/package/react-jsx-highcharts)

0 comments on commit 6b0c41e

Please sign in to comment.