This repository is a fork of react-financial-charts with minor UI customizations.
Customizations at this point are limited to the series
and axes
packages.
- Add the spark npm repository to your
.npmrc
npm config set @spark:registry https://tzawsus001.sparksystems.sg:8443/
- Install the packages with the
@spark
scope
npm install @spark/react-finacial-charts-series @spark/react-financial-charts-axes
- Import from the components as required
import { CandlestickSeries } from '@spark/react-financial-charts-series'; import { XAxis } from '@spark/react-financial-charts-axes';
- Create a
-RC
or-PA
branch - Commit changes with messages following the conventional commits style of commit messages
→ The commit messages will be used for the changelog - Approve the release job in Circle CI
- This will create a release commit and with tag
- The tag will trigger a
publish
job, publishing the package to the spark repository
ORIGINAL README BELOW
Note: this repo is a fork of react-stockcharts, renamed, converted to typescript and bug fixes applied due to the original project being unmaintained.
Note: v1 is a fully breaking change with large parts, if not all, rewritten. Do not expect the same API! although the same features should exist.
Charts dedicated to finance.
The aim with this project is create financial charts that work out of the box.
- integrates multiple chart types
- technical indicators and overlays
- drawing objects
- Scatter
- Area
- Line
- Candlestick
- OHLC
- HeikenAshi
- Renko
- Kagi
- Point & Figure
- EMA, SMA, WMA, TMA
- Bollinger band
- SAR
- MACD
- RSI
- ATR
- Stochastic (fast, slow, full)
- ForceIndex
- ElderRay
- Elder Impulse
- Trendline
- Fibonacci Retracements
- Gann Fan
- Channel
- Linear regression channel
npm install react-financial-charts
Refer to CONTRIBUTING.md
This project is a mono-repo that uses Lerna to manage dependencies between packages.
To get started run:
git clone https://github.com/react-financial/react-financial-charts.git
cd react-financial-charts
npm ci
npm run build
To start up a development server run:
npm start
- Convert to typescript
- Bump dependencies to latest
- Remove React 16 warnings
- Add CI
- Fix passive scrolling issues
- Implement PRs from react-stockcharts
- Add all typings
- Move examples to storybook
- Add all series' to storybook
- Split project into multiple packages
- Fix issues with empty datasets
- Correct all class props
- Migrate to new React Context API
- Remove all UNSAFE methods
- Add documentation to storybook
- Add full test suite