react-klinecharts-ui 0.4.0 → 0.6.0

package/dist/index.d.ts

@@ -1,14 +1,79 @@
 import * as react from 'react';
 import { Dispatch, RefObject, ReactNode, ReactElement } from 'react';
-import { Period, SymbolInfo, KLineData, Chart, DeepPartial, Styles, OverlayTemplate, YAxisOverride, DataLoader, IndicatorTemplate } from 'react-klinecharts';
-import { OrderLineExtendData } from './extensions.js';
-export { DepthOverlayExtendData, DepthOverlayRow, OrderLineFontStyle, OrderLineLabelStyle, OrderLineLineStyle, OrderLineMarkStyle, OrderLinePadding, depthOverlay, indicators, orderLine, overlays, registerExtensions } from './extensions.js';
+import { Period, SymbolInfo, KLineData, Chart, DeepPartial, Styles, OverlayTemplate, YAxisOverride, HotkeyTemplate, Hotkey, XAxisOverride, DataLoader, IndicatorTemplate } from 'react-klinecharts';
+export { Hotkey, HotkeyActionParams, HotkeyTemplate, XAxisOverride, YAxisOverride } from 'react-klinecharts';
+import { AlertLineExtendData, OrderLineExtendData } from './extensions.js';
+export { DepthOverlayExtendData, DepthOverlayRow, OrderLineFontStyle, OrderLineLabelStyle, OrderLineLineStyle, OrderLineMarkStyle, OrderLinePadding, alertLine, depthOverlay, indicators, orderLine, overlays, registerExtensions } from './extensions.js';
 
 interface TerminalPeriod extends Period {
     label: string;
 }
 declare const DEFAULT_PERIODS: TerminalPeriod[];
 
+/**
+ * Shared domain types for stateful feature hooks (`useAlerts`, `useMeasure`,
+ * `useReplay`).
+ *
+ * These live in a neutral module so they can be referenced both by the
+ * provider store (`KlinechartsUIState` / actions in `./types`) and by the
+ * hooks, without creating a circular import between the two. The hooks
+ * re-export them so the public API surface (consumed via the package root)
+ * stays unchanged.
+ */
+
+type AlertCondition = "crossing_up" | "crossing_down" | "crossing";
+interface Alert {
+    id: string;
+    price: number;
+    condition: AlertCondition;
+    message?: string;
+    triggered: boolean;
+    /**
+     * Visual style for the alert line overlay (color, label text, line/mark
+     * styling, bell marker). Persisted in the store so it survives undo/redo
+     * and layout presets.
+     */
+    extendData?: AlertLineExtendData;
+}
+interface MeasurePoint {
+    price: number;
+    timestamp: number;
+    barIndex: number;
+}
+interface MeasureResult {
+    from: MeasurePoint;
+    to: MeasurePoint;
+    /** Absolute price difference */
+    priceDiff: number;
+    /** Percentage change from → to */
+    pricePercent: number;
+    /** Number of bars between the two points */
+    bars: number;
+    /** Time difference in milliseconds */
+    timeDiff: number;
+}
+interface MeasureState {
+    /** Whether measure mode is active (waiting for clicks) */
+    isActive: boolean;
+    /** First point (set after first click) */
+    fromPoint: MeasurePoint | null;
+    /** Current measurement result (null until both points are set) */
+    result: MeasureResult | null;
+}
+type ReplaySpeed = 1 | 2 | 5 | 10;
+interface ReplayState {
+    /** Whether a replay session is active */
+    isReplaying: boolean;
+    /** Whether the replay is currently paused */
+    isPaused: boolean;
+    /** Current playback speed multiplier */
+    speed: ReplaySpeed;
+    /** Current bar index in the replay */
+    barIndex: number;
+    /** Total number of bars in the saved data */
+    totalBars: number;
+}
+
 /**
  * Explicit partial symbol type — avoids `PickPartial<SymbolInfo, ...>` which
  * degenerates when SymbolInfo has an index signature `[key: string]: unknown`.
@@ -74,6 +139,37 @@ interface KlinechartsUIState {
      * undo/redo and layout presets.
      */
     indicatorAxes: Record<string, string>;
+    /**
+     * Visibility overrides for indicators, keyed by indicator id
+     * (`main_<name>` / `sub_<name>`), value is whether the indicator is shown.
+     * Mirrors the `visible` flag held inside klinecharts so `useIndicators` can
+     * expose a reactive getter (the chart instance has no React-friendly read
+     * path). Only populated for indicators whose visibility has been toggled
+     * away from the default; an absent key means visible (`true`). Updated by
+     * `setIndicatorVisible` and the collapse/expand helpers, and rebuilt when a
+     * layout preset is restored so the mirror never drifts from the chart.
+     */
+    indicatorVisibility: Record<string, boolean>;
+    /**
+     * Price alerts (`useAlerts`). Lives in the shared store rather than per-hook
+     * local state so every consumer (toolbar, list panel, status bar, sound
+     * trigger) observes one synchronized list. The crossing poller and the
+     * `onAlertTriggered` listener are owned by the provider, not the hook.
+     */
+    alerts: Alert[];
+    /**
+     * Measure-tool state (`useMeasure`). Shared so the toolbar toggle and the
+     * result readout panel stay in sync regardless of where each is mounted.
+     */
+    measure: MeasureState;
+    /**
+     * Historical-replay control state (`useReplay`). Shared so play/pause/step
+     * controls in different components drive one session. The playback interval
+     * and data buffers are owned by the provider (see the `replay*Ref` fields on
+     * the dispatch value), guaranteeing a single timer no matter how many hook
+     * instances are mounted.
+     */
+    replay: ReplayState;
     styles: DeepPartial<Styles> | undefined;
     screenshotUrl: string | null;
 }
@@ -104,6 +200,18 @@ type KlinechartsUIAction = {
 } | {
     type: "SET_INDICATOR_AXES";
     axes: Record<string, string>;
+} | {
+    type: "SET_INDICATOR_VISIBILITY";
+    visibility: Record<string, boolean>;
+} | {
+    type: "SET_ALERTS";
+    alerts: Alert[];
+} | {
+    type: "SET_MEASURE";
+    measure: Partial<MeasureState>;
+} | {
+    type: "SET_REPLAY";
+    replay: Partial<ReplayState>;
 } | {
     type: "SET_STYLES";
     styles: DeepPartial<Styles> | undefined;
@@ -127,6 +235,20 @@ interface KlinechartsUIDispatchValue {
     fullscreenContainerRef: RefObject<HTMLElement | null>;
     /** Ref populated by useUndoRedo; other hooks call it to record actions. */
     undoRedoListenerRef: RefObject<UndoRedoListener | null>;
+    /**
+     * Listener set by `useAlerts.onAlertTriggered`; invoked by the provider-owned
+     * crossing poller when an alert fires. Last writer wins (one active listener).
+     */
+    alertTriggeredListenerRef: RefObject<((alert: Alert) => void) | null>;
+    /**
+     * Provider-owned replay resources, shared across every `useReplay` instance
+     * so there is exactly one playback timer and one data buffer. The hook reads
+     * and writes these instead of its own refs; the provider clears the interval
+     * on unmount.
+     */
+    replayIntervalRef: RefObject<ReturnType<typeof setInterval> | null>;
+    replaySavedDataRef: RefObject<KLineData[]>;
+    replayIndexRef: RefObject<number>;
 }
 /** Combined context value returned by `useKlinechartsUI()`. */
 interface KlinechartsUIContextValue extends KlinechartsUIDispatchValue {
@@ -187,6 +309,13 @@ declare function useSymbolSearch(debounceMs?: number): UseSymbolSearchReturn;
 interface IndicatorInfo {
     name: string;
     isActive: boolean;
+    /**
+     * Whether the indicator is currently visible on the chart. Defaults to
+     * `true`; only `false` after the indicator has been hidden via
+     * `setIndicatorVisible` or `collapseSubIndicator`. Meaningful only when
+     * `isActive` is `true` (inactive indicators are always reported `true`).
+     */
+    visible: boolean;
 }
 /** Options accepted when adding an indicator. */
 interface AddIndicatorOptions {
@@ -214,6 +343,13 @@ interface UseIndicatorsReturn {
     moveToMain: (name: string) => void;
     moveToSub: (name: string) => void;
     setIndicatorVisible: (name: string, isMain: boolean, visible: boolean) => void;
+    /**
+     * Read whether an indicator is currently visible. Returns `true` for the
+     * default (un-toggled) state and for inactive indicators. This is the
+     * reactive read counterpart to `setIndicatorVisible` — UI no longer needs to
+     * track visibility locally or reach into the chart instance.
+     */
+    isIndicatorVisible: (name: string, isMain: boolean) => boolean;
     updateIndicatorParams: (name: string, paneId: string, params: number[]) => void;
     getIndicatorParams: (name: string) => {
         label: string;
@@ -236,6 +372,13 @@ interface UseIndicatorsReturn {
     indicatorAxes: Record<string, string>;
     /** Get the custom `yAxisId` an indicator is bound to, or `undefined` for the default axis. */
     getIndicatorAxis: (name: string, isMain: boolean) => string | undefined;
+    /**
+     * Visibility overrides keyed by indicator id (`main_<name>` / `sub_<name>`).
+     * Only contains indicators hidden away from the default; an absent key means
+     * visible. Mirror of the provider state, exposed for layout-preset
+     * persistence and direct rendering.
+     */
+    indicatorVisibility: Record<string, boolean>;
     /**
      * Rebind an existing indicator to a different Y-axis. Because klinecharts v10
      * `overrideIndicator` cannot change axis binding, this removes and recreates
@@ -373,6 +516,58 @@ interface UseScreenshotReturn {
 }
 declare function useScreenshot(): UseScreenshotReturn;
 
+interface UseHotkeysReturn {
+    /**
+     * Register a custom hotkey globally. Idempotent per `template.name` — calling
+     * again with the same name replaces the previous handler. The `action`
+     * callback receives the chart instance, the keyboard event and the matched
+     * hotkey template (see klinecharts `HotkeyActionParams`).
+     */
+    registerHotkey: (template: HotkeyTemplate) => void;
+    /** Look up a registered hotkey template by name (built-in or custom). */
+    getHotkey: (name: string) => HotkeyTemplate | null;
+    /** Names of every registered hotkey (built-in + custom). */
+    supportedHotkeys: string[];
+    /**
+     * Enable or disable hotkey handling for the current chart. Pass `exclude`
+     * to keep hotkeys on but silence specific ones by name.
+     */
+    setHotkeysEnabled: (enabled: boolean, exclude?: string[]) => void;
+    /** The current hotkey config (`{ enabled, exclude }`) for the chart, or null. */
+    getHotkeysConfig: () => Hotkey | null;
+}
+/**
+ * Headless hook for klinecharts v10 keyboard shortcuts (added in
+ * klinecharts 10.0.0-beta3).
+ *
+ * Custom hotkeys are registered **globally** via klinecharts `registerHotkey`,
+ * so a shortcut defined here is shared by every chart in the page; the
+ * per-chart enable/exclude switches operate on the provider's chart instance.
+ */
+declare function useHotkeys(): UseHotkeysReturn;
+
+interface UseChartAxesReturn {
+    /**
+     * Override the main pane's X (time) axis — e.g. `scrollZoomEnabled`,
+     * `name`, or a custom `createTicks` generator. Added in klinecharts
+     * 10.0.0-beta2.
+     */
+    overrideXAxis: (override: XAxisOverride) => void;
+    /**
+     * Override a Y (value) axis — e.g. `reverse` to flip the price scale,
+     * `inside` to draw labels inside the pane, `position`, or a custom
+     * `createRange` / `createTicks`. Target a specific axis with `id` / `paneId`.
+     * Added in klinecharts 10.0.0-beta2.
+     */
+    overrideYAxis: (override: YAxisOverride) => void;
+}
+/**
+ * Headless hook for overriding the chart's built-in X / Y axes (klinecharts
+ * v10 `overrideXAxis` / `overrideYAxis`). For binding indicators to additional
+ * secondary Y-axes, use {@link useIndicators} instead.
+ */
+declare function useChartAxes(): UseChartAxesReturn;
+
 interface UseFullscreenReturn {
     isFullscreen: boolean;
     toggle: () => void;
@@ -561,21 +756,22 @@ interface UseCrosshairReturn {
 }
 declare function useCrosshair(): UseCrosshairReturn;
 
-type AlertCondition = "crossing_up" | "crossing_down" | "crossing";
-interface Alert {
-    id: string;
-    price: number;
-    condition: AlertCondition;
-    message?: string;
-    triggered: boolean;
-}
 interface UseAlertsReturn {
     alerts: Alert[];
-    addAlert: (price: number, condition: AlertCondition, message?: string) => string;
+    addAlert: (price: number, condition: AlertCondition, message?: string, extendData?: AlertLineExtendData) => string;
     removeAlert: (id: string) => void;
     clearAlerts: () => void;
     onAlertTriggered: (callback: (alert: Alert) => void) => void;
 }
+/**
+ * Headless hook for price-crossing alerts.
+ *
+ * The alert list lives in the shared provider store, and the 1s crossing
+ * poller + the `onAlertTriggered` listener are owned by the provider. This
+ * means several `useAlerts()` instances (toolbar, list panel, sound trigger)
+ * observe and mutate one synchronized list and share a single poller — they no
+ * longer drift apart or each spawn their own interval.
+ */
 declare function useAlerts(): UseAlertsReturn;
 
 type ExportFormat = "csv" | "json";
@@ -602,7 +798,6 @@ interface UseWatchlistReturn {
 }
 declare function useWatchlist(): UseWatchlistReturn;
 
-type ReplaySpeed = 1 | 2 | 5 | 10;
 interface UseReplayReturn {
     /** Whether a replay session is active */
     isReplaying: boolean;
@@ -633,8 +828,13 @@ interface UseReplayReturn {
  * Headless hook for historical data replay (bar-by-bar playback).
  *
  * Loads the current chart data, clears the chart, then progressively adds
- * bars back one at a time at the configured speed. Useful for backtesting
- * and reviewing price action.
+ * bars back one at a time at the configured speed.
+ *
+ * Replay control state lives in the shared provider store and the playback
+ * interval + data buffers are owned by the provider (accessed through stable
+ * refs). This guarantees a single playback session even when `useReplay()` is
+ * mounted in several components (e.g. toolbar + bottom controls + status bar):
+ * starting in one and stepping in another drives the same timer and buffer.
  */
 declare function useReplay(): UseReplayReturn;
 
@@ -666,23 +866,6 @@ interface UseCompareReturn {
  */
 declare function useCompare(): UseCompareReturn;
 
-interface MeasurePoint {
-    price: number;
-    timestamp: number;
-    barIndex: number;
-}
-interface MeasureResult {
-    from: MeasurePoint;
-    to: MeasurePoint;
-    /** Absolute price difference */
-    priceDiff: number;
-    /** Percentage change from → to */
-    pricePercent: number;
-    /** Number of bars between the two points */
-    bars: number;
-    /** Time difference in milliseconds */
-    timeDiff: number;
-}
 interface UseMeasureReturn {
     /** Whether measure mode is active (waiting for clicks) */
     isActive: boolean;
@@ -701,7 +884,10 @@ interface UseMeasureReturn {
  * Headless hook for measuring distance/time/percentage between two points.
  *
  * Activates measure mode, captures two clicks on the chart via overlay
- * interaction, then computes price diff, %, bar count, and time diff.
+ * interaction, then computes price diff, %, bar count, and time diff. The
+ * measure state (active/from/result) lives in the shared provider store, so a
+ * toolbar toggle and a separate result-readout panel stay in sync no matter
+ * where each is mounted.
  */
 declare function useMeasure(): UseMeasureReturn;
 
@@ -900,4 +1086,4 @@ declare const superTrend: IndicatorTemplate;
 
 declare const vwap: IndicatorTemplate;
 
-export { type AddIndicatorOptions, type Alert, type AlertCondition, type Annotation, CANDLE_TYPES, COMPARE_RULES, type CandleTypeItem, type CandleTypeOption, type ChartLayoutState, type CompareRule, type CompareSymbol, type CrosshairBarData, DEFAULT_PERIODS, DRAWING_CATEGORIES, type Datafeed, type DrawingCategoryItem, type DrawingTool, type DrawingToolCategory, type DrawingToolItem, type ExportFormat, INDICATOR_PARAMS, type IndicatorDefinition, type IndicatorInfo, type IndicatorParamConfig, type KlinechartsUIAction, type KlinechartsUIContextValue, KlinechartsUIDispatchContext, type KlinechartsUIDispatchValue, type KlinechartsUIOptions, KlinechartsUIProvider, type KlinechartsUISettingsState, type KlinechartsUIState, KlinechartsUIStateContext, type LayoutEntry, MAIN_INDICATORS, type MagnetMode, type MeasurePoint, type MeasureResult, OrderLineExtendData, type OrderLineOptions, PRICE_AXIS_TYPES, type PartialSymbolInfo, type PriceAxisType, type ReplaySpeed, SUB_INDICATORS, type ScriptPlacement, TA, TIMEZONES, TOOLTIP_SHOW_RULES, type TerminalPeriod, type TimezoneItem, type TimezoneOption, type TooltipShowRule, type UndoRedoAction, type UndoRedoActionType, type UseAlertsReturn, type UseAnnotationsReturn, type UseCompareReturn, type UseCrosshairReturn, type UseDataExportReturn, type UseDrawingToolsReturn, type UseFullscreenReturn, type UseIndicatorsReturn, type UseKlinechartsUILoadingReturn, type UseKlinechartsUISettingsReturn, type UseKlinechartsUIThemeReturn, type UseLayoutManagerReturn, type UseMeasureReturn, type UseOrderLinesReturn, type UsePeriodsReturn, type UseReplayReturn, type UseScreenshotReturn, type UseScriptEditorReturn, type UseSymbolSearchReturn, type UseTimezoneReturn, type UseUndoRedoReturn, type UseWatchlistReturn, type WatchlistItem, YAXIS_POSITIONS, type YAxisPosition, abcd, anyWaves, arrow, bollTv, brush, cci, circle, createDataLoader, eightWaves, elliottWave, fibRetracement, fibonacciCircle, fibonacciExtension, fibonacciSegment, fibonacciSpeedResistanceFan, fibonacciSpiral, fiveWaves, gannBox, gannFan, hma, ichimoku, longPosition, maRibbon, macdTv, measure, parallelChannel, parallelogram, pivotPoints, ray, rect, rsiTv, shortPosition, stochastic, superTrend, threeWaves, triangle, useAlerts, useAnnotations, useCompare, useCrosshair, useDataExport, useDrawingTools, useFullscreen, useIndicators, useKlinechartsUI, useKlinechartsUILoading, useKlinechartsUISettings, useKlinechartsUITheme, useLayoutManager, useMeasure, useOrderLines, usePeriods, useReplay, useScreenshot, useScriptEditor, useSymbolSearch, useTimezone, useUndoRedo, useWatchlist, vwap, xabcd };
+export { type AddIndicatorOptions, type Alert, type AlertCondition, AlertLineExtendData, type Annotation, CANDLE_TYPES, COMPARE_RULES, type CandleTypeItem, type CandleTypeOption, type ChartLayoutState, type CompareRule, type CompareSymbol, type CrosshairBarData, DEFAULT_PERIODS, DRAWING_CATEGORIES, type Datafeed, type DrawingCategoryItem, type DrawingTool, type DrawingToolCategory, type DrawingToolItem, type ExportFormat, INDICATOR_PARAMS, type IndicatorDefinition, type IndicatorInfo, type IndicatorParamConfig, type KlinechartsUIAction, type KlinechartsUIContextValue, KlinechartsUIDispatchContext, type KlinechartsUIDispatchValue, type KlinechartsUIOptions, KlinechartsUIProvider, type KlinechartsUISettingsState, type KlinechartsUIState, KlinechartsUIStateContext, type LayoutEntry, MAIN_INDICATORS, type MagnetMode, type MeasurePoint, type MeasureResult, OrderLineExtendData, type OrderLineOptions, PRICE_AXIS_TYPES, type PartialSymbolInfo, type PriceAxisType, type ReplaySpeed, SUB_INDICATORS, type ScriptPlacement, TA, TIMEZONES, TOOLTIP_SHOW_RULES, type TerminalPeriod, type TimezoneItem, type TimezoneOption, type TooltipShowRule, type UndoRedoAction, type UndoRedoActionType, type UseAlertsReturn, type UseAnnotationsReturn, type UseChartAxesReturn, type UseCompareReturn, type UseCrosshairReturn, type UseDataExportReturn, type UseDrawingToolsReturn, type UseFullscreenReturn, type UseHotkeysReturn, type UseIndicatorsReturn, type UseKlinechartsUILoadingReturn, type UseKlinechartsUISettingsReturn, type UseKlinechartsUIThemeReturn, type UseLayoutManagerReturn, type UseMeasureReturn, type UseOrderLinesReturn, type UsePeriodsReturn, type UseReplayReturn, type UseScreenshotReturn, type UseScriptEditorReturn, type UseSymbolSearchReturn, type UseTimezoneReturn, type UseUndoRedoReturn, type UseWatchlistReturn, type WatchlistItem, YAXIS_POSITIONS, type YAxisPosition, abcd, anyWaves, arrow, bollTv, brush, cci, circle, createDataLoader, eightWaves, elliottWave, fibRetracement, fibonacciCircle, fibonacciExtension, fibonacciSegment, fibonacciSpeedResistanceFan, fibonacciSpiral, fiveWaves, gannBox, gannFan, hma, ichimoku, longPosition, maRibbon, macdTv, measure, parallelChannel, parallelogram, pivotPoints, ray, rect, rsiTv, shortPosition, stochastic, superTrend, threeWaves, triangle, useAlerts, useAnnotations, useChartAxes, useCompare, useCrosshair, useDataExport, useDrawingTools, useFullscreen, useHotkeys, useIndicators, useKlinechartsUI, useKlinechartsUILoading, useKlinechartsUISettings, useKlinechartsUITheme, useLayoutManager, useMeasure, useOrderLines, usePeriods, useReplay, useScreenshot, useScriptEditor, useSymbolSearch, useTimezone, useUndoRedo, useWatchlist, vwap, xabcd };