devextreme-react 23.2.6 → 24.1.2-beta

package/cjs/sankey.d.ts

@@ -1,7 +1,7 @@
 /*!
  * devextreme-react
- * Version: 23.2.6
- * Build date: Wed May 01 2024
+ * Version: 24.1.2-beta
+ * Build date: Mon May 13 2024
  *
  * Copyright (c) 2012 - 2024 Developer Express Inc. ALL RIGHTS RESERVED
  *
@@ -11,18 +11,18 @@
  * https://github.com/DevExpress/devextreme-react
  */
 
-/// <reference types="react" />
+import * as React from "react";
+import { Ref, ReactElement } from "react";
 import dxSankey, { Properties } from "devextreme/viz/sankey";
-import { Component as BaseComponent, IHtmlOptions } from "./core/component";
-import NestedOption from "./core/nested-option";
+import { IHtmlOptions, IElementDescriptor } from "./core/component";
 import type { DisposingEvent, DrawnEvent, ExportedEvent, ExportingEvent, FileSavingEvent, IncidentOccurredEvent, InitializedEvent, LinkClickEvent, NodeClickEvent, dxSankeyNode } from "devextreme/viz/sankey";
 import type { Font as ChartsFont } from "devextreme/common/charts";
 import type { template } from "devextreme/core/templates/template";
 import type * as LocalizationTypes from "devextreme/localization";
-declare type ReplaceFieldTypes<TSource, TReplacement> = {
+type ReplaceFieldTypes<TSource, TReplacement> = {
     [P in keyof TSource]: P extends keyof TReplacement ? TReplacement[P] : TSource[P];
 };
-declare type ISankeyOptionsNarrowedEvents = {
+type ISankeyOptionsNarrowedEvents = {
     onDisposing?: ((e: DisposingEvent) => void);
     onDrawn?: ((e: DrawnEvent) => void);
     onExported?: ((e: ExportedEvent) => void);
@@ -33,80 +33,33 @@ declare type ISankeyOptionsNarrowedEvents = {
     onLinkClick?: ((e: LinkClickEvent) => void);
     onNodeClick?: ((e: NodeClickEvent) => void);
 };
-declare type ISankeyOptions = React.PropsWithChildren<ReplaceFieldTypes<Properties, ISankeyOptionsNarrowedEvents> & IHtmlOptions & {
+type ISankeyOptions = React.PropsWithChildren<ReplaceFieldTypes<Properties, ISankeyOptionsNarrowedEvents> & IHtmlOptions & {
     defaultLoadingIndicator?: Record<string, any>;
     onLoadingIndicatorChange?: (value: Record<string, any>) => void;
 }>;
-declare class Sankey extends BaseComponent<React.PropsWithChildren<ISankeyOptions>> {
-    get instance(): dxSankey;
-    protected _WidgetClass: typeof dxSankey;
-    protected subscribableOptions: string[];
-    protected independentEvents: string[];
-    protected _defaults: {
-        defaultLoadingIndicator: string;
-    };
-    protected _expectedChildren: {
-        adaptiveLayout: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        export: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        label: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        link: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        loadingIndicator: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        margin: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        node: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        size: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        title: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        tooltip: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
+interface SankeyRef {
+    instance: () => dxSankey;
 }
-declare type IAdaptiveLayoutProps = React.PropsWithChildren<{
+declare const Sankey: (props: React.PropsWithChildren<ISankeyOptions> & {
+    ref?: Ref<SankeyRef>;
+}) => ReactElement | null;
+type IAdaptiveLayoutProps = React.PropsWithChildren<{
     height?: number;
     keepLabels?: boolean;
     width?: number;
 }>;
-declare class AdaptiveLayout extends NestedOption<IAdaptiveLayoutProps> {
-    static OptionName: string;
-}
-declare type IBorderProps = React.PropsWithChildren<{
+declare const _componentAdaptiveLayout: React.MemoExoticComponent<(props: IAdaptiveLayoutProps) => React.FunctionComponentElement<IAdaptiveLayoutProps>>;
+declare const AdaptiveLayout: typeof _componentAdaptiveLayout & IElementDescriptor;
+type IBorderProps = React.PropsWithChildren<{
     color?: string;
     visible?: boolean;
     width?: number;
     dashStyle?: "dash" | "dot" | "longDash" | "solid";
     opacity?: number;
 }>;
-declare class Border extends NestedOption<IBorderProps> {
-    static OptionName: string;
-}
-declare type IExportProps = React.PropsWithChildren<{
+declare const _componentBorder: React.MemoExoticComponent<(props: IBorderProps) => React.FunctionComponentElement<IBorderProps>>;
+declare const Border: typeof _componentBorder & IElementDescriptor;
+type IExportProps = React.PropsWithChildren<{
     backgroundColor?: string;
     enabled?: boolean;
     fileName?: string;
@@ -115,20 +68,18 @@ declare type IExportProps = React.PropsWithChildren<{
     printingEnabled?: boolean;
     svgToCanvas?: ((svg: any, canvas: any) => any);
 }>;
-declare class Export extends NestedOption<IExportProps> {
-    static OptionName: string;
-}
-declare type IFontProps = React.PropsWithChildren<{
+declare const _componentExport: React.MemoExoticComponent<(props: IExportProps) => React.FunctionComponentElement<IExportProps>>;
+declare const Export: typeof _componentExport & IElementDescriptor;
+type IFontProps = React.PropsWithChildren<{
     color?: string;
     family?: string;
     opacity?: number;
     size?: number | string;
     weight?: number;
 }>;
-declare class Font extends NestedOption<IFontProps> {
-    static OptionName: string;
-}
-declare type IFormatProps = React.PropsWithChildren<{
+declare const _componentFont: React.MemoExoticComponent<(props: IFontProps) => React.FunctionComponentElement<IFontProps>>;
+declare const Font: typeof _componentFont & IElementDescriptor;
+type IFormatProps = React.PropsWithChildren<{
     currency?: string;
     formatter?: ((value: number | Date) => string);
     parser?: ((value: string) => number | Date);
@@ -136,19 +87,17 @@ declare type IFormatProps = React.PropsWithChildren<{
     type?: "billions" | "currency" | "day" | "decimal" | "exponential" | "fixedPoint" | "largeNumber" | "longDate" | "longTime" | "millions" | "millisecond" | "month" | "monthAndDay" | "monthAndYear" | "percent" | "quarter" | "quarterAndYear" | "shortDate" | "shortTime" | "thousands" | "trillions" | "year" | "dayOfWeek" | "hour" | "longDateLongTime" | "minute" | "second" | "shortDateShortTime";
     useCurrencyAccountingStyle?: boolean;
 }>;
-declare class Format extends NestedOption<IFormatProps> {
-    static OptionName: string;
-}
-declare type IHatchingProps = React.PropsWithChildren<{
+declare const _componentFormat: React.MemoExoticComponent<(props: IFormatProps) => React.FunctionComponentElement<IFormatProps>>;
+declare const Format: typeof _componentFormat & IElementDescriptor;
+type IHatchingProps = React.PropsWithChildren<{
     direction?: "left" | "none" | "right";
     opacity?: number;
     step?: number;
     width?: number;
 }>;
-declare class Hatching extends NestedOption<IHatchingProps> {
-    static OptionName: string;
-}
-declare type IHoverStyleProps = React.PropsWithChildren<{
+declare const _componentHatching: React.MemoExoticComponent<(props: IHatchingProps) => React.FunctionComponentElement<IHatchingProps>>;
+declare const Hatching: typeof _componentHatching & IElementDescriptor;
+type IHoverStyleProps = React.PropsWithChildren<{
     border?: Record<string, any> | {
         color?: string;
         visible?: boolean;
@@ -163,10 +112,9 @@ declare type IHoverStyleProps = React.PropsWithChildren<{
     };
     opacity?: number;
 }>;
-declare class HoverStyle extends NestedOption<IHoverStyleProps> {
-    static OptionName: string;
-}
-declare type ILabelProps = React.PropsWithChildren<{
+declare const _componentHoverStyle: React.MemoExoticComponent<(props: IHoverStyleProps) => React.FunctionComponentElement<IHoverStyleProps>>;
+declare const HoverStyle: typeof _componentHoverStyle & IElementDescriptor;
+type ILabelProps = React.PropsWithChildren<{
     border?: Record<string, any> | {
         color?: string;
         visible?: boolean;
@@ -187,28 +135,9 @@ declare type ILabelProps = React.PropsWithChildren<{
     verticalOffset?: number;
     visible?: boolean;
 }>;
-declare class Label extends NestedOption<ILabelProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        border: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        font: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        sankeyborder: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        shadow: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type ILinkProps = React.PropsWithChildren<{
+declare const _componentLabel: React.MemoExoticComponent<(props: ILabelProps) => React.FunctionComponentElement<ILabelProps>>;
+declare const Label: typeof _componentLabel & IElementDescriptor;
+type ILinkProps = React.PropsWithChildren<{
     border?: Record<string, any> | {
         color?: string;
         visible?: boolean;
@@ -233,24 +162,9 @@ declare type ILinkProps = React.PropsWithChildren<{
     };
     opacity?: number;
 }>;
-declare class Link extends NestedOption<ILinkProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        border: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        hoverStyle: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        sankeyborder: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type ILoadingIndicatorProps = React.PropsWithChildren<{
+declare const _componentLink: React.MemoExoticComponent<(props: ILinkProps) => React.FunctionComponentElement<ILinkProps>>;
+declare const Link: typeof _componentLink & IElementDescriptor;
+type ILoadingIndicatorProps = React.PropsWithChildren<{
     backgroundColor?: string;
     enabled?: boolean;
     font?: ChartsFont;
@@ -259,28 +173,17 @@ declare type ILoadingIndicatorProps = React.PropsWithChildren<{
     defaultShow?: boolean;
     onShowChange?: (value: boolean) => void;
 }>;
-declare class LoadingIndicator extends NestedOption<ILoadingIndicatorProps> {
-    static OptionName: string;
-    static DefaultsProps: {
-        defaultShow: string;
-    };
-    static ExpectedChildren: {
-        font: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type IMarginProps = React.PropsWithChildren<{
+declare const _componentLoadingIndicator: React.MemoExoticComponent<(props: ILoadingIndicatorProps) => React.FunctionComponentElement<ILoadingIndicatorProps>>;
+declare const LoadingIndicator: typeof _componentLoadingIndicator & IElementDescriptor;
+type IMarginProps = React.PropsWithChildren<{
     bottom?: number;
     left?: number;
     right?: number;
     top?: number;
 }>;
-declare class Margin extends NestedOption<IMarginProps> {
-    static OptionName: string;
-}
-declare type INodeProps = React.PropsWithChildren<{
+declare const _componentMargin: React.MemoExoticComponent<(props: IMarginProps) => React.FunctionComponentElement<IMarginProps>>;
+declare const Margin: typeof _componentMargin & IElementDescriptor;
+type INodeProps = React.PropsWithChildren<{
     border?: Record<string, any> | {
         color?: string;
         visible?: boolean;
@@ -306,65 +209,40 @@ declare type INodeProps = React.PropsWithChildren<{
     padding?: number;
     width?: number;
 }>;
-declare class Node extends NestedOption<INodeProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        border: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        hoverStyle: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        sankeyborder: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type ISankeyborderProps = React.PropsWithChildren<{
+declare const _componentNode: React.MemoExoticComponent<(props: INodeProps) => React.FunctionComponentElement<INodeProps>>;
+declare const Node: typeof _componentNode & IElementDescriptor;
+type ISankeyborderProps = React.PropsWithChildren<{
     color?: string;
     visible?: boolean;
     width?: number;
 }>;
-declare class Sankeyborder extends NestedOption<ISankeyborderProps> {
-    static OptionName: string;
-}
-declare type IShadowProps = React.PropsWithChildren<{
+declare const _componentSankeyborder: React.MemoExoticComponent<(props: ISankeyborderProps) => React.FunctionComponentElement<ISankeyborderProps>>;
+declare const Sankeyborder: typeof _componentSankeyborder & IElementDescriptor;
+type IShadowProps = React.PropsWithChildren<{
     blur?: number;
     color?: string;
     offsetX?: number;
     offsetY?: number;
     opacity?: number;
 }>;
-declare class Shadow extends NestedOption<IShadowProps> {
-    static OptionName: string;
-}
-declare type ISizeProps = React.PropsWithChildren<{
+declare const _componentShadow: React.MemoExoticComponent<(props: IShadowProps) => React.FunctionComponentElement<IShadowProps>>;
+declare const Shadow: typeof _componentShadow & IElementDescriptor;
+type ISizeProps = React.PropsWithChildren<{
     height?: number;
     width?: number;
 }>;
-declare class Size extends NestedOption<ISizeProps> {
-    static OptionName: string;
-}
-declare type ISubtitleProps = React.PropsWithChildren<{
+declare const _componentSize: React.MemoExoticComponent<(props: ISizeProps) => React.FunctionComponentElement<ISizeProps>>;
+declare const Size: typeof _componentSize & IElementDescriptor;
+type ISubtitleProps = React.PropsWithChildren<{
     font?: ChartsFont;
     offset?: number;
     text?: string;
     textOverflow?: "ellipsis" | "hide" | "none";
     wordWrap?: "normal" | "breakWord" | "none";
 }>;
-declare class Subtitle extends NestedOption<ISubtitleProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        font: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type ITitleProps = React.PropsWithChildren<{
+declare const _componentSubtitle: React.MemoExoticComponent<(props: ISubtitleProps) => React.FunctionComponentElement<ISubtitleProps>>;
+declare const Subtitle: typeof _componentSubtitle & IElementDescriptor;
+type ITitleProps = React.PropsWithChildren<{
     font?: ChartsFont;
     horizontalAlignment?: "center" | "left" | "right";
     margin?: number | Record<string, any> | {
@@ -386,24 +264,9 @@ declare type ITitleProps = React.PropsWithChildren<{
     verticalAlignment?: "bottom" | "top";
     wordWrap?: "normal" | "breakWord" | "none";
 }>;
-declare class Title extends NestedOption<ITitleProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        font: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        margin: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        subtitle: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type ITooltipProps = React.PropsWithChildren<{
+declare const _componentTitle: React.MemoExoticComponent<(props: ITitleProps) => React.FunctionComponentElement<ITitleProps>>;
+declare const Title: typeof _componentTitle & IElementDescriptor;
+type ITooltipProps = React.PropsWithChildren<{
     arrowLength?: number;
     border?: Record<string, any> | {
         color?: string;
@@ -452,53 +315,21 @@ declare type ITooltipProps = React.PropsWithChildren<{
     zIndex?: number;
     linkTooltipRender?: (...params: any) => React.ReactNode;
     linkTooltipComponent?: React.ComponentType<any>;
-    linkTooltipKeyFn?: (data: any) => string;
     nodeTooltipRender?: (...params: any) => React.ReactNode;
     nodeTooltipComponent?: React.ComponentType<any>;
-    nodeTooltipKeyFn?: (data: any) => string;
 }>;
-declare class Tooltip extends NestedOption<ITooltipProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        border: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        font: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        format: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        shadow: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        tooltipBorder: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-    static TemplateProps: {
-        tmplOption: string;
-        render: string;
-        component: string;
-        keyFn: string;
-    }[];
-}
-declare type ITooltipBorderProps = React.PropsWithChildren<{
+declare const _componentTooltip: React.MemoExoticComponent<(props: ITooltipProps) => React.FunctionComponentElement<ITooltipProps>>;
+declare const Tooltip: typeof _componentTooltip & IElementDescriptor;
+type ITooltipBorderProps = React.PropsWithChildren<{
     color?: string;
     dashStyle?: "dash" | "dot" | "longDash" | "solid";
     opacity?: number;
     visible?: boolean;
     width?: number;
 }>;
-declare class TooltipBorder extends NestedOption<ITooltipBorderProps> {
-    static OptionName: string;
-}
+declare const _componentTooltipBorder: React.MemoExoticComponent<(props: ITooltipBorderProps) => React.FunctionComponentElement<ITooltipBorderProps>>;
+declare const TooltipBorder: typeof _componentTooltipBorder & IElementDescriptor;
 export default Sankey;
-export { Sankey, ISankeyOptions, AdaptiveLayout, IAdaptiveLayoutProps, Border, IBorderProps, Export, IExportProps, Font, IFontProps, Format, IFormatProps, Hatching, IHatchingProps, HoverStyle, IHoverStyleProps, Label, ILabelProps, Link, ILinkProps, LoadingIndicator, ILoadingIndicatorProps, Margin, IMarginProps, Node, INodeProps, Sankeyborder, ISankeyborderProps, Shadow, IShadowProps, Size, ISizeProps, Subtitle, ISubtitleProps, Title, ITitleProps, Tooltip, ITooltipProps, TooltipBorder, ITooltipBorderProps };
+export { Sankey, ISankeyOptions, SankeyRef, AdaptiveLayout, IAdaptiveLayoutProps, Border, IBorderProps, Export, IExportProps, Font, IFontProps, Format, IFormatProps, Hatching, IHatchingProps, HoverStyle, IHoverStyleProps, Label, ILabelProps, Link, ILinkProps, LoadingIndicator, ILoadingIndicatorProps, Margin, IMarginProps, Node, INodeProps, Sankeyborder, ISankeyborderProps, Shadow, IShadowProps, Size, ISizeProps, Subtitle, ISubtitleProps, Title, ITitleProps, Tooltip, ITooltipProps, TooltipBorder, ITooltipBorderProps };
 import type * as SankeyTypes from 'devextreme/viz/sankey_types';
 export { SankeyTypes };