EliteChartProps

Documentation / @elitechart/elitechart / EliteChartProps

Public props for <EliteChart />. All fields are optional; defaults give a usable BTCUSD / 1h / candle chart out of the box.

Example

code

import { EliteChart } from '@elitechart/elitechart';
import '@elitechart/elitechart/styles.css';

export default function Page() {
  return (
    <EliteChart
      symbol="BTCUSD"
      timeframe="1h"
      kind="candle"
      onReady={() => console.log('chart mounted')}
    />
  );
}

Properties

children?

code

readonly optional children?: ReactNode;

Defined in: elitechart/src/types.ts:70

Slot — rendered inside the workspace shell, above the chart. Use for custom branding or announcements.

className?

code

readonly optional className?: string;

Defined in: elitechart/src/types.ts:63

Class applied to the outer workspace container.

kind?

code

readonly optional kind?: EliteChartKind;

Defined in: elitechart/src/types.ts:55

Initial chart kind. Defaults to 'candle'.

onReady?

code

readonly optional onReady?: () => void;

Defined in: elitechart/src/types.ts:61

Lifecycle hook fired once the chart has mounted and the handle is live. Use this to attach custom event listeners, seed drawings, or sync your own app state.

Returns

void

style?

code

readonly optional style?: CSSProperties;

Defined in: elitechart/src/types.ts:65

Inline style for the outer workspace container.

symbol?

code

readonly optional symbol?: string;

Defined in: elitechart/src/types.ts:51

Initial ticker symbol. Defaults to the first mock symbol.

timeframe?

code

readonly optional timeframe?: EliteChartTimeframe;

Defined in: elitechart/src/types.ts:53

Initial timeframe. Defaults to '1h'.