react-klinecharts-ui 0.5.0 → 1.0.0

package/dist/extensions.d.ts

@@ -1,5 +1,5 @@
-import * as react_klinecharts from 'react-klinecharts';
-import { OverlayTemplate } from 'react-klinecharts';
+import * as klinecharts from 'klinecharts';
+import { OverlayTemplate } from 'klinecharts';
 
 interface OrderLineFontStyle {
     size?: number;
@@ -37,8 +37,11 @@ interface OrderLineLabelStyle {
     offset?: OrderLinePadding;
 }
 interface OrderLineLineStyle {
-    /** Line dash style. Default: "dashed" */
-    style?: "solid" | "dashed" | "dotted";
+    /**
+     * Line dash style. Default: "dashed". Note klinecharts only supports
+     * "solid" and "dashed"; a dotted effect is achieved via `dashedValue`.
+     */
+    style?: "solid" | "dashed";
     /** Line thickness. Default: 1 */
     width?: number;
     /** Dash pattern [dash, gap]. Default: [4, 2] (matches chart built-in lines) */
@@ -58,6 +61,22 @@ interface OrderLineExtendData {
 }
 declare const orderLine: OverlayTemplate;
 
+interface AlertLineExtendData {
+    /** Primary color for the line, the y-axis mark bg, and label fallback. Default: "#ff9800" */
+    color?: string;
+    /** Text label displayed above the line. Defaults to the formatted price. */
+    text?: string;
+    /** Line style overrides. Default: dashed. */
+    line?: OrderLineLineStyle;
+    /** Y-axis price mark style overrides. */
+    mark?: OrderLineMarkStyle;
+    /** Text label style overrides. */
+    label?: OrderLineLabelStyle;
+    /** Whether to show a bell marker before the label text. Default: true */
+    showBell?: boolean;
+}
+declare const alertLine: OverlayTemplate;
+
 interface DepthOverlayRow {
     price: number;
     qty: number;
@@ -76,15 +95,32 @@ interface DepthOverlayExtendData {
 declare const depthOverlay: OverlayTemplate;
 
 /**
- * Built-in drawing-tool overlays registered by default.
- * Does NOT include optional overlays like `orderLine` — those are
- * registered explicitly by the consumer via the `overlays` provider prop.
+ * Drawing-tool overlays registered by default.
+ */
+declare const overlays: klinecharts.OverlayTemplate[];
+/**
+ * Optional feature overlays that are also registered automatically, so
+ * consumers don't have to pass them through the `overlays` provider prop:
+ *
+ * - `orderLine`  — drawn by `useOrderLines`.
+ * - `alertLine`  — drawn by `useAlerts`.
+ * - `depthOverlay` — order-book depth visualization.
+ *
+ * `useAlerts` additionally registers `alertLine` lazily (see
+ * `ensureAlertLineRegistered`) so it works even when automatic registration
+ * is disabled on the provider.
  */
-declare const overlays: react_klinecharts.OverlayTemplate[];
+declare const featureOverlays: klinecharts.OverlayTemplate[];
 /**
  * Custom indicator templates (TradingView-style) registered by default.
  */
-declare const indicators: react_klinecharts.IndicatorTemplate[];
+declare const indicators: klinecharts.IndicatorTemplate[];
 declare function registerExtensions(): void;
+/**
+ * Idempotently registers the `alertLine` overlay. Called by `useAlerts` before
+ * creating its first overlay so the template is always available regardless of
+ * whether the provider ran `registerExtensions()`.
+ */
+declare function ensureAlertLineRegistered(): void;
 
-export { type DepthOverlayExtendData, type DepthOverlayRow, type OrderLineExtendData, type OrderLineFontStyle, type OrderLineLabelStyle, type OrderLineLineStyle, type OrderLineMarkStyle, type OrderLinePadding, depthOverlay, indicators, orderLine, overlays, registerExtensions };
+export { type AlertLineExtendData, type DepthOverlayExtendData, type DepthOverlayRow, type OrderLineExtendData, type OrderLineFontStyle, type OrderLineLabelStyle, type OrderLineLineStyle, type OrderLineMarkStyle, type OrderLinePadding, alertLine, depthOverlay, ensureAlertLineRegistered, featureOverlays, indicators, orderLine, overlays, registerExtensions };

package/dist/extensions.js

@@ -1,3 +1,3 @@
-export { depthOverlay_default as depthOverlay, indicators, orderLine_default as orderLine, overlays, registerExtensions } from './chunk-DTBNTO4M.js';
+export { alertLine_default as alertLine, depthOverlay_default as depthOverlay, ensureAlertLineRegistered, featureOverlays, indicators, orderLine_default as orderLine, overlays, registerExtensions } from './chunk-JD4NBJ5F.js';
 //# sourceMappingURL=extensions.js.map
 //# sourceMappingURL=extensions.js.map