@elitechart/react

Documentation

Documentation / @elitechart/react

@elitechart/react — minimal headless React adapter for the ChartForge charting engine.

Three exports power 99% of integrations:

• Chart — <Chart /> primitive, mounts createChart() and exposes the engine handle through a forwarded ref.
• useChart — reactive hook that returns the live ChartHandle once the chart has booted (null before).
• useChartTheme — [theme, setTheme] tuple that pushes every theme change through chart.setTheme(theme).

The bundle prepends 'use client'; (see tsup.config.ts) so the package can be imported directly from a Next.js App Router server component without manual client-component boilerplate.

Interfaces

• Bar
• ChartForgeTheme
• ChartHandle
• ChartHandleStore
• ChartOptions
• ChartProps
• ChartRef
• Series
• SymbolInfo

Type Aliases

• Price
• SeriesKind
• TickSize
• TimestampMs
• Volume

Variables

• Chart

Functions

• useChart
• useChartTheme