devextreme-react 23.2.6 → 24.1.2-beta

package/cjs/context-menu.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,20 +11,20 @@
  * https://github.com/DevExpress/devextreme-react
  */
 
-/// <reference types="react" />
 export { ExplicitTypes } from "devextreme/ui/context_menu";
+import * as React from "react";
+import { Ref, ReactElement } from "react";
 import dxContextMenu, { Properties } from "devextreme/ui/context_menu";
-import { Component as BaseComponent, IHtmlOptions } from "./core/component";
-import NestedOption from "./core/nested-option";
+import { IHtmlOptions, IElementDescriptor } from "./core/component";
 import type { dxContextMenuItem, ContentReadyEvent, DisposingEvent, HiddenEvent, HidingEvent, InitializedEvent, ItemClickEvent, ItemContextMenuEvent, ItemRenderedEvent, PositioningEvent, ShowingEvent, ShownEvent } from "devextreme/ui/context_menu";
 import type { AnimationConfig, AnimationState } from "devextreme/animation/fx";
 import type { PositionConfig } from "devextreme/animation/position";
 import type { CollectionWidgetItem } from "devextreme/ui/collection/ui.collection_widget.base";
 import type { template } from "devextreme/core/templates/template";
-declare type ReplaceFieldTypes<TSource, TReplacement> = {
+type ReplaceFieldTypes<TSource, TReplacement> = {
     [P in keyof TSource]: P extends keyof TReplacement ? TReplacement[P] : TSource[P];
 };
-declare type IContextMenuOptionsNarrowedEvents<TKey = any> = {
+type IContextMenuOptionsNarrowedEvents<TKey = any> = {
     onContentReady?: ((e: ContentReadyEvent<TKey>) => void);
     onDisposing?: ((e: DisposingEvent<TKey>) => void);
     onHidden?: ((e: HiddenEvent<TKey>) => void);
@@ -37,11 +37,10 @@ declare type IContextMenuOptionsNarrowedEvents<TKey = any> = {
     onShowing?: ((e: ShowingEvent<TKey>) => void);
     onShown?: ((e: ShownEvent<TKey>) => void);
 };
-declare type IContextMenuOptions<TKey = any> = React.PropsWithChildren<ReplaceFieldTypes<Properties<TKey>, IContextMenuOptionsNarrowedEvents<TKey>> & IHtmlOptions & {
+type IContextMenuOptions<TKey = any> = React.PropsWithChildren<ReplaceFieldTypes<Properties<TKey>, IContextMenuOptionsNarrowedEvents<TKey>> & IHtmlOptions & {
     dataSource?: Properties<TKey>["dataSource"];
     itemRender?: (...params: any) => React.ReactNode;
     itemComponent?: React.ComponentType<any>;
-    itemKeyFn?: (data: any) => string;
     defaultItems?: Array<dxContextMenuItem>;
     defaultSelectedItem?: any;
     defaultVisible?: boolean;
@@ -49,107 +48,64 @@ declare type IContextMenuOptions<TKey = any> = React.PropsWithChildren<ReplaceFi
     onSelectedItemChange?: (value: any) => void;
     onVisibleChange?: (value: boolean) => void;
 }>;
-declare class ContextMenu<TKey = any> extends BaseComponent<React.PropsWithChildren<IContextMenuOptions<TKey>>> {
-    get instance(): dxContextMenu<TKey>;
-    protected _WidgetClass: typeof dxContextMenu;
-    protected subscribableOptions: string[];
-    protected independentEvents: string[];
-    protected _defaults: {
-        defaultItems: string;
-        defaultSelectedItem: string;
-        defaultVisible: string;
-    };
-    protected _expectedChildren: {
-        animation: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        item: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        position: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        showEvent: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        showSubmenuMode: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-    protected _templateProps: {
-        tmplOption: string;
-        render: string;
-        component: string;
-        keyFn: string;
-    }[];
+interface ContextMenuRef<TKey = any> {
+    instance: () => dxContextMenu<TKey>;
 }
-declare type IAnimationProps = React.PropsWithChildren<{
+declare const ContextMenu: <TKey = any>(props: ReplaceFieldTypes<Properties<TKey>, IContextMenuOptionsNarrowedEvents<TKey>> & IHtmlOptions & {
+    dataSource?: import("devextreme/data/data_source").DataSourceLike<dxContextMenuItem, TKey> | null | undefined;
+    itemRender?: ((...params: any) => React.ReactNode) | undefined;
+    itemComponent?: React.ComponentType<any> | undefined;
+    defaultItems?: dxContextMenuItem[] | undefined;
+    defaultSelectedItem?: any;
+    defaultVisible?: boolean | undefined;
+    onItemsChange?: ((value: Array<dxContextMenuItem>) => void) | undefined;
+    onSelectedItemChange?: ((value: any) => void) | undefined;
+    onVisibleChange?: ((value: boolean) => void) | undefined;
+} & {
+    children?: React.ReactNode;
+} & {
+    ref?: React.Ref<ContextMenuRef<TKey>> | undefined;
+}) => 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 ICollisionProps = React.PropsWithChildren<{
+declare const _componentBoundaryOffset: React.MemoExoticComponent<(props: IBoundaryOffsetProps) => React.FunctionComponentElement<IBoundaryOffsetProps>>;
+declare const BoundaryOffset: typeof _componentBoundaryOffset & 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 IDelayProps = React.PropsWithChildren<{
+declare const _componentCollision: React.MemoExoticComponent<(props: ICollisionProps) => React.FunctionComponentElement<ICollisionProps>>;
+declare const Collision: typeof _componentCollision & IElementDescriptor;
+type IDelayProps = React.PropsWithChildren<{
     hide?: number;
     show?: number;
 }>;
-declare class Delay extends NestedOption<IDelayProps> {
-    static OptionName: string;
-}
-declare type IFromProps = React.PropsWithChildren<{
+declare const _componentDelay: React.MemoExoticComponent<(props: IDelayProps) => React.FunctionComponentElement<IDelayProps>>;
+declare const Delay: typeof _componentDelay & 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";
@@ -161,20 +117,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<{
     beginGroup?: boolean;
     closeMenuOnClick?: boolean;
     disabled?: boolean;
@@ -187,33 +132,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 IPositionProps = React.PropsWithChildren<{
+declare const _componentOffset: React.MemoExoticComponent<(props: IOffsetProps) => React.FunctionComponentElement<IOffsetProps>>;
+declare const Offset: typeof _componentOffset & 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";
@@ -237,10 +171,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";
@@ -252,43 +185,33 @@ 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 IShowEventProps = React.PropsWithChildren<{
+declare const _componentShow: React.MemoExoticComponent<(props: IShowProps) => React.FunctionComponentElement<IShowProps>>;
+declare const Show: typeof _componentShow & IElementDescriptor;
+type IShowEventProps = React.PropsWithChildren<{
     delay?: number;
     name?: string;
 }>;
-declare class ShowEvent extends NestedOption<IShowEventProps> {
-    static OptionName: string;
-}
-declare type IShowSubmenuModeProps = React.PropsWithChildren<{
+declare const _componentShowEvent: React.MemoExoticComponent<(props: IShowEventProps) => React.FunctionComponentElement<IShowEventProps>>;
+declare const ShowEvent: typeof _componentShowEvent & IElementDescriptor;
+type IShowSubmenuModeProps = React.PropsWithChildren<{
     delay?: number | Record<string, any> | {
         hide?: number;
         show?: number;
     };
     name?: "onClick" | "onHover";
 }>;
-declare class ShowSubmenuMode extends NestedOption<IShowSubmenuModeProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        delay: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type IToProps = React.PropsWithChildren<{
+declare const _componentShowSubmenuMode: React.MemoExoticComponent<(props: IShowSubmenuModeProps) => React.FunctionComponentElement<IShowSubmenuModeProps>>;
+declare const ShowSubmenuMode: typeof _componentShowSubmenuMode & 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 const _componentTo: React.MemoExoticComponent<(props: IToProps) => React.FunctionComponentElement<IToProps>>;
+declare const To: typeof _componentTo & IElementDescriptor;
 export default ContextMenu;
-export { ContextMenu, IContextMenuOptions, Animation, IAnimationProps, At, IAtProps, BoundaryOffset, IBoundaryOffsetProps, Collision, ICollisionProps, Delay, IDelayProps, From, IFromProps, Hide, IHideProps, Item, IItemProps, My, IMyProps, Offset, IOffsetProps, Position, IPositionProps, Show, IShowProps, ShowEvent, IShowEventProps, ShowSubmenuMode, IShowSubmenuModeProps, To, IToProps };
+export { ContextMenu, IContextMenuOptions, ContextMenuRef, Animation, IAnimationProps, At, IAtProps, BoundaryOffset, IBoundaryOffsetProps, Collision, ICollisionProps, Delay, IDelayProps, From, IFromProps, Hide, IHideProps, Item, IItemProps, My, IMyProps, Offset, IOffsetProps, Position, IPositionProps, Show, IShowProps, ShowEvent, IShowEventProps, ShowSubmenuMode, IShowSubmenuModeProps, To, IToProps };
 import type * as ContextMenuTypes from 'devextreme/ui/context_menu_types';
 export { ContextMenuTypes };