lightweight-charts-react-components 1.1.0 → 1.1.1

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 
 /**!
-* lightweight-charts-react-components v1.1.0
+* lightweight-charts-react-components v1.1.1
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE.md file in the root directory of this source tree.
@@ -146,6 +146,9 @@ export declare const CandlestickSeries: ForwardRefExoticComponent<SeriesProps<"C
  */
 export declare const Chart: ForwardRefExoticComponent<ChartProps & RefAttributes<HTMLDivElement>>;
 
+/**
+ * Chart API reference type that can be used to access the chart plugin API.
+ */
 export declare type ChartApiRef = {
     _chart: IChartApi | null;
     api: () => IChartApi | null;
@@ -153,6 +156,9 @@ export declare type ChartApiRef = {
     clear: () => void;
 };
 
+/**
+ * Chart component props.
+ */
 export declare type ChartProps = {
     children?: ReactNode;
     containerProps?: JSX.IntrinsicElements["div"];
@@ -185,6 +191,9 @@ export declare type ChartProps = {
  */
 export declare const CustomSeries: ForwardRefExoticComponent<SeriesProps<"Custom"> & RefAttributes<SeriesApiRef<"Custom">>>;
 
+/**
+ * Unique properties for the custom series component.
+ */
 declare type CustomSeriesUniqueProps = {
     plugin?: ICustomSeriesPaneView;
 };
@@ -216,10 +225,16 @@ declare type GenericSeriesPrimitiveComponent = (<T extends SeriesType>(props: Se
  */
 export declare const HistogramSeries: ForwardRefExoticComponent<SeriesProps<"Histogram"> & RefAttributes<SeriesApiRef<"Histogram">>>;
 
+/**
+ * Unique properties for the image watermark component.
+ */
 export declare type ImageWatermarkProps = {
     src: string;
 } & DeepPartial<ImageWatermarkOptions>;
 
+/**
+ * Pane context that provides access to the pane API and readiness state.
+ */
 export declare interface IPaneContext {
     paneApiRef?: PaneApiRef;
     isReady: boolean;
@@ -266,6 +281,9 @@ export declare const LineSeries: ForwardRefExoticComponent<SeriesProps<"Line"> &
  */
 export declare const Markers: ForwardRefExoticComponent<MarkersProps & RefAttributes<MarkersApiRef>>;
 
+/**
+ * Markers API reference type that can be used to access the series markers plugin API.
+ */
 export declare type MarkersApiRef = {
     _markers: ISeriesMarkersPluginApi<Time> | null;
     api: () => ISeriesMarkersPluginApi<Time> | null;
@@ -273,6 +291,9 @@ export declare type MarkersApiRef = {
     clear: () => void;
 };
 
+/**
+ * Markers component properties that can be used to create a series markers component.
+ */
 export declare type MarkersProps = {
     markers: SeriesMarker<Time>[];
     reactive?: boolean;
@@ -295,6 +316,9 @@ export declare type MarkersProps = {
  */
 export declare const Pane: ForwardRefExoticComponent<PaneProps & RefAttributes<PaneApiRef>>;
 
+/**
+ * Pane API reference type that can be used to access the pane plugin API.
+ */
 export declare type PaneApiRef = {
     _pane: IPaneApi<Time> | null;
     api: () => IPaneApi<Time> | null;
@@ -302,6 +326,9 @@ export declare type PaneApiRef = {
     clear: () => void;
 };
 
+/**
+ * Pane component props.
+ */
 export declare type PaneProps = {
     children?: ReactNode;
     stretchFactor?: number;
@@ -322,6 +349,9 @@ export declare type PaneProps = {
  */
 export declare const PriceLine: ForwardRefExoticComponent<PriceLineProps & RefAttributes<PriceLineApiRef>>;
 
+/**
+ * PriceLine API reference type that can be used to access the price line plugin API.
+ */
 export declare type PriceLineApiRef = {
     _priceLine: IPriceLine | null;
     api: () => IPriceLine | null;
@@ -329,6 +359,9 @@ export declare type PriceLineApiRef = {
     clear: () => void;
 };
 
+/**
+ * PriceLine component props.
+ */
 export declare type PriceLineProps = {
     price: number;
     options?: Omit<Partial<PriceLineOptions>, "price">;
@@ -349,6 +382,9 @@ export declare type PriceLineProps = {
  */
 export declare const PriceScale: ForwardRefExoticComponent<PriceScaleProps & RefAttributes<PriceScaleApiRef>>;
 
+/**
+ * Price scale API reference type that can be used to access the price scale plugin API.
+ */
 export declare type PriceScaleApiRef = {
     _priceScale: IPriceScaleApi | null;
     api: () => IPriceScaleApi | null;
@@ -359,16 +395,25 @@ export declare type PriceScaleApiRef = {
 
 declare type PriceScaleOptions = DeepPartial<PriceScaleOptions_2>;
 
+/**
+ * PriceScale component props.
+ */
 export declare type PriceScaleProps = {
     options?: PriceScaleOptions;
     id: string;
 };
 
+/**
+ * Render function type for series primitives.
+ */
 export declare type RenderPrimitive<T extends SeriesType = SeriesType> = ({ chart, series, }: {
     chart: IChartApi;
     series: ISeriesApi<T>;
 }) => ISeriesPrimitive;
 
+/**
+ * Series API reference type that can be used to access the series plugin API.
+ */
 export declare type SeriesApiRef<T extends SeriesType> = {
     _series: ISeriesApi<T> | null;
     api: () => ISeriesApi<T> | null;
@@ -376,6 +421,9 @@ export declare type SeriesApiRef<T extends SeriesType> = {
     clear: () => void;
 };
 
+/**
+ * Series options that can be used to customize the appearance and behavior of a series.
+ */
 export declare type SeriesOptions<T extends SeriesType> = SeriesPartialOptionsMap[T];
 
 declare type SeriesParameters<T extends SeriesType> = {
@@ -400,6 +448,9 @@ declare type SeriesParameters<T extends SeriesType> = {
  */
 export declare const SeriesPrimitive: GenericSeriesPrimitiveComponent;
 
+/**
+ * Series primitive API reference type that can be used to access the series primitive plugin API.
+ */
 export declare type SeriesPrimitiveApiRef = {
     _primitive: ISeriesPrimitive | null;
     api(): ISeriesPrimitive | null;
@@ -407,6 +458,9 @@ export declare type SeriesPrimitiveApiRef = {
     clear(): void;
 };
 
+/**
+ * Series primitive properties that can be used to create a series primitive.
+ */
 export declare type SeriesPrimitiveProps<T extends SeriesType = SeriesType> = SeriesPrimitivePropsWithRender<T> | SeriesPrimitivePropsWithPlugin;
 
 declare type SeriesPrimitivePropsWithPlugin = {
@@ -421,13 +475,22 @@ declare type SeriesPrimitivePropsWithRender<T extends SeriesType> = {
 
 declare const SeriesPrimitiveRenderFunction: <T extends SeriesType>(props: SeriesPrimitiveProps<T>, ref: ForwardedRef<SeriesPrimitiveApiRef>) => JSX.Element | null;
 
+/**
+ * Series component properties that can be used to create a series of a specific type.
+ */
 export declare type SeriesProps<T extends SeriesType> = Omit<SeriesTemplateProps<T>, "type">;
 
+/**
+ * Properties of a series template component that can be used to create a series of a specific type.
+ */
 declare type SeriesTemplateProps<T extends SeriesType> = {
     type: T;
     children?: ReactNode;
 } & SeriesParameters<T>;
 
+/**
+ * Unique properties for the text watermark component.
+ */
 export declare type TextWatermarkProps = DeepPartial<TextWatermarkOptions>;
 
 /**
@@ -445,6 +508,9 @@ export declare type TextWatermarkProps = DeepPartial<TextWatermarkOptions>;
  */
 export declare const TimeScale: ForwardRefExoticComponent<TimeScaleProps & RefAttributes<TimeScaleApiRef>>;
 
+/**
+ * Time scale API reference type that can be used to access the time scale plugin API.
+ */
 export declare type TimeScaleApiRef = {
     _timeScale: ITimeScaleApi<Time> | null;
     api: () => ITimeScaleApi<Time> | null;
@@ -465,12 +531,18 @@ export declare type TimeScaleApiRef = {
  */
 export declare const TimeScaleFitContentTrigger: ({ deps, }: TimeScaleFitContentTriggerProps) => JSX.Element | null;
 
+/**
+ * TimeScaleFitContentTriggerProps component props.
+ */
 export declare type TimeScaleFitContentTriggerProps = {
     deps: DependencyList;
 };
 
 declare type TimeScaleOptions = DeepPartial<TimeScaleOptions_2>;
 
+/**
+ * TimeScale component props.
+ */
 export declare type TimeScaleProps = {
     onVisibleTimeRangeChange?: TimeRangeChangeEventHandler<Time>;
     onVisibleLogicalRangeChange?: LogicalRangeChangeEventHandler;
@@ -481,6 +553,9 @@ export declare type TimeScaleProps = {
     children?: ReactNode;
 };
 
+/**
+ * Watermark API reference type that can be used to access the watermark plugin API.
+ */
 export declare type WatermarkApiRef<T extends WatermarkType> = T extends "text" ? WatermarkTextApiRefBase : WatermarkImageApiRefBase;
 
 /**
@@ -537,6 +612,11 @@ declare type WatermarkTextApiRefBase = {
     clear: () => void;
 };
 
+/**
+ * Watermark types supported by the library.
+ * - `text`: A text watermark.
+ * - `image`: An image watermark.
+ */
 export declare type WatermarkType = "text" | "image";
 
 export { }

package/dist/lightweight-charts-react-components.mjs

@@ -1,6 +1,6 @@
 
 /**!
-* lightweight-charts-react-components v1.1.0
+* lightweight-charts-react-components v1.1.1
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE.md file in the root directory of this source tree.
@@ -8,7 +8,7 @@
 * @license MIT
 */
 
-import*as e from"react";import*as t from"lightweight-charts";let i=(0,e.createContext)(null);i.displayName="ChartContext";let r={addDefaultPane:!1},a=({container:i,onClick:a,onCrosshairMove:l,onInit:n,options:s={},onDblClick:u})=>{let[c,f]=(0,e.useState)(!1),o=(0,e.useRef)({_chart:null,api(){return this._chart},init(){if(null===this._chart){let e=(0,t.createChart)(i,{...r,...s});this._chart=e,n&&n(this._chart)}return c||f(!0),this._chart},clear(){null!==this._chart&&(f(!1),this._chart.remove(),this._chart=null)}});return(0,e.useLayoutEffect)(()=>(o.current.init(),()=>{o.current.clear()}),[]),(0,e.useLayoutEffect)(()=>{if(i){if(a){var e;null===(e=o.current.api())||void 0===e||e.subscribeClick(a)}return()=>{if(a){var e;null===(e=o.current.api())||void 0===e||e.unsubscribeClick(a)}}}},[a]),(0,e.useLayoutEffect)(()=>{if(i){if(l){var e;null===(e=o.current.api())||void 0===e||e.subscribeCrosshairMove(l)}return()=>{if(l){var e;null===(e=o.current.api())||void 0===e||e.unsubscribeCrosshairMove(l)}}}},[l]),(0,e.useLayoutEffect)(()=>{if(i){if(u){var e;null===(e=o.current.api())||void 0===e||e.subscribeDblClick(u)}return()=>{if(u){var e;null===(e=o.current.api())||void 0===e||e.unsubscribeDblClick(u)}}}},[u]),(0,e.useLayoutEffect)(()=>{var e;i&&(null===(e=o.current.api())||void 0===e||e.applyOptions({...r,...s}))},[s]),{chartApiRef:o,isReady:c}},l=({children:t,container:r,onClick:l,onCrosshairMove:n,onInit:s,options:u})=>{let{chartApiRef:{current:c},isReady:f}=a({container:r,onClick:l,onCrosshairMove:n,onInit:s,options:u});return e.default.createElement(i.Provider,{value:{chartApiRef:c,isReady:f}},t)},n=(0,e.forwardRef)(({children:t,containerProps:i,...r},a)=>{let[n,s]=(0,e.useState)(),u=(0,e.useCallback)(e=>{s(e),a&&("function"==typeof a?u(e):a.current=e)},[a]);return e.default.createElement("div",{ref:u,...i},!!n&&e.default.createElement(l,{container:n,...r},t))});n.displayName="ChartWrapper";let s=(0,e.createContext)(null);s.displayName="TimeScaleContext";let u="1.1.0";function c(e,t,i){return t in e?Object.defineProperty(e,t,{value:i,enumerable:!0,configurable:!0,writable:!0}):e[t]=i,e}class f extends Error{constructor(e,{isOperational:t=!0,cause:i,docsPath:r}={}){super(e),c(this,"isOperational",void 0),c(this,"cause",void 0),this.name=this.constructor.name??"InternalError",this.isOperational=t,this.cause=i,this.message=`${e??"An error occurred"}`,r&&(this.message=`${this.message}
+import*as e from"react";import*as t from"lightweight-charts";let i=(0,e.createContext)(null);i.displayName="ChartContext";let r={addDefaultPane:!1},a=({container:i,onClick:a,onCrosshairMove:l,onInit:n,options:s={},onDblClick:u})=>{let[c,f]=(0,e.useState)(!1),o=(0,e.useRef)({_chart:null,api(){return this._chart},init(){if(null===this._chart){let e=(0,t.createChart)(i,{...r,...s});this._chart=e,n&&n(this._chart)}return c||f(!0),this._chart},clear(){null!==this._chart&&(f(!1),this._chart.remove(),this._chart=null)}});return(0,e.useLayoutEffect)(()=>(o.current.init(),()=>{o.current.clear()}),[]),(0,e.useLayoutEffect)(()=>{if(i){if(a){var e;null===(e=o.current.api())||void 0===e||e.subscribeClick(a)}return()=>{if(a){var e;null===(e=o.current.api())||void 0===e||e.unsubscribeClick(a)}}}},[a]),(0,e.useLayoutEffect)(()=>{if(i){if(l){var e;null===(e=o.current.api())||void 0===e||e.subscribeCrosshairMove(l)}return()=>{if(l){var e;null===(e=o.current.api())||void 0===e||e.unsubscribeCrosshairMove(l)}}}},[l]),(0,e.useLayoutEffect)(()=>{if(i){if(u){var e;null===(e=o.current.api())||void 0===e||e.subscribeDblClick(u)}return()=>{if(u){var e;null===(e=o.current.api())||void 0===e||e.unsubscribeDblClick(u)}}}},[u]),(0,e.useLayoutEffect)(()=>{var e;i&&(null===(e=o.current.api())||void 0===e||e.applyOptions({...r,...s}))},[s]),{chartApiRef:o,isReady:c}},l=({children:t,container:r,onClick:l,onCrosshairMove:n,onInit:s,options:u})=>{let{chartApiRef:{current:c},isReady:f}=a({container:r,onClick:l,onCrosshairMove:n,onInit:s,options:u});return e.default.createElement(i.Provider,{value:{chartApiRef:c,isReady:f}},t)},n=(0,e.forwardRef)(({children:t,containerProps:i,...r},a)=>{let[n,s]=(0,e.useState)(),u=(0,e.useCallback)(e=>{s(e),a&&("function"==typeof a?u(e):a.current=e)},[a]);return e.default.createElement("div",{ref:u,...i},!!n&&e.default.createElement(l,{container:n,...r},t))});n.displayName="ChartWrapper";let s=(0,e.createContext)(null);s.displayName="TimeScaleContext";let u="1.1.1";function c(e,t,i){return t in e?Object.defineProperty(e,t,{value:i,enumerable:!0,configurable:!0,writable:!0}):e[t]=i,e}class f extends Error{constructor(e,{isOperational:t=!0,cause:i,docsPath:r}={}){super(e),c(this,"isOperational",void 0),c(this,"cause",void 0),this.name=this.constructor.name??"InternalError",this.isOperational=t,this.cause=i,this.message=`${e??"An error occurred"}`,r&&(this.message=`${this.message}
 
 Docs: see ${"https://ukorvl.github.io/lightweight-charts-react-components/docs/"+r}`),u&&(this.message=`${this.message}