Lightweight Charts React Components
GitHubOfficialCreated by ukorvlDistributed by GitHub
- Skill
- Tool integration
- Software development
- MIT
- No issues found
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides a set of React components and recipes for integrating TradingView's lightweight-charts library into React applications. It simplifies the management of chart lifecycles, series creation, and data updates. The library supports various chart types including candlestick, line, and area series, along with advanced features like real-time WebSocket updates, synchronized charts, and custom tooltips. It is designed to handle complex financial data requirements such as infinite history scrolling, indicator panes, and trade markers while maintaining React's declarative programming model.
What it does
- Provides React components for rendering TradingView lightweight-charts.
- Manages chart and series lifecycle, including creation and cleanup.
- Supports real-time data updates via WebSocket integration.
- Enables complex UI features like crosshair legends, tooltips, and trade markers.
- Facilitates synchronized multi-chart layouts and custom axis configurations.
- Handles infinite history loading and viewport management.
When to use it
- When building financial or trading dashboards in a React application.
- When you need to integrate TradingView lightweight-charts with React state.
- When implementing features like real-time price updates or historical data pagination.
- When creating complex chart layouts with indicators, volume panes, or synchronized crosshairs.
Advantages
- Declarative component-based API for chart configuration.
- Automatic management of chart lifecycle and DOM cleanup.
- Built-in recipes for common financial charting patterns.
- Flexible data handling for both static datasets and live streaming updates.
Usage examples
- “How do I create a basic line chart using lightweight-charts-react-components?”
- The agent provides a code snippet using the Chart and LineSeries components, demonstrating how to pass data and configure container dimensions.
- “How can I implement a tooltip that shows OHLC values on hover?”
- The agent provides a recipe using onCrosshairMove to track cursor position and map it to the series data, rendering a custom React tooltip.
- “How do I handle infinite scrolling for historical data?”
- The agent provides a pattern for using a ref-based data store and a loadOlder callback to prepend data to the chart without losing the user's current view.
Install
Download the skill as a ZIP:
https://mp-staging.autogineer.com/agent-skills/github/lightweight-charts-react-components/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip lightweight-charts-react-components.zip -d .agents/skills
Documentation by ukorvl
lightweight-charts-react-components guide
Quick Start
Let the components manage chart and series creation and cleanup. Import components
and ref types from lightweight-charts-react-components; import native data, option,
and event types from lightweight-charts.
Check versions against the compatibility table below. Read declared ranges from the app's
package.json, then the installed versions from theversionfield ofnode_modules/<package>/package.jsonforlightweight-charts-react-components,lightweight-charts,react, andreact-dom. If the library is not installed, follow Installation. Ensure chart rendering runs in the browser, within the app's client boundary.For a basic static chart, start from the minimal chart below. Otherwise, read the reference matching the requested behavior. Adapt its feed and UI; preserve its data contract, component nesting, and API readiness handling.
Choose one data owner: pass the complete dataset through
datafor React-owned updates, or usereactive={false}and the series API for frequent ticks.
Installation
Install the wrapper together with its lightweight-charts peer dependency, using
the project's package manager. React and React DOM must already be installed.
npm install lightweight-charts-react-components lightweight-chartsMinimal chart
import type { LineData, UTCTimestamp } from "lightweight-charts";
import {
Chart,
LineSeries,
TimeScale,
TimeScaleFitContentTrigger,
} from "lightweight-charts-react-components";
// Data must be sorted ascending by time with unique times (UTC seconds here).
export function SimpleLineChart({ data }: { data: LineData<UTCTimestamp>[] }) {
return (
// autoSize follows the container, which needs a nonzero height.
<Chart
options={{ autoSize: true }}
containerProps={{ style: { height: 300, width: "100%" } }}
>
<LineSeries data={data} />
<TimeScale>
<TimeScaleFitContentTrigger deps={[]} />
</TimeScale>
</Chart>
);
}Examples and snippets (reference files)
Read the reference matching the user's outcome. Each contains a complete TypeScript recipe, data and integration contracts, reasons for the architecture, failure modes, and acceptance checks. Combine references when a task spans several outcomes; do not load every reference for a simple chart.
| User request | Reference |
|---|---|
| WebSocket candles, updating the current bar, stale history, excessive chart renders | Market data and live updates |
| Older history on scroll, viewport jumps, symbol/interval changes, late API responses | History and range selection |
| Candles plus volume, moving averages, oscillator panes, independent price scales | Price, volume, and indicators |
| OHLC legend, hover details, missing data, tooltip positioning | Hover legends and tooltips |
| Executions and signals, stop/target levels, click-to-place price lines | Trade markers and price levels |
| Compare assets with different prices, fixed-baseline returns, toggle comparisons | Performance comparison |
| Separate charts that share scrolling, zooming, and a crosshair | Synchronized charts |
| Trading-session shading, pane backgrounds, custom drawing that follows zoom | Session overlays and primitives |
| Options strikes, yield maturities, choosing a numeric or custom horizontal axis | Numeric axes and chart types |
If no reference matches the request, tell the user that the skill has no recipe
for it. Then build the solution from the public components and the upstream
lightweight-charts API, applying the Quick Start rules and the edge cases below.
Skill compatibility
The recipes are verified against the reference versions below. These are the tested baseline, not the latest available releases.
If an installed version differs from the reference version, compare it with the compatibility range. Inside the range, recipes apply as written. Outside it, tell the user about the mismatch before writing code, because breaking API changes can affect the recipes, and verify every API the recipe uses against the installed package.
| Dependency or environment | Reference version | Compatibility range and checks |
|---|---|---|
lightweight-charts-react-components | 2.6.1 | Recipe target: >=2.6.1 <3. Other versions require checking installed exports, chart API refs, and reactive data behavior before adapting a recipe. |
lightweight-charts | 5.2.1 | Declared peer: >=5.0.8 <6. |
| React and React DOM | 19.2.6 | Declared peers: >=18.2 <20. Keep react and react-dom on matching versions and use the application's existing React instance. |
| Node.js | — | Package engines: >=18.14.0. The app's build tools can require a newer version. |
| Module system | ESM | ESM import entry only; there is no CommonJS require entry. |
| Rendering | Browser | Charts need the DOM and canvas. Render them on the client, never during server rendering. |
Common edge cases
Chart sizing: Put DOM styles on
containerPropsand give the chart a nonzero height.Required ancestors: Headless chart children need a chart wrapper ancestor.
Markers,PriceLine, andSeriesPrimitivebelong inside their series;PriceScale,Watermark, andPanePrimitiverequire aPane;TimeScaleFitContentTriggerrequires aTimeScale.API refs and readiness: Use
ref.current?.api()for the native API andcontainerReffor the div. ForChart, useChartApiRef<Time, IChartApi>..api()can initially return null; follow the recipe's readiness step before imperative setup.Viewport resets: To preserve scroll/zoom, keep the chart's key stable and live/history updates out of fit-trigger dependencies. Fit on initial load or a deliberate reset. See range handling.
Data updates: Use
datafor React-owned updates, orreactive={false}and the series API when per-tick React renders are measurably costly. Avoid mixing both. Reactivedatais always the complete dataset. With wrapper 2.6.1 and Lightweight Charts 5.2.1,series.data()reconstructs candle and line objects; the wrapper's earlier-item reference comparison therefore sends multi-bar tail updates throughsetData(), even when React keeps earlier references stable. Keep data immutable, but use the chart-ownedreactive={false}recipe and explicitseries.update(bar)when incremental writes are required. See live updates.
Source
Adapted from ukorvl/lightweight-charts-react-components
at commit 0368191127568e48aef6f7bda2ff3900e8e24756. Original author: ukorvl.
The MIT license and all nine reference recipes are retained. Local
corrections in live updates reject
malformed timestamps and explain the tested versions' reactive-update limitation;
session overlays clarifies the
primitive update callback.
The other seven references and MIT notice are unchanged. This catalog copy adds
source attribution and operational boundaries; it does not imply TradingView
endorsement.
Recipes generate application code and can change dependencies. Follow the user's requested scope and the host's approval policy. Feed access belongs to the app's separately authorized adapter; keep credentials out of client code. Trade markers are visual annotations, not order execution or server-side alerts. Use synthetic data for local checks and report browser/feed behavior that remains untested.
Files
- ATTRIBUTION.mdAdded by AutoGineer1.0 KiB
- LICENSE1.0 KiB
- SKILL.md10.1 KiB
- references/history-and-range-selection.md11.5 KiB
- references/hover-legends-and-tooltips.md8.1 KiB
- references/market-data-and-live-updates.md11.9 KiB
- references/numeric-axes-and-chart-types.md10.3 KiB
- references/performance-comparison.md7.2 KiB
- references/price-volume-and-indicators.md9.9 KiB
- references/session-overlays-and-primitives.md10.1 KiB
- references/synchronized-charts.md8.7 KiB
- references/trade-markers-and-price-levels.md10.1 KiB
references/synchronized-charts.md
Synchronized charts
Use this when independent chart cards need shared scrolling, zoom, and a cursor: for example a price chart beside a benchmark or two separate dashboard widgets. For price, volume, and indicators in a vertically stacked view, first use one chart with panes; the shared horizontal scale already provides that coordination.
The library has no dedicated synchronization component; the recipe below combines the public chart and time-scale APIs.
Choose the synchronization coordinate
| Relationship | Range to synchronize | Constraint |
|---|---|---|
| Identical timestamp grid | Time bounds or logical bounds | Same time/index meaning in both charts |
| Different calendars or missing bars | Time bounds | Logical index 50 need not mean the same date |
| Same visible bar count only | Logical bounds | This is not necessarily calendar alignment |
The recipe below requires the same complete UTC-second grid in both charts. Use time bounds so the intended calendar window is explicit. With differing histories, upstream range clamping can produce competing ranges; normalize the shared domain first or use a designated leader and a documented follower-clamping policy. Do not blindly use bidirectional callbacks over incompatible domains.
Recipe: two line charts with range and crosshair synchronization
first and second contain sorted unique real-valued points with identical
timestamps. Mount by dataset identity after both snapshots load. Chart widths
can differ: time bounds synchronize the displayed dates, not pixel spacing.
CrosshairMode.Normal keeps cursor behavior predictable when transferring a
time/value to another series.
import { useCallback, useEffect, useMemo, useRef } from "react";
import { CrosshairMode } from "lightweight-charts";
import type {
IChartApi,
IRange,
LineData,
MouseEventParams,
Time,
UTCTimestamp,
} from "lightweight-charts";
import {
Chart,
LineSeries,
TimeScale,
type ChartApiRef,
type SeriesApiRef,
} from "lightweight-charts-react-components";
type Side = "first" | "second";
type Point = LineData<UTCTimestamp>;
export function SynchronizedCharts({
first,
second,
}: {
first: Point[];
second: Point[];
}) {
const firstChart = useRef<ChartApiRef<Time, IChartApi>>(null);
const secondChart = useRef<ChartApiRef<Time, IChartApi>>(null);
const firstSeries = useRef<SeriesApiRef<"Line">>(null);
const secondSeries = useRef<SeriesApiRef<"Line">>(null);
const forwardingRange = useRef(false);
const pointerOwner = useRef<Side | null>(null);
const firstValues = useMemo(
() => new Map(first.map(point => [point.time, point.value])),
[first]
);
const secondValues = useMemo(
() => new Map(second.map(point => [point.time, point.value])),
[second]
);
const forwardRange = useCallback((source: Side, range: IRange<Time> | null) => {
if (!range || forwardingRange.current) return;
const target = (source === "first" ? secondChart : firstChart).current
?.api()
?.timeScale();
if (!target) return;
const existing = target.getVisibleRange();
// Equality also stops deferred notifications after the synchronous guard
// has been cleared. Inputs here use numeric timestamps exclusively.
if (existing?.from === range.from && existing?.to === range.to) return;
forwardingRange.current = true;
try {
target.setVisibleRange(range);
} finally {
forwardingRange.current = false;
}
}, []);
const forwardCrosshair = useCallback(
(source: Side, param: MouseEventParams) => {
// Only a chart currently under the user's pointer can lead. Programmatic
// changes on the follower must not become new input on the source.
if (pointerOwner.current !== source) return;
const targetChart = (source === "first" ? secondChart : firstChart).current?.api();
const targetSeries = (
source === "first" ? secondSeries : firstSeries
).current?.api();
const values = source === "first" ? secondValues : firstValues;
if (!targetChart || !targetSeries) return;
const value =
typeof param.time === "number"
? values.get(param.time as UTCTimestamp)
: undefined;
if (!param.point || value === undefined || typeof param.time !== "number") {
targetChart.clearCrosshairPosition();
return;
}
// A matching time uses the target's own value, never the source's price or
// y pixel. The target series provides the correct price scale and pane.
targetChart.setCrosshairPosition(value, param.time, targetSeries);
},
[firstValues, secondValues]
);
useEffect(() => {
let frame = 0;
const initialize = () => {
const a = firstChart.current?.api();
const b = secondChart.current?.api();
if (!a || !b || !firstSeries.current?.api() || !secondSeries.current?.api()) {
frame = requestAnimationFrame(initialize);
return;
}
a.timeScale().fitContent();
const range = a.timeScale().getVisibleRange();
if (range) b.timeScale().setVisibleRange(range);
};
initialize();
return () => cancelAnimationFrame(frame);
}, []);
const leave = () => {
pointerOwner.current = null;
firstChart.current?.api()?.clearCrosshairPosition();
secondChart.current?.api()?.clearCrosshairPosition();
};
return (
<div
style={{
display: "grid",
gridTemplateColumns: "repeat(auto-fit, minmax(min(100%, 320px), 1fr))",
gap: 16,
}}
>
<Chart
ref={firstChart}
options={{ autoSize: true, crosshair: { mode: CrosshairMode.Normal } }}
containerProps={{
style: { height: 300 },
onPointerEnter: () => {
pointerOwner.current = "first";
},
onPointerLeave: leave,
}}
onCrosshairMove={param => forwardCrosshair("first", param)}
>
<LineSeries ref={firstSeries} data={first} options={{ color: "#2563eb" }} />
<TimeScale onVisibleTimeRangeChange={range => forwardRange("first", range)} />
</Chart>
<Chart
ref={secondChart}
options={{ autoSize: true, crosshair: { mode: CrosshairMode.Normal } }}
containerProps={{
style: { height: 300 },
onPointerEnter: () => {
pointerOwner.current = "second";
},
onPointerLeave: leave,
}}
onCrosshairMove={param => forwardCrosshair("second", param)}
>
<LineSeries ref={secondSeries} data={second} options={{ color: "#ea580c" }} />
<TimeScale onVisibleTimeRangeChange={range => forwardRange("second", range)} />
</Chart>
</div>
);
}Use onPointerDown as another owner-setting signal when adapting to touch input
whose hover behavior differs. The wrapper cleans up TimeScale and chart
subscriptions; this recipe cleans up only its own readiness frame. Do not remove
wrapper-owned native charts in a separate effect.
Adaptation and failure modes
For intrabar precision or future right-side whitespace on identical grids, logical bounds can preserve fractional bar positions better than time bounds. Replace both range callbacks and getters/setters consistently with their logical variants, and compare both numeric endpoints before setting. Keep a reentrancy guard as well.
For different calendars, resolve the target crosshair by exact time and clear it when missing, as above. If the product wants nearest-previous matching, implement that search deliberately and indicate the actual matched timestamp in hover UI. Never copy the source y pixel or use its price on a target with different units.
Two independently fitting charts can undo synchronization after data changes. Let a selected leader choose the view after both datasets update; follower charts should not also fit on each tick. For large dashboard grids, store one shared range in the application and broadcast only when endpoints change.
Acceptance checks
Pan/zoom either chart and verify the other shows matching dates without an event loop. Test differing widths and a resize of the cards.
Move the crosshair in both directions. The target selects its own value at the same time, even when one series' values are 100 times larger.
Leave a card or hover missing data: the follower cursor clears. Programmatic updates never become a new crosshair leader.
Remount under a new dataset key and verify old callbacks/frames do not retain the removed chart. Test any calendar policy added during adaptation.
Requirements and compatibility
Written for: GitHub Copilot
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs Node.js
Security
No issues found by our static scan· No issues found
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Created by
- ukorvl
- Publisher
- GitHub (Official)
- Distributed by
- GitHub
- Source
- github/awesome-copilot · skills/lightweight-charts-react-components · commit 797337f
- Licence
- MIT License (redistribution allowed)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by ukorvl or GitHub.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download lightweight-charts-react-components.zip