lightweight-charts-react-components 📈

A React library of Lightweight-charts components written on Typescript

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.

Installation
Usage
Examples
Contributing
License

Installation

You can install the library via npm, pnpm or yarn:

npm install lightweight-charts-react-components lightweight-charts

Standalone version of the library is also available and includes all the necessary dependencies except react:

<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-react-components/dist/lightweight-charts-react-components.standalone.js"
    crossorigin
  ></script>
</head>
<body>
  <script>
    const { Chart, LineSeries } = LightweightChartsReactComponents;
  </script>
</body>

Usage

tbd

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!

License

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