devextreme-react 23.2.6 → 24.1.2-beta

package/cjs/tag-box.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,10 +11,10 @@
  * https://github.com/DevExpress/devextreme-react
  */
 
-/// <reference types="react" />
+import * as React from "react";
+import { Ref, ReactElement } from "react";
 import dxTagBox, { Properties } from "devextreme/ui/tag_box";
-import { Component as BaseComponent, IHtmlOptions } from "./core/component";
-import NestedOption from "./core/nested-option";
+import { IHtmlOptions, IElementDescriptor } from "./core/component";
 import type { ChangeEvent, ClosedEvent, ContentReadyEvent, CustomItemCreatingEvent, DisposingEvent, EnterKeyEvent, FocusInEvent, FocusOutEvent, InitializedEvent, InputEvent, ItemClickEvent, KeyDownEvent, KeyUpEvent, MultiTagPreparingEvent, OpenedEvent, SelectAllValueChangedEvent, ValueChangedEvent } from "devextreme/ui/tag_box";
 import type { ContentReadyEvent as ButtonContentReadyEvent, DisposingEvent as ButtonDisposingEvent, InitializedEvent as ButtonInitializedEvent, dxButtonOptions, ClickEvent, OptionChangedEvent } from "devextreme/ui/button";
 import type { AnimationConfig, AnimationState } from "devextreme/animation/fx";
@@ -27,10 +27,10 @@ import type { CollectionWidgetItem } from "devextreme/ui/collection/ui.collectio
 import type dxOverlay from "devextreme/ui/overlay";
 import type DOMComponent from "devextreme/core/dom_component";
 import type dxPopup from "devextreme/ui/popup";
-declare type ReplaceFieldTypes<TSource, TReplacement> = {
+type ReplaceFieldTypes<TSource, TReplacement> = {
     [P in keyof TSource]: P extends keyof TReplacement ? TReplacement[P] : TSource[P];
 };
-declare type ITagBoxOptionsNarrowedEvents = {
+type ITagBoxOptionsNarrowedEvents = {
     onChange?: ((e: ChangeEvent) => void);
     onClosed?: ((e: ClosedEvent) => void);
     onContentReady?: ((e: ContentReadyEvent) => void);
@@ -49,111 +49,60 @@ declare type ITagBoxOptionsNarrowedEvents = {
     onSelectAllValueChanged?: ((e: SelectAllValueChangedEvent) => void);
     onValueChanged?: ((e: ValueChangedEvent) => void);
 };
-declare type ITagBoxOptions = React.PropsWithChildren<ReplaceFieldTypes<Properties, ITagBoxOptionsNarrowedEvents> & IHtmlOptions & {
+type ITagBoxOptions = React.PropsWithChildren<ReplaceFieldTypes<Properties, ITagBoxOptionsNarrowedEvents> & IHtmlOptions & {
     dropDownButtonRender?: (...params: any) => React.ReactNode;
     dropDownButtonComponent?: React.ComponentType<any>;
-    dropDownButtonKeyFn?: (data: any) => string;
     fieldRender?: (...params: any) => React.ReactNode;
     fieldComponent?: React.ComponentType<any>;
-    fieldKeyFn?: (data: any) => string;
     groupRender?: (...params: any) => React.ReactNode;
     groupComponent?: React.ComponentType<any>;
-    groupKeyFn?: (data: any) => string;
     itemRender?: (...params: any) => React.ReactNode;
     itemComponent?: React.ComponentType<any>;
-    itemKeyFn?: (data: any) => string;
     tagRender?: (...params: any) => React.ReactNode;
     tagComponent?: React.ComponentType<any>;
-    tagKeyFn?: (data: any) => string;
     defaultOpened?: boolean;
     defaultValue?: Array<any | number | string>;
     onOpenedChange?: (value: boolean) => void;
     onValueChange?: (value: Array<any | number | string>) => void;
 }>;
-declare class TagBox extends BaseComponent<React.PropsWithChildren<ITagBoxOptions>> {
-    get instance(): dxTagBox;
-    protected _WidgetClass: typeof dxTagBox;
-    protected subscribableOptions: string[];
-    protected independentEvents: string[];
-    protected _defaults: {
-        defaultOpened: string;
-        defaultValue: string;
-    };
-    protected _expectedChildren: {
-        button: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        dropDownOptions: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        item: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-    protected _templateProps: {
-        tmplOption: string;
-        render: string;
-        component: string;
-        keyFn: string;
-    }[];
+interface TagBoxRef {
+    instance: () => dxTagBox;
 }
-declare type IAnimationProps = React.PropsWithChildren<{
+declare const TagBox: (props: React.PropsWithChildren<ITagBoxOptions> & {
+    ref?: Ref<TagBoxRef>;
+}) => ReactElement | null;
+type IAnimationProps = React.PropsWithChildren<{
     hide?: AnimationConfig;
     show?: AnimationConfig;
 }>;
-declare class Animation extends NestedOption<IAnimationProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        hide: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        show: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type IAtProps = React.PropsWithChildren<{
+declare const _componentAnimation: React.MemoExoticComponent<(props: IAnimationProps) => React.FunctionComponentElement<IAnimationProps>>;
+declare const Animation: typeof _componentAnimation & IElementDescriptor;
+type IAtProps = React.PropsWithChildren<{
     x?: "center" | "left" | "right";
     y?: "bottom" | "center" | "top";
 }>;
-declare class At extends NestedOption<IAtProps> {
-    static OptionName: string;
-}
-declare type IBoundaryOffsetProps = React.PropsWithChildren<{
+declare const _componentAt: React.MemoExoticComponent<(props: IAtProps) => React.FunctionComponentElement<IAtProps>>;
+declare const At: typeof _componentAt & IElementDescriptor;
+type IBoundaryOffsetProps = React.PropsWithChildren<{
     x?: number;
     y?: number;
 }>;
-declare class BoundaryOffset extends NestedOption<IBoundaryOffsetProps> {
-    static OptionName: string;
-}
-declare type IButtonProps = React.PropsWithChildren<{
+declare const _componentBoundaryOffset: React.MemoExoticComponent<(props: IBoundaryOffsetProps) => React.FunctionComponentElement<IBoundaryOffsetProps>>;
+declare const BoundaryOffset: typeof _componentBoundaryOffset & IElementDescriptor;
+type IButtonProps = React.PropsWithChildren<{
     location?: "after" | "before";
     name?: string;
     options?: dxButtonOptions;
 }>;
-declare class Button extends NestedOption<IButtonProps> {
-    static OptionName: string;
-    static IsCollectionItem: boolean;
-    static ExpectedChildren: {
-        options: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type ICollisionProps = React.PropsWithChildren<{
+declare const _componentButton: React.MemoExoticComponent<(props: IButtonProps) => React.FunctionComponentElement<IButtonProps>>;
+declare const Button: typeof _componentButton & IElementDescriptor;
+type ICollisionProps = React.PropsWithChildren<{
     x?: "fit" | "flip" | "flipfit" | "none";
     y?: "fit" | "flip" | "flipfit" | "none";
 }>;
-declare class Collision extends NestedOption<ICollisionProps> {
-    static OptionName: string;
-}
-declare type IDropDownOptionsProps = React.PropsWithChildren<{
+declare const _componentCollision: React.MemoExoticComponent<(props: ICollisionProps) => React.FunctionComponentElement<ICollisionProps>>;
+declare const Collision: typeof _componentCollision & IElementDescriptor;
+type IDropDownOptionsProps = React.PropsWithChildren<{
     accessKey?: string;
     animation?: Record<string, any> | {
         hide?: AnimationConfig;
@@ -163,13 +112,11 @@ declare type IDropDownOptionsProps = React.PropsWithChildren<{
     closeOnOutsideClick?: boolean | ((event: event) => boolean);
     container?: any | string;
     contentTemplate?: ((contentElement: any) => string | any) | template;
-    copyRootClassesToWrapper?: boolean;
     deferRendering?: boolean;
     disabled?: boolean;
     dragAndResizeArea?: any | string;
     dragEnabled?: boolean;
     dragOutsideBoundary?: boolean;
-    elementAttr?: any;
     enableBodyScroll?: boolean;
     focusStateEnabled?: boolean;
     fullScreen?: boolean;
@@ -266,57 +213,21 @@ declare type IDropDownOptionsProps = React.PropsWithChildren<{
     onWidthChange?: (value: (() => number | string) | number | string) => void;
     contentRender?: (...params: any) => React.ReactNode;
     contentComponent?: React.ComponentType<any>;
-    contentKeyFn?: (data: any) => string;
     titleRender?: (...params: any) => React.ReactNode;
     titleComponent?: React.ComponentType<any>;
-    titleKeyFn?: (data: any) => string;
 }>;
-declare class DropDownOptions extends NestedOption<IDropDownOptionsProps> {
-    static OptionName: string;
-    static DefaultsProps: {
-        defaultHeight: string;
-        defaultPosition: string;
-        defaultVisible: string;
-        defaultWidth: string;
-    };
-    static ExpectedChildren: {
-        animation: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        position: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        toolbarItem: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-    static TemplateProps: {
-        tmplOption: string;
-        render: string;
-        component: string;
-        keyFn: string;
-    }[];
-}
-declare type IFromProps = React.PropsWithChildren<{
+declare const _componentDropDownOptions: React.MemoExoticComponent<(props: IDropDownOptionsProps) => React.FunctionComponentElement<IDropDownOptionsProps>>;
+declare const DropDownOptions: typeof _componentDropDownOptions & IElementDescriptor;
+type IFromProps = React.PropsWithChildren<{
     left?: number;
     opacity?: number;
     position?: PositionConfig;
     scale?: number;
     top?: number;
 }>;
-declare class From extends NestedOption<IFromProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        position: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type IHideProps = React.PropsWithChildren<{
+declare const _componentFrom: React.MemoExoticComponent<(props: IFromProps) => React.FunctionComponentElement<IFromProps>>;
+declare const From: typeof _componentFrom & IElementDescriptor;
+type IHideProps = React.PropsWithChildren<{
     complete?: (($element: any, config: AnimationConfig) => void);
     delay?: number;
     direction?: "bottom" | "left" | "right" | "top";
@@ -328,20 +239,9 @@ declare type IHideProps = React.PropsWithChildren<{
     to?: AnimationState;
     type?: "css" | "fade" | "fadeIn" | "fadeOut" | "pop" | "slide" | "slideIn" | "slideOut";
 }>;
-declare class Hide extends NestedOption<IHideProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        from: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        to: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type IItemProps = React.PropsWithChildren<{
+declare const _componentHide: React.MemoExoticComponent<(props: IHideProps) => React.FunctionComponentElement<IHideProps>>;
+declare const Hide: typeof _componentHide & IElementDescriptor;
+type IItemProps = React.PropsWithChildren<{
     disabled?: boolean;
     html?: string;
     template?: ((itemData: CollectionWidgetItem, itemIndex: number, itemElement: any) => string | any) | template;
@@ -349,33 +249,22 @@ declare type IItemProps = React.PropsWithChildren<{
     visible?: boolean;
     render?: (...params: any) => React.ReactNode;
     component?: React.ComponentType<any>;
-    keyFn?: (data: any) => string;
 }>;
-declare class Item extends NestedOption<IItemProps> {
-    static OptionName: string;
-    static IsCollectionItem: boolean;
-    static TemplateProps: {
-        tmplOption: string;
-        render: string;
-        component: string;
-        keyFn: string;
-    }[];
-}
-declare type IMyProps = React.PropsWithChildren<{
+declare const _componentItem: React.MemoExoticComponent<(props: IItemProps) => React.FunctionComponentElement<IItemProps>>;
+declare const Item: typeof _componentItem & IElementDescriptor;
+type IMyProps = React.PropsWithChildren<{
     x?: "center" | "left" | "right";
     y?: "bottom" | "center" | "top";
 }>;
-declare class My extends NestedOption<IMyProps> {
-    static OptionName: string;
-}
-declare type IOffsetProps = React.PropsWithChildren<{
+declare const _componentMy: React.MemoExoticComponent<(props: IMyProps) => React.FunctionComponentElement<IMyProps>>;
+declare const My: typeof _componentMy & IElementDescriptor;
+type IOffsetProps = React.PropsWithChildren<{
     x?: number;
     y?: number;
 }>;
-declare class Offset extends NestedOption<IOffsetProps> {
-    static OptionName: string;
-}
-declare type IOptionsProps = React.PropsWithChildren<{
+declare const _componentOffset: React.MemoExoticComponent<(props: IOffsetProps) => React.FunctionComponentElement<IOffsetProps>>;
+declare const Offset: typeof _componentOffset & IElementDescriptor;
+type IOptionsProps = React.PropsWithChildren<{
     accessKey?: string;
     activeStateEnabled?: boolean;
     bindingOptions?: Record<string, any>;
@@ -406,18 +295,10 @@ declare type IOptionsProps = React.PropsWithChildren<{
     width?: (() => number | string) | number | string;
     render?: (...params: any) => React.ReactNode;
     component?: React.ComponentType<any>;
-    keyFn?: (data: any) => string;
 }>;
-declare class Options extends NestedOption<IOptionsProps> {
-    static OptionName: string;
-    static TemplateProps: {
-        tmplOption: string;
-        render: string;
-        component: string;
-        keyFn: string;
-    }[];
-}
-declare type IPositionProps = React.PropsWithChildren<{
+declare const _componentOptions: React.MemoExoticComponent<(props: IOptionsProps) => React.FunctionComponentElement<IOptionsProps>>;
+declare const Options: typeof _componentOptions & IElementDescriptor;
+type IPositionProps = React.PropsWithChildren<{
     at?: Record<string, any> | "bottom" | "center" | "left" | "left bottom" | "left top" | "right" | "right bottom" | "right top" | "top" | {
         x?: "center" | "left" | "right";
         y?: "bottom" | "center" | "top";
@@ -441,10 +322,9 @@ declare type IPositionProps = React.PropsWithChildren<{
         y?: number;
     };
 }>;
-declare class Position extends NestedOption<IPositionProps> {
-    static OptionName: string;
-}
-declare type IShowProps = React.PropsWithChildren<{
+declare const _componentPosition: React.MemoExoticComponent<(props: IPositionProps) => React.FunctionComponentElement<IPositionProps>>;
+declare const Position: typeof _componentPosition & IElementDescriptor;
+type IShowProps = React.PropsWithChildren<{
     complete?: (($element: any, config: AnimationConfig) => void);
     delay?: number;
     direction?: "bottom" | "left" | "right" | "top";
@@ -456,20 +336,18 @@ declare type IShowProps = React.PropsWithChildren<{
     to?: AnimationState;
     type?: "css" | "fade" | "fadeIn" | "fadeOut" | "pop" | "slide" | "slideIn" | "slideOut";
 }>;
-declare class Show extends NestedOption<IShowProps> {
-    static OptionName: string;
-}
-declare type IToProps = React.PropsWithChildren<{
+declare const _componentShow: React.MemoExoticComponent<(props: IShowProps) => React.FunctionComponentElement<IShowProps>>;
+declare const Show: typeof _componentShow & IElementDescriptor;
+type IToProps = React.PropsWithChildren<{
     left?: number;
     opacity?: number;
     position?: PositionConfig;
     scale?: number;
     top?: number;
 }>;
-declare class To extends NestedOption<IToProps> {
-    static OptionName: string;
-}
-declare type IToolbarItemProps = React.PropsWithChildren<{
+declare const _componentTo: React.MemoExoticComponent<(props: IToProps) => React.FunctionComponentElement<IToProps>>;
+declare const To: typeof _componentTo & IElementDescriptor;
+type IToolbarItemProps = React.PropsWithChildren<{
     cssClass?: string;
     disabled?: boolean;
     html?: string;
@@ -485,22 +363,12 @@ declare type IToolbarItemProps = React.PropsWithChildren<{
     widget?: "dxAutocomplete" | "dxButton" | "dxButtonGroup" | "dxCheckBox" | "dxDateBox" | "dxDropDownButton" | "dxMenu" | "dxSelectBox" | "dxSwitch" | "dxTabs" | "dxTextBox";
     menuItemRender?: (...params: any) => React.ReactNode;
     menuItemComponent?: React.ComponentType<any>;
-    menuItemKeyFn?: (data: any) => string;
     render?: (...params: any) => React.ReactNode;
     component?: React.ComponentType<any>;
-    keyFn?: (data: any) => string;
 }>;
-declare class ToolbarItem extends NestedOption<IToolbarItemProps> {
-    static OptionName: string;
-    static IsCollectionItem: boolean;
-    static TemplateProps: {
-        tmplOption: string;
-        render: string;
-        component: string;
-        keyFn: string;
-    }[];
-}
+declare const _componentToolbarItem: React.MemoExoticComponent<(props: IToolbarItemProps) => React.FunctionComponentElement<IToolbarItemProps>>;
+declare const ToolbarItem: typeof _componentToolbarItem & IElementDescriptor;
 export default TagBox;
-export { TagBox, ITagBoxOptions, Animation, IAnimationProps, At, IAtProps, BoundaryOffset, IBoundaryOffsetProps, Button, IButtonProps, Collision, ICollisionProps, DropDownOptions, IDropDownOptionsProps, From, IFromProps, Hide, IHideProps, Item, IItemProps, My, IMyProps, Offset, IOffsetProps, Options, IOptionsProps, Position, IPositionProps, Show, IShowProps, To, IToProps, ToolbarItem, IToolbarItemProps };
+export { TagBox, ITagBoxOptions, TagBoxRef, Animation, IAnimationProps, At, IAtProps, BoundaryOffset, IBoundaryOffsetProps, Button, IButtonProps, Collision, ICollisionProps, DropDownOptions, IDropDownOptionsProps, From, IFromProps, Hide, IHideProps, Item, IItemProps, My, IMyProps, Offset, IOffsetProps, Options, IOptionsProps, Position, IPositionProps, Show, IShowProps, To, IToProps, ToolbarItem, IToolbarItemProps };
 import type * as TagBoxTypes from 'devextreme/ui/tag_box_types';
 export { TagBoxTypes };