devextreme-react
Version:
DevExtreme React UI and Visualization Components
89 lines (87 loc) • 4.17 kB
TypeScript
/*!
* devextreme-react
* Version: 25.1.6
* Build date: Mon Oct 13 2025
*
* Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file in the root of the project for details.
*
* https://github.com/DevExpress/devextreme-react
*/
export { ExplicitTypes } from "devextreme/ui/box";
import * as React from "react";
import { Ref, ReactElement } from "react";
import dxBox, { Properties } from "devextreme/ui/box";
import { IHtmlOptions, NestedComponentMeta } from "./core/component";
import type { dxBoxItem, ContentReadyEvent, DisposingEvent, InitializedEvent, ItemClickEvent, ItemContextMenuEvent, ItemHoldEvent, ItemRenderedEvent, dxBoxOptions } from "devextreme/ui/box";
import type { CollectionWidgetItem } from "devextreme/ui/collection/ui.collection_widget.base";
import type { template } from "devextreme/common";
type ReplaceFieldTypes<TSource, TReplacement> = {
[P in keyof TSource]: P extends keyof TReplacement ? TReplacement[P] : TSource[P];
};
type IBoxOptionsNarrowedEvents<TItem = any, TKey = any> = {
onContentReady?: ((e: ContentReadyEvent<TItem, TKey>) => void);
onDisposing?: ((e: DisposingEvent<TItem, TKey>) => void);
onInitialized?: ((e: InitializedEvent<TItem, TKey>) => void);
onItemClick?: ((e: ItemClickEvent<TItem, TKey>) => void);
onItemContextMenu?: ((e: ItemContextMenuEvent<TItem, TKey>) => void);
onItemHold?: ((e: ItemHoldEvent<TItem, TKey>) => void);
onItemRendered?: ((e: ItemRenderedEvent<TItem, TKey>) => void);
};
type IBoxOptions<TItem = any, TKey = any> = React.PropsWithChildren<ReplaceFieldTypes<Properties<TItem, TKey>, IBoxOptionsNarrowedEvents<TItem, TKey>> & IHtmlOptions & {
dataSource?: Properties<TItem, TKey>["dataSource"];
itemRender?: (...params: any) => React.ReactNode;
itemComponent?: React.ComponentType<any>;
defaultItems?: Array<any | dxBoxItem | string>;
onItemsChange?: (value: Array<any | dxBoxItem | string>) => void;
}>;
interface BoxRef<TItem = any, TKey = any> {
instance: () => dxBox<TItem, TKey>;
}
declare const Box: <TItem = any, TKey = any>(props: ReplaceFieldTypes<Properties<TItem, TKey>, IBoxOptionsNarrowedEvents<TItem, TKey>> & IHtmlOptions & {
dataSource?: import("devextreme/data/data_source").DataSourceLike<TItem, TKey> | null | undefined;
itemRender?: ((...params: any) => React.ReactNode) | undefined;
itemComponent?: React.ComponentType<any> | undefined;
defaultItems?: any[] | undefined;
onItemsChange?: ((value: Array<any | dxBoxItem | string>) => void) | undefined;
} & {
children?: React.ReactNode;
} & {
ref?: React.Ref<BoxRef<TItem, TKey>> | undefined;
}) => ReactElement | null;
type IItemProps = React.PropsWithChildren<{
baseSize?: number | string;
box?: dxBoxOptions | undefined;
disabled?: boolean;
html?: string;
ratio?: number;
shrink?: number;
template?: ((itemData: CollectionWidgetItem, itemIndex: number, itemElement: any) => string | any) | template;
text?: string;
visible?: boolean;
render?: (...params: any) => React.ReactNode;
component?: React.ComponentType<any>;
}>;
declare const Item: ((props: IItemProps) => React.FunctionComponentElement<React.PropsWithChildren<{
baseSize?: string | number | undefined;
box?: dxBoxOptions | undefined;
disabled?: boolean | undefined;
html?: string | undefined;
ratio?: number | undefined;
shrink?: number | undefined;
template?: template | ((itemData: CollectionWidgetItem, itemIndex: number, itemElement: any) => string | any) | undefined;
text?: string | undefined;
visible?: boolean | undefined;
render?: ((...params: any) => React.ReactNode) | undefined;
component?: React.ComponentType<any> | undefined;
} & {
children?: React.ReactNode;
} & {
elementDescriptor: import("./core/configuration/react/element").IElementDescriptor;
}>>) & NestedComponentMeta;
export default Box;
export { Box, IBoxOptions, BoxRef, Item, IItemProps };
import type * as BoxTypes from 'devextreme/ui/box_types';
export { BoxTypes };