lightweight-charts-react-components
v1.4.0
Published
React components for Lightweight Charts
Downloads
4,486
Maintainers
ukorvlReadme
Description
This library is a set of React components that wraps the Lightweight-charts library. It provides a simple declarative way to use the Lightweight-charts library in your React application. Check out the Demo to see the components in action.
Table of Contents
Installation
You can install the library via npm, pnpm or yarn:
npm install lightweight-charts-react-components lightweight-chartsStandalone version of the library is also available for use in the browser without a build step. You can include it in your HTML file using a script tag. Note that library expects global React, ReactDOM and LightweightCharts variables to be available in the global scope.
<head>
<script
src="https://unpkg.com/react@18/umd/react.production.min.js"
crossorigin
></script>
<script
src="https://unpkg.com/react-dom@18/umd/react-dom.production.min.js"
crossorigin
></script>
<script
src="https://unpkg.com/lightweight-charts/dist/lightweight-charts.standalone.production.js"
crossorigin
></script>
<script
src="https://unpkg.com/lightweight-charts-react-components/dist/lightweight-charts-react-components.standalone.js"
crossorigin
></script>
</head>
<body>
<script>
const { Chart, LineSeries } = LightweightChartsReactComponents;
</script>
</body>Usage
The library provides a set of components that you can use in your React application. Here is a simple example of how to use the Chart and LineSeries components:
import React from "react";
import { Chart, LineSeries } from "lightweight-charts-react-components";
const data = [
{ time: "2023-01-01", value: 100 },
{ time: "2023-01-02", value: 101 },
{ time: "2023-01-03", value: 102 },
];
const App = () => {
return (
<Chart>
<LineSeries data={data} />
</Chart>
);
};
export { App };The following is an advanced example that demonstrates how to use custom scales, panes and multiple series in a single chart:
import React from "react";
import {
Chart,
LineSeries,
HistogramSeries,
PriceScale,
TimeScale,
TimeScaleFitContentTrigger,
Pane,
} from "lightweight-charts-react-components";
const data = [
{ time: "2023-01-01", value: 100 },
{ time: "2023-01-02", value: 101 },
{ time: "2023-01-03", value: 102 },
];
const volumeData = [
{ time: "2023-01-01", value: 1000, color: "rgba(0, 150, 136, 0.5)" },
{ time: "2023-01-02", value: 1100, color: "rgba(0, 150, 136, 0.5)" },
{ time: "2023-01-03", value: 1200, color: "rgba(0, 150, 136, 0.5)" },
];
const chartOptions = {
// Chart options can be customized here
};
const priceScaleOptions = {
// Price scale options can be customized here
};
const App = () => {
return (
<Chart options={chartOptions}>
<Pane stretchFactor={2}>
<LineSeries data={data} />
<PriceScale id="left" options={priceScaleOptions} />
</Pane>
<Pane>
<HistogramSeries data={volumeData} />
</Pane>
<TimeScale>
<TimeScaleFitContentTrigger deps={[]} />
</TimeScale>
</Chart>
);
};
export { App };Examples
The examples app itself is a Demo web application, but it contains a lot of examples of how to use the library. You can find the source code in the samples folder. You can run and test the code locally by cloning the repository and running the examples app.
Contributing
We welcome contributions of all kinds! Whether it's fixing bugs, adding new features, improving examples, or suggesting ideas—your help is greatly appreciated.
How to Contribute
- Fork the repository and create a new branch for your changes.
- Make your changes following the project guidelines.
- Test your changes to ensure everything works as expected.
- Submit a pull request.
For detailed contribution guidelines, please check out our CONTRIBUTING.md Thank you for helping improve this project!
Related Projects
- lightweight-charts - The original Lightweight Charts library by TradingView.
- lightweight-charts-vue - Vue.js wrapper for Lightweight Charts.
License
This project is licensed under the MIT License - see the LICENSE file for details.