devextreme-react 23.2.6 → 24.1.2-beta

package/cjs/list.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,11 +11,11 @@
  * https://github.com/DevExpress/devextreme-react
  */
 
-/// <reference types="react" />
 export { ExplicitTypes } from "devextreme/ui/list";
+import * as React from "react";
+import { Ref, ReactElement } from "react";
 import dxList, { Properties } from "devextreme/ui/list";
-import { Component as BaseComponent, IHtmlOptions } from "./core/component";
-import NestedOption from "./core/nested-option";
+import { IHtmlOptions, IElementDescriptor } from "./core/component";
 import type { dxListItem, ContentReadyEvent, DisposingEvent, GroupRenderedEvent, InitializedEvent, ItemClickEvent, ItemContextMenuEvent, ItemDeletedEvent, ItemDeletingEvent, ItemHoldEvent, ItemRenderedEvent, ItemReorderedEvent, ItemSwipeEvent, PageLoadingEvent, PullRefreshEvent, ScrollEvent, SelectAllValueChangedEvent } from "devextreme/ui/list";
 import type { ContentReadyEvent as ButtonContentReadyEvent, DisposingEvent as ButtonDisposingEvent, InitializedEvent as ButtonInitializedEvent, dxButtonOptions, OptionChangedEvent as ButtonOptionChangedEvent, ClickEvent } from "devextreme/ui/button";
 import type { ContentReadyEvent as TextBoxContentReadyEvent, DisposingEvent as TextBoxDisposingEvent, InitializedEvent as TextBoxInitializedEvent, OptionChangedEvent as TextBoxOptionChangedEvent, ChangeEvent, CopyEvent, CutEvent, EnterKeyEvent, FocusInEvent, FocusOutEvent, InputEvent, KeyDownEvent, KeyUpEvent, PasteEvent, ValueChangedEvent } from "devextreme/ui/text_box";
@@ -23,10 +23,10 @@ import type { DisposingEvent as SortableDisposingEvent, InitializedEvent as Sort
 import type { CollectionWidgetItem } from "devextreme/ui/collection/ui.collection_widget.base";
 import type { template } from "devextreme/core/templates/template";
 import type { TextEditorButton } from "devextreme/common";
-declare type ReplaceFieldTypes<TSource, TReplacement> = {
+type ReplaceFieldTypes<TSource, TReplacement> = {
     [P in keyof TSource]: P extends keyof TReplacement ? TReplacement[P] : TSource[P];
 };
-declare type IListOptionsNarrowedEvents<TItem = any, TKey = any> = {
+type IListOptionsNarrowedEvents<TItem = any, TKey = any> = {
     onContentReady?: ((e: ContentReadyEvent<TItem, TKey>) => void);
     onDisposing?: ((e: DisposingEvent<TItem, TKey>) => void);
     onGroupRendered?: ((e: GroupRenderedEvent<TItem, TKey>) => void);
@@ -44,14 +44,12 @@ declare type IListOptionsNarrowedEvents<TItem = any, TKey = any> = {
     onScroll?: ((e: ScrollEvent<TItem, TKey>) => void);
     onSelectAllValueChanged?: ((e: SelectAllValueChangedEvent<TItem, TKey>) => void);
 };
-declare type IListOptions<TItem = any, TKey = any> = React.PropsWithChildren<ReplaceFieldTypes<Properties<TItem, TKey>, IListOptionsNarrowedEvents<TItem, TKey>> & IHtmlOptions & {
+type IListOptions<TItem = any, TKey = any> = React.PropsWithChildren<ReplaceFieldTypes<Properties<TItem, TKey>, IListOptionsNarrowedEvents<TItem, TKey>> & IHtmlOptions & {
     dataSource?: Properties<TItem, TKey>["dataSource"];
     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;
     defaultItems?: Array<any | dxListItem | string>;
     defaultSelectedItemKeys?: Array<any>;
     defaultSelectedItems?: Array<any>;
@@ -59,64 +57,40 @@ declare type IListOptions<TItem = any, TKey = any> = React.PropsWithChildren<Rep
     onSelectedItemKeysChange?: (value: Array<any>) => void;
     onSelectedItemsChange?: (value: Array<any>) => void;
 }>;
-declare class List<TItem = any, TKey = any> extends BaseComponent<React.PropsWithChildren<IListOptions<TItem, TKey>>> {
-    get instance(): dxList<TItem, TKey>;
-    protected _WidgetClass: typeof dxList;
-    protected subscribableOptions: string[];
-    protected independentEvents: string[];
-    protected _defaults: {
-        defaultItems: string;
-        defaultSelectedItemKeys: string;
-        defaultSelectedItems: string;
-    };
-    protected _expectedChildren: {
-        item: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        itemDragging: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        menuItem: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        searchEditorOptions: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-    protected _templateProps: {
-        tmplOption: string;
-        render: string;
-        component: string;
-        keyFn: string;
-    }[];
+interface ListRef<TItem = any, TKey = any> {
+    instance: () => dxList<TItem, TKey>;
 }
-declare type IButtonProps = React.PropsWithChildren<{
+declare const List: <TItem = any, TKey = any>(props: ReplaceFieldTypes<Properties<TItem, TKey>, IListOptionsNarrowedEvents<TItem, TKey>> & IHtmlOptions & {
+    dataSource?: import("devextreme/data/data_source").DataSourceLike<TItem, TKey> | null | undefined;
+    groupRender?: ((...params: any) => React.ReactNode) | undefined;
+    groupComponent?: React.ComponentType<any> | undefined;
+    itemRender?: ((...params: any) => React.ReactNode) | undefined;
+    itemComponent?: React.ComponentType<any> | undefined;
+    defaultItems?: any[] | undefined;
+    defaultSelectedItemKeys?: any[] | undefined;
+    defaultSelectedItems?: any[] | undefined;
+    onItemsChange?: ((value: Array<any | dxListItem | string>) => void) | undefined;
+    onSelectedItemKeysChange?: ((value: Array<any>) => void) | undefined;
+    onSelectedItemsChange?: ((value: Array<any>) => void) | undefined;
+} & {
+    children?: React.ReactNode;
+} & {
+    ref?: React.Ref<ListRef<TItem, TKey>> | undefined;
+}) => ReactElement | null;
+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 ICursorOffsetProps = React.PropsWithChildren<{
+declare const _componentButton: React.MemoExoticComponent<(props: IButtonProps) => React.FunctionComponentElement<IButtonProps>>;
+declare const Button: typeof _componentButton & IElementDescriptor;
+type ICursorOffsetProps = React.PropsWithChildren<{
     x?: number;
     y?: number;
 }>;
-declare class CursorOffset extends NestedOption<ICursorOffsetProps> {
-    static OptionName: string;
-}
-declare type IItemProps = React.PropsWithChildren<{
+declare const _componentCursorOffset: React.MemoExoticComponent<(props: ICursorOffsetProps) => React.FunctionComponentElement<ICursorOffsetProps>>;
+declare const CursorOffset: typeof _componentCursorOffset & IElementDescriptor;
+type IItemProps = React.PropsWithChildren<{
     badge?: string;
     disabled?: boolean;
     html?: string;
@@ -128,19 +102,10 @@ 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 IItemDraggingProps = React.PropsWithChildren<{
+declare const _componentItem: React.MemoExoticComponent<(props: IItemProps) => React.FunctionComponentElement<IItemProps>>;
+declare const Item: typeof _componentItem & IElementDescriptor;
+type IItemDraggingProps = React.PropsWithChildren<{
     allowDropInsideItem?: boolean;
     allowReordering?: boolean;
     autoScroll?: boolean;
@@ -182,32 +147,16 @@ declare type IItemDraggingProps = React.PropsWithChildren<{
     width?: (() => number | string) | number | string;
     dragRender?: (...params: any) => React.ReactNode;
     dragComponent?: React.ComponentType<any>;
-    dragKeyFn?: (data: any) => string;
 }>;
-declare class ItemDragging extends NestedOption<IItemDraggingProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        cursorOffset: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-    static TemplateProps: {
-        tmplOption: string;
-        render: string;
-        component: string;
-        keyFn: string;
-    }[];
-}
-declare type IMenuItemProps = React.PropsWithChildren<{
+declare const _componentItemDragging: React.MemoExoticComponent<(props: IItemDraggingProps) => React.FunctionComponentElement<IItemDraggingProps>>;
+declare const ItemDragging: typeof _componentItemDragging & IElementDescriptor;
+type IMenuItemProps = React.PropsWithChildren<{
     action?: ((itemElement: any, itemData: any) => void);
     text?: string;
 }>;
-declare class MenuItem extends NestedOption<IMenuItemProps> {
-    static OptionName: string;
-    static IsCollectionItem: boolean;
-}
-declare type IOptionsProps = React.PropsWithChildren<{
+declare const _componentMenuItem: React.MemoExoticComponent<(props: IMenuItemProps) => React.FunctionComponentElement<IMenuItemProps>>;
+declare const MenuItem: typeof _componentMenuItem & IElementDescriptor;
+type IOptionsProps = React.PropsWithChildren<{
     accessKey?: string;
     activeStateEnabled?: boolean;
     bindingOptions?: Record<string, any>;
@@ -238,18 +187,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 ISearchEditorOptionsProps = React.PropsWithChildren<{
+declare const _componentOptions: React.MemoExoticComponent<(props: IOptionsProps) => React.FunctionComponentElement<IOptionsProps>>;
+declare const Options: typeof _componentOptions & IElementDescriptor;
+type ISearchEditorOptionsProps = React.PropsWithChildren<{
     accessKey?: string;
     activeStateEnabled?: boolean;
     bindingOptions?: Record<string, any>;
@@ -309,19 +250,9 @@ declare type ISearchEditorOptionsProps = React.PropsWithChildren<{
     defaultValue?: string;
     onValueChange?: (value: string) => void;
 }>;
-declare class SearchEditorOptions extends NestedOption<ISearchEditorOptionsProps> {
-    static OptionName: string;
-    static DefaultsProps: {
-        defaultValue: string;
-    };
-    static ExpectedChildren: {
-        button: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
+declare const _componentSearchEditorOptions: React.MemoExoticComponent<(props: ISearchEditorOptionsProps) => React.FunctionComponentElement<ISearchEditorOptionsProps>>;
+declare const SearchEditorOptions: typeof _componentSearchEditorOptions & IElementDescriptor;
 export default List;
-export { List, IListOptions, Button, IButtonProps, CursorOffset, ICursorOffsetProps, Item, IItemProps, ItemDragging, IItemDraggingProps, MenuItem, IMenuItemProps, Options, IOptionsProps, SearchEditorOptions, ISearchEditorOptionsProps };
+export { List, IListOptions, ListRef, Button, IButtonProps, CursorOffset, ICursorOffsetProps, Item, IItemProps, ItemDragging, IItemDraggingProps, MenuItem, IMenuItemProps, Options, IOptionsProps, SearchEditorOptions, ISearchEditorOptionsProps };
 import type * as ListTypes from 'devextreme/ui/list_types';
 export { ListTypes };