• Stars
    star
    270
  • Rank 152,189 (Top 3 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created almost 7 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

React component for rendering the TradingView Advanced Real-Time Chart Widget.

react-tradingview-widget

React component for rendering the TradingView Advanced Real-Time Chart Widget.

Install

yarn add react-tradingview-widget or npm install --save react-tradingview-widget

Usage

Basic example

import TradingViewWidget from 'react-tradingview-widget';

const App = () => (
  <TradingViewWidget symbol="NASDAQ:AAPL" />
);

All given props are passed on to the widget config. See this page for the TradingView Advanced Real-Time Chart API.

Advanced example

import TradingViewWidget, { Themes } from 'react-tradingview-widget';

const App = () => (
  <TradingViewWidget
    symbol="NASDAQ:AAPL"
    theme={Themes.DARK}
    locale="fr"
    autosize
  />
);

Constants and API differences

react-tradingview-widget exports constants for the following things:

  • Interval types: IntervalTypes.D and IntervalTypes.W
  • Range types (for the range prop): RangeTypes.YTD and RangeTypes.ALL
  • Themes: Themes.LIGHT and Themes.DARK
  • BarStyles:
    • BarStyles.BARS
    • BarStyles.CANDLES
    • BarStyles.HOLLOW_CANDLES
    • BarStyles.HEIKIN_ASHI
    • BarStyles.LINE
    • BarStyles.AREA
    • BarStyles.RENKO
    • BarStyles.LINE_BREAK
    • BarStyles.KAGI
    • BarStyles.POINT_AND_FIGURE

You don't have to use these constants.

react-tradingview-widget also makes it possible to use numbers for interval, popup_width and popup_height instead of strings, but this is not required.