@progress/kendo-react-grid 13.3.0 → 13.4.0-develop.2

package/interfaces/ColumnType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * Sets the column type.
+ *
+ * @default "data"
+ */
+export type GridColumnType = 'data' | 'reorder' | 'checkbox';

package/interfaces/CompositeHighlightDescriptor.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { CompositeFilterDescriptor, FilterDescriptor } from '@progress/kendo-data-query';
+/**
+ * Represents a composite highlight descriptor for a grid.
+ * It contains a map of cell identifiers to their highlight status,
+ * an array of filter descriptors, and the logical operator used to combine the filters.
+ */
+export interface CompositeHighlightDescriptor {
+    /**
+     * A map of cell identifiers to a boolean indicating whether the cell should be highlighted.
+     */
+    cells: {
+        [key: string]: boolean;
+    };
+    /**
+     * An array of filter descriptors representing the filters applied to the grid.
+     */
+    filters: Array<FilterDescriptor | CompositeFilterDescriptor>;
+    /**
+     * The logical operator ('and' | 'or') used to combine the filters.
+     */
+    logic: 'and' | 'or';
+}

package/interfaces/GridAIAssistantCommand.d.ts

@@ -0,0 +1,110 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { CompositeFilterDescriptor, GroupDescriptor, SortDescriptor } from '@progress/kendo-data-query';
+import { GridAICommands } from './GridAICommands.js';
+import { CompositeHighlightDescriptor } from './CompositeHighlightDescriptor.js';
+/**
+ * Represents a command structure returned by AI services for grid operations.
+ * Each command contains the operation type and relevant configuration data.
+ *
+ * @example
+ * ```tsx
+ * // Sort command example
+ * const sortCommand: GridAIAssistantCommand = {
+ *   type: 'GridSort',
+ *   sort: { field: 'productName', dir: 'asc' },
+ *   message: 'Sorted by Product Name ascending'
+ * };
+ *
+ * // Filter command example
+ * const filterCommand: GridAIAssistantCommand = {
+ *   type: 'GridFilter',
+ *   filter: {
+ *     logic: 'and',
+ *     filters: [{ field: 'price', operator: 'gte', value: 100 }]
+ *   },
+ *   message: 'Filtered products with price >= 100'
+ * };
+ * ```
+ */
+export interface GridAIAssistantCommand {
+    /**
+     * The type of grid operation to perform.
+     * Possible values: 'GridSort', 'GridFilter', 'GridGroup', 'GridHighlight', 'GridClearSort', 'GridClearFilter', 'GridClearGroup', 'GridClearHighlight'
+     */
+    type: GridAICommands;
+    /**
+     * The filename for export operations, including the file extension.
+     * Used when the AI assistant performs export commands such as PDF generation.
+     * Expected data type: string ending with file extension (e.g., '.pdf', '.xlsx').
+     */
+    fileName?: string;
+    /**
+     * The sort descriptor for sorting operations.
+     */
+    sort?: SortDescriptor | SortDescriptor[];
+    /**
+     * The filter descriptor for filtering operations.
+     */
+    filter?: CompositeFilterDescriptor;
+    /**
+     * The group descriptor for grouping operations.
+     */
+    group?: GroupDescriptor | GroupDescriptor[];
+    /**
+     * The highlight descriptor for highlight operations.
+     */
+    highlight?: CompositeHighlightDescriptor;
+    /**
+     * The select descriptor for selection operations.
+     * Used when type is 'GridSelect' to define cell or row selection criteria.
+     *
+     * @example
+     * ```tsx
+     * select: {
+     *   cells: { 'Age': true },
+     *   filters: [{ field: 'Age', operator: 'gt', value: 60 }],
+     *   logic: 'and'
+     * }
+     * ```
+     */
+    select?: CompositeHighlightDescriptor;
+    /**
+     * The message describing the operation.
+     */
+    message?: string;
+    /**
+     * The messages describing the operation (alternative to message).
+     */
+    messages?: string[];
+    /**
+     * The new size value for column resize operations.
+     * Specifies the width dimension when resizing grid columns.
+     */
+    size?: string;
+    /**
+     * The unique identifier of the column to resize.
+     * Used when type is 'GridColumnResize' to specify which column should be resized.
+     */
+    id?: string;
+    /**
+     * The target page number for pagination operations.
+     * Used when type is 'GridPage' to navigate to a specific page.
+     */
+    page?: number;
+    /**
+     * The number of items to display per page for pagination operations.
+     * Used when type is 'GridPageSize' to change the grid's page size.
+     */
+    pageSize?: number;
+    /**
+     * The target position for column reordering operations.
+     * Used when type is 'GridColumnReorder' to specify the new column index.
+     */
+    position?: number;
+}

package/interfaces/GridAICommands.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * Enum defining the available AI command types for grid operations.
+ * These commands control different aspects of grid functionality through AI prompts.
+ *
+ * @example
+ * ```tsx
+ * // Used internally when processing AI responses
+ * const command = {
+ *   type: GridAICommands.GridSort,
+ *   sort: { field: 'name', dir: 'asc' }
+ * };
+ * ```
+ */
+export declare enum GridAICommands {
+    /** Clears all applied filters from the grid */
+    GridClearFilter = "GridClearFilter",
+    /** Clears all applied sorting from the grid */
+    GridClearSort = "GridClearSort",
+    /** Clears all applied grouping from the grid */
+    GridClearGroup = "GridClearGroup",
+    /** Clears all applied highlighting from the grid */
+    GridClearHighlight = "GridClearHighlight",
+    /** Clears all applied selections from the grid */
+    GridClearSelect = "GridClearSelect",
+    /** Applies sorting to grid columns */
+    GridSort = "GridSort",
+    /** Applies filtering to grid data */
+    GridFilter = "GridFilter",
+    /** Applies grouping to grid data */
+    GridGroup = "GridGroup",
+    /** Applies highlighting to grid cells or rows */
+    GridHighlight = "GridHighlight",
+    /** Applies select to grid cells or rows */
+    GridSelect = "GridSelect",
+    /** Exports the grid data as a PDF document */
+    GridExportPDF = "GridExportPDF",
+    /** Resizes grid columns to specified dimensions */
+    GridColumnResize = "GridColumnResize",
+    /** Hides specified grid columns from view */
+    GridColumnHide = "GridColumnHide",
+    /** Shows previously hidden grid columns */
+    GridColumnShow = "GridColumnShow",
+    /** Reorders grid columns to new positions */
+    GridColumnReorder = "GridColumnReorder",
+    /** Locks grid columns to prevent horizontal scrolling */
+    GridColumnLock = "GridColumnLock",
+    /** Unlocks previously locked grid columns */
+    GridColumnUnlock = "GridColumnUnlock",
+    /** Navigates to a specific page number in the grid */
+    GridPage = "GridPage",
+    /** Changes the number of items displayed per page in the grid */
+    GridPageSize = "GridPageSize"
+}

package/interfaces/GridCellProps.d.ts

@@ -0,0 +1,112 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { GridClassStructure } from '@progress/kendo-react-common';
+import { GridCellsSettings } from './GridCellsSettings.js';
+import { GridRowType } from './GridRowType.js';
+import { CellProps, GroupState } from '@progress/kendo-react-data-tools';
+import { GridColumnType } from './ColumnType.js';
+import { IntlService, LocalizationService } from '@progress/kendo-react-intl';
+/**
+ * Represents the props of the GridCell component
+ * ([more information](https://www.telerik.com/kendo-react-ui/components/grid/cells#toc-grid-cells)).
+ */
+export interface GridCellProps extends Omit<CellProps, 'onChange' | 'render'> {
+    /**
+     * The zero-based index of the data item in the data collection.
+     */
+    dataIndex: number;
+    /**
+     * The index of the column in the rendered columns collection. Optional.
+     */
+    columnIndex?: number;
+    /**
+     * The total number of rendered columns in the Grid. Optional.
+     */
+    columnsCount?: number;
+    /**
+     * Defines a set of custom cell components that the Grid will render instead of the default cell.
+     */
+    cells?: GridCellsSettings;
+    /**
+     * Specifies the type of the row (e.g., data row, group header, etc.). Optional.
+     */
+    rowType?: GridRowType;
+    /**
+     * @hidden
+     */
+    level?: number;
+    /**
+     * Triggered when the cell is selected. Provides the event object.
+     */
+    selectionChange?: (event: {
+        syntheticEvent: React.SyntheticEvent<any>;
+    }) => void;
+    /**
+     * Triggered when the cell value is changed. Provides details about the change event.
+     */
+    onChange?: (event: {
+        dataItem: any;
+        dataIndex: number;
+        syntheticEvent: React.SyntheticEvent<any>;
+        field?: string;
+        value?: any;
+        /** @hidden */
+        _expand?: boolean;
+        /** @hidden */
+        _group?: GroupState;
+    }) => void;
+    /**
+     * Specifies the type of editor to be used when the cell is in edit mode.
+     * Supported values are `text`, `numeric`, `boolean`, and `date`.
+     */
+    editor?: 'text' | 'numeric' | 'boolean' | 'date';
+    /**
+     * @hidden
+     */
+    locked?: boolean | undefined;
+    /**
+     * Triggered when the ContextMenu is activated on the cell.
+     * Provides the event object, data item, and field name.
+     */
+    onContextMenu?: (event: React.MouseEvent<HTMLElement>, dataItem: any, field?: string) => void;
+    /**
+     * @hidden
+     */
+    isRtl?: boolean;
+    /**
+     * @hidden
+     */
+    unstyled?: GridClassStructure;
+    /**
+     * @hidden
+     */
+    rowDataIndex?: number;
+    /**
+     * @hidden
+     */
+    columnType?: GridColumnType;
+    /**
+     * @hidden
+     */
+    rowReorderable?: boolean;
+    /**
+     * @hidden
+     */
+    columnPosition: any;
+    /** @hidden */
+    group?: GroupState;
+    /** @hidden */
+    localization?: LocalizationService;
+    /** @hidden */
+    intl?: IntlService;
+    /** @hidden */
+    _rowSpan?: {
+        count: number | null;
+        value: any;
+    };
+}

package/interfaces/GridCellRenderModel.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * @hidden
+ */
+export interface GridCellRenderModel {
+    width: number;
+    colSpan: number;
+    columnIndex: number;
+}