Git Product home page Git Product logo

react-crypto-chart's Introduction

React Crypto Chart

Latest Github release MIT License VersionGithub All ReleasesIssues GitHub pull requests NPM VersionGitHub last commit

crypto chart widget for react using binance api

React Crypto Chart

Example

  • Example App:
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

  • Justin K Xavier - Initial work - LinkedIn

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 ❤️

react-crypto-chart's People

Contributors

justinkx avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

react-crypto-chart's Issues

Documentation mismatch

Your documentation says the props are not required however Typescript says otherwise :)
image

you should use ? on each one of them if you want to make them optional.


export interface Props {
    pair: string;
    interval?: string;
    candleStickConfig?: CandleStickConfig;
    histogramConfig?: HistogramConfig;
    chartLayout?: DeffaultChartLayout;
    containerStyle?: {
        [x: string]: any;
    };
}

No chart is displayed

I have installed the package and am using the widget but there is nothing visible. How to troubleshoot this issue?

error from the component

Very good package, Is there any way to handle errors with this? Sometimes the package crashes if there's a little delay in fetching the component.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.