devextreme-react 23.2.6 → 24.1.2-beta

package/cjs/html-editor.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 dxHtmlEditor, { Properties } from "devextreme/ui/html_editor";
-import { Component as BaseComponent, IHtmlOptions } from "./core/component";
-import NestedOption from "./core/nested-option";
+import { IHtmlOptions, IElementDescriptor } from "./core/component";
 import type { ContentReadyEvent, DisposingEvent, FocusInEvent, FocusOutEvent, InitializedEvent, ValueChangedEvent, dxHtmlEditorImageUploadTabItem, dxHtmlEditorTableContextMenuItem, dxHtmlEditorToolbarItem } from "devextreme/ui/html_editor";
 import type { ContentReadyEvent as FileUploaderContentReadyEvent, DisposingEvent as FileUploaderDisposingEvent, InitializedEvent as FileUploaderInitializedEvent, ValueChangedEvent as FileUploaderValueChangedEvent, BeforeSendEvent, DropZoneEnterEvent, DropZoneLeaveEvent, FilesUploadedEvent, OptionChangedEvent, ProgressEvent, UploadAbortedEvent, UploadedEvent, UploadErrorEvent, UploadStartedEvent, dxFileUploaderOptions } from "devextreme/ui/file_uploader";
 import type { CollectionWidgetItem } from "devextreme/ui/collection/ui.collection_widget.base";
@@ -23,10 +23,10 @@ import type { DataSourceOptions } from "devextreme/data/data_source";
 import type { Store } from "devextreme/data/store";
 import type UploadInfo from "devextreme/file_management/upload_info";
 import type DataSource from "devextreme/data/data_source";
-declare type ReplaceFieldTypes<TSource, TReplacement> = {
+type ReplaceFieldTypes<TSource, TReplacement> = {
     [P in keyof TSource]: P extends keyof TReplacement ? TReplacement[P] : TSource[P];
 };
-declare type IHtmlEditorOptionsNarrowedEvents = {
+type IHtmlEditorOptionsNarrowedEvents = {
     onContentReady?: ((e: ContentReadyEvent) => void);
     onDisposing?: ((e: DisposingEvent) => void);
     onFocusIn?: ((e: FocusInEvent) => void);
@@ -34,50 +34,17 @@ declare type IHtmlEditorOptionsNarrowedEvents = {
     onInitialized?: ((e: InitializedEvent) => void);
     onValueChanged?: ((e: ValueChangedEvent) => void);
 };
-declare type IHtmlEditorOptions = React.PropsWithChildren<ReplaceFieldTypes<Properties, IHtmlEditorOptionsNarrowedEvents> & IHtmlOptions & {
+type IHtmlEditorOptions = React.PropsWithChildren<ReplaceFieldTypes<Properties, IHtmlEditorOptionsNarrowedEvents> & IHtmlOptions & {
     defaultValue?: any;
     onValueChange?: (value: any) => void;
 }>;
-declare class HtmlEditor extends BaseComponent<React.PropsWithChildren<IHtmlEditorOptions>> {
-    get instance(): dxHtmlEditor;
-    protected _WidgetClass: typeof dxHtmlEditor;
-    protected subscribableOptions: string[];
-    protected independentEvents: string[];
-    protected _defaults: {
-        defaultValue: string;
-    };
-    protected _expectedChildren: {
-        imageUpload: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        mediaResizing: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        mention: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        tableContextMenu: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        tableResizing: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        toolbar: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        variables: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
+interface HtmlEditorRef {
+    instance: () => dxHtmlEditor;
 }
-declare type IFileUploaderOptionsProps = React.PropsWithChildren<{
+declare const HtmlEditor: (props: React.PropsWithChildren<IHtmlEditorOptions> & {
+    ref?: Ref<HtmlEditorRef>;
+}) => ReactElement | null;
+type IFileUploaderOptionsProps = React.PropsWithChildren<{
     abortUpload?: ((file: any, uploadInfo?: UploadInfo) => any);
     accept?: string;
     accessKey?: string;
@@ -146,33 +113,18 @@ declare type IFileUploaderOptionsProps = React.PropsWithChildren<{
     defaultValue?: Array<any>;
     onValueChange?: (value: Array<any>) => void;
 }>;
-declare class FileUploaderOptions extends NestedOption<IFileUploaderOptionsProps> {
-    static OptionName: string;
-    static DefaultsProps: {
-        defaultValue: string;
-    };
-}
-declare type IImageUploadProps = React.PropsWithChildren<{
+declare const _componentFileUploaderOptions: React.MemoExoticComponent<(props: IFileUploaderOptionsProps) => React.FunctionComponentElement<IFileUploaderOptionsProps>>;
+declare const FileUploaderOptions: typeof _componentFileUploaderOptions & IElementDescriptor;
+type IImageUploadProps = React.PropsWithChildren<{
     fileUploaderOptions?: dxFileUploaderOptions;
     fileUploadMode?: "base64" | "server" | "both";
     tabs?: Array<dxHtmlEditorImageUploadTabItem | "url" | "file">;
     uploadDirectory?: string;
     uploadUrl?: string;
 }>;
-declare class ImageUpload extends NestedOption<IImageUploadProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        fileUploaderOptions: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        tab: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type IItemProps = React.PropsWithChildren<{
+declare const _componentImageUpload: React.MemoExoticComponent<(props: IImageUploadProps) => React.FunctionComponentElement<IImageUploadProps>>;
+declare const ImageUpload: typeof _componentImageUpload & IElementDescriptor;
+type IItemProps = React.PropsWithChildren<{
     beginGroup?: boolean;
     closeMenuOnClick?: boolean;
     disabled?: boolean;
@@ -197,29 +149,18 @@ declare type IItemProps = React.PropsWithChildren<{
     widget?: "dxAutocomplete" | "dxButton" | "dxButtonGroup" | "dxCheckBox" | "dxDateBox" | "dxDropDownButton" | "dxMenu" | "dxSelectBox" | "dxSwitch" | "dxTabs" | "dxTextBox";
     render?: (...params: any) => React.ReactNode;
     component?: React.ComponentType<any>;
-    keyFn?: (data: any) => string;
     menuItemRender?: (...params: any) => React.ReactNode;
     menuItemComponent?: React.ComponentType<any>;
-    menuItemKeyFn?: (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 IMediaResizingProps = React.PropsWithChildren<{
+declare const _componentItem: React.MemoExoticComponent<(props: IItemProps) => React.FunctionComponentElement<IItemProps>>;
+declare const Item: typeof _componentItem & IElementDescriptor;
+type IMediaResizingProps = React.PropsWithChildren<{
     allowedTargets?: Array<string>;
     enabled?: boolean;
 }>;
-declare class MediaResizing extends NestedOption<IMediaResizingProps> {
-    static OptionName: string;
-}
-declare type IMentionProps = React.PropsWithChildren<{
+declare const _componentMediaResizing: React.MemoExoticComponent<(props: IMediaResizingProps) => React.FunctionComponentElement<IMediaResizingProps>>;
+declare const MediaResizing: typeof _componentMediaResizing & IElementDescriptor;
+type IMentionProps = React.PropsWithChildren<{
     dataSource?: Array<any> | DataSource | DataSourceOptions | null | Store | string;
     displayExpr?: ((item: any) => string) | string;
     itemTemplate?: ((itemData: any, itemIndex: number, itemElement: any) => string | any) | template;
@@ -235,46 +176,23 @@ declare type IMentionProps = React.PropsWithChildren<{
     valueExpr?: (() => void) | string;
     itemRender?: (...params: any) => React.ReactNode;
     itemComponent?: React.ComponentType<any>;
-    itemKeyFn?: (data: any) => string;
     render?: (...params: any) => React.ReactNode;
     component?: React.ComponentType<any>;
-    keyFn?: (data: any) => string;
 }>;
-declare class Mention extends NestedOption<IMentionProps> {
-    static OptionName: string;
-    static IsCollectionItem: boolean;
-    static TemplateProps: {
-        tmplOption: string;
-        render: string;
-        component: string;
-        keyFn: string;
-    }[];
-}
-declare type ITabProps = React.PropsWithChildren<{
+declare const _componentMention: React.MemoExoticComponent<(props: IMentionProps) => React.FunctionComponentElement<IMentionProps>>;
+declare const Mention: typeof _componentMention & IElementDescriptor;
+type ITabProps = React.PropsWithChildren<{
     name?: "url" | "file";
 }>;
-declare class Tab extends NestedOption<ITabProps> {
-    static OptionName: string;
-    static IsCollectionItem: boolean;
-}
-declare type ITableContextMenuProps = React.PropsWithChildren<{
+declare const _componentTab: React.MemoExoticComponent<(props: ITabProps) => React.FunctionComponentElement<ITabProps>>;
+declare const Tab: typeof _componentTab & IElementDescriptor;
+type ITableContextMenuProps = React.PropsWithChildren<{
     enabled?: boolean;
     items?: Array<dxHtmlEditorTableContextMenuItem | "background" | "bold" | "color" | "font" | "italic" | "link" | "image" | "strike" | "subscript" | "superscript" | "underline" | "blockquote" | "increaseIndent" | "decreaseIndent" | "orderedList" | "bulletList" | "alignLeft" | "alignCenter" | "alignRight" | "alignJustify" | "codeBlock" | "variable" | "undo" | "redo" | "clear" | "insertTable" | "insertHeaderRow" | "insertRowAbove" | "insertRowBelow" | "insertColumnLeft" | "insertColumnRight" | "deleteColumn" | "deleteRow" | "deleteTable" | "cellProperties" | "tableProperties">;
 }>;
-declare class TableContextMenu extends NestedOption<ITableContextMenuProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        item: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        tableContextMenuItem: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type ITableContextMenuItemProps = React.PropsWithChildren<{
+declare const _componentTableContextMenu: React.MemoExoticComponent<(props: ITableContextMenuProps) => React.FunctionComponentElement<ITableContextMenuProps>>;
+declare const TableContextMenu: typeof _componentTableContextMenu & IElementDescriptor;
+type ITableContextMenuItemProps = React.PropsWithChildren<{
     beginGroup?: boolean;
     closeMenuOnClick?: boolean;
     disabled?: boolean;
@@ -288,45 +206,24 @@ declare type ITableContextMenuItemProps = React.PropsWithChildren<{
     visible?: boolean;
     render?: (...params: any) => React.ReactNode;
     component?: React.ComponentType<any>;
-    keyFn?: (data: any) => string;
 }>;
-declare class TableContextMenuItem extends NestedOption<ITableContextMenuItemProps> {
-    static OptionName: string;
-    static IsCollectionItem: boolean;
-    static TemplateProps: {
-        tmplOption: string;
-        render: string;
-        component: string;
-        keyFn: string;
-    }[];
-}
-declare type ITableResizingProps = React.PropsWithChildren<{
+declare const _componentTableContextMenuItem: React.MemoExoticComponent<(props: ITableContextMenuItemProps) => React.FunctionComponentElement<ITableContextMenuItemProps>>;
+declare const TableContextMenuItem: typeof _componentTableContextMenuItem & IElementDescriptor;
+type ITableResizingProps = React.PropsWithChildren<{
     enabled?: boolean;
     minColumnWidth?: number;
     minRowHeight?: number;
 }>;
-declare class TableResizing extends NestedOption<ITableResizingProps> {
-    static OptionName: string;
-}
-declare type IToolbarProps = React.PropsWithChildren<{
+declare const _componentTableResizing: React.MemoExoticComponent<(props: ITableResizingProps) => React.FunctionComponentElement<ITableResizingProps>>;
+declare const TableResizing: typeof _componentTableResizing & IElementDescriptor;
+type IToolbarProps = React.PropsWithChildren<{
     container?: any | string;
     items?: Array<dxHtmlEditorToolbarItem | "background" | "bold" | "color" | "font" | "italic" | "link" | "image" | "size" | "strike" | "subscript" | "superscript" | "underline" | "blockquote" | "header" | "increaseIndent" | "decreaseIndent" | "orderedList" | "bulletList" | "alignLeft" | "alignCenter" | "alignRight" | "alignJustify" | "codeBlock" | "variable" | "separator" | "undo" | "redo" | "clear" | "cellProperties" | "tableProperties" | "insertTable" | "insertHeaderRow" | "insertRowAbove" | "insertRowBelow" | "insertColumnLeft" | "insertColumnRight" | "deleteColumn" | "deleteRow" | "deleteTable">;
     multiline?: boolean;
 }>;
-declare class Toolbar extends NestedOption<IToolbarProps> {
-    static OptionName: string;
-    static ExpectedChildren: {
-        item: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-        toolbarItem: {
-            optionName: string;
-            isCollectionItem: boolean;
-        };
-    };
-}
-declare type IToolbarItemProps = React.PropsWithChildren<{
+declare const _componentToolbar: React.MemoExoticComponent<(props: IToolbarProps) => React.FunctionComponentElement<IToolbarProps>>;
+declare const Toolbar: typeof _componentToolbar & IElementDescriptor;
+type IToolbarItemProps = React.PropsWithChildren<{
     acceptedValues?: Array<boolean | number | string>;
     cssClass?: string;
     disabled?: boolean;
@@ -345,29 +242,18 @@ 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 type IVariablesProps = React.PropsWithChildren<{
+declare const _componentToolbarItem: React.MemoExoticComponent<(props: IToolbarItemProps) => React.FunctionComponentElement<IToolbarItemProps>>;
+declare const ToolbarItem: typeof _componentToolbarItem & IElementDescriptor;
+type IVariablesProps = React.PropsWithChildren<{
     dataSource?: Array<string> | DataSource | DataSourceOptions | null | Store | string;
     escapeChar?: Array<string> | string;
 }>;
-declare class Variables extends NestedOption<IVariablesProps> {
-    static OptionName: string;
-}
+declare const _componentVariables: React.MemoExoticComponent<(props: IVariablesProps) => React.FunctionComponentElement<IVariablesProps>>;
+declare const Variables: typeof _componentVariables & IElementDescriptor;
 export default HtmlEditor;
-export { HtmlEditor, IHtmlEditorOptions, FileUploaderOptions, IFileUploaderOptionsProps, ImageUpload, IImageUploadProps, Item, IItemProps, MediaResizing, IMediaResizingProps, Mention, IMentionProps, Tab, ITabProps, TableContextMenu, ITableContextMenuProps, TableContextMenuItem, ITableContextMenuItemProps, TableResizing, ITableResizingProps, Toolbar, IToolbarProps, ToolbarItem, IToolbarItemProps, Variables, IVariablesProps };
+export { HtmlEditor, IHtmlEditorOptions, HtmlEditorRef, FileUploaderOptions, IFileUploaderOptionsProps, ImageUpload, IImageUploadProps, Item, IItemProps, MediaResizing, IMediaResizingProps, Mention, IMentionProps, Tab, ITabProps, TableContextMenu, ITableContextMenuProps, TableContextMenuItem, ITableContextMenuItemProps, TableResizing, ITableResizingProps, Toolbar, IToolbarProps, ToolbarItem, IToolbarItemProps, Variables, IVariablesProps };
 import type * as HtmlEditorTypes from 'devextreme/ui/html_editor_types';
 export { HtmlEditorTypes };