search

justinkx / react-crypto-chart

crypto chart widget for react using binance api
https://www.npmjs.com/package/react-crypto-chart
MIT License
22 stars 13 forks source link
crypto react

readme

React Crypto Chart

Latest Github release MIT License Version[Github All Releases]()Issues [GitHub pull requests]() [NPM Version]()[GitHub last commit]()

crypto chart widget for react using binance api

React Crypto Chart

Example

cd example
npm install
npm start

How To Install

npm i react-crypto-chart

yarn

yarn add react-crypto-chart

Usage

import TradeViewChart from 'react-crypto-chart';

<TradeViewChart pair="BTCBUSD" />;

Properties

Prop Required Type Default Value
pair No String BTCBUSD
Please refer binance api for more pairs
binance rest api
interval No String 1m
candleStickConfig No Object
Candlestick Config type		 
 
    {
        upColor: "#00c176",
        downColor: "#cf304a",
        borderDownColor: "#cf304a",
        borderUpColor: "#00c176",
        wickDownColor: "#838ca1",
        wickUpColor: "#838ca1",
    }
histogramConfig No Object
Histogram Config type		 
{
        base: 0,
        lineWidth: 2,
        priceFormat: {
            type: "volume",
        },
        overlay: true,
        scaleMargins: {
            top: 0.8,
            bottom: 0,
        },
    }
chartLayout No Object
Chart Layout types		 
    {
        layout: {
            backgroundColor: "#ededed",
            textColor: "#253248",
        },
        grid: {
            vertLines: {
            color: "#838fa3",
            style: LineStyle.SparseDotted,
            },
            horzLines: {
            color: "#838fa3",
            style: LineStyle.SparseDotted,
            },
        },
        crosshair: {
            mode: CrosshairMode.Normal,
        },
        priceScale: {
            borderColor: "#485c7b",
        },
        timeScale: {
            borderColor: "#485c7b",
            timeVisible: true,
            secondsVisible: false,
        },
    }
containerStyle No Object 
    {
      maxWidth: '100%',
      maxHeight: '100vh',
      display: 'flex',
      justifyContent: 'center',
      alignItems: 'center',
    }

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

😊Pull requests accepted with ❤️