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

package/group-expansion/groupExpandReducer.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { TableGroupExpandableSettings } from './TableGroupExpandableSettings.js';
+/**
+ * The descriptor used to define the expanded state of a group.
+ */
+export type GroupExpandDescriptor = {
+    value: any;
+    field: string;
+    expanded?: boolean;
+    groups?: GroupExpandDescriptor[];
+};
+/** @hidden */
+export declare enum GROUP_EXPAND_ACTION {
+    TOGGLE = "GROUP-EXPAND_TOGGLE",
+    EXPAND = "GROUP-EXPAND_EXPAND",
+    COLLAPSE = "GROUP-EXPAND_COLLAPSE",
+    RESET = "GROUP-EXPAND_RESET"
+}
+/** @hidden */
+export type GroupExpandAction = {
+    type: GROUP_EXPAND_ACTION;
+    group: GroupState;
+};
+/** @hidden */
+export type GroupState = {
+    value: any;
+    field: string;
+    expanded?: boolean;
+    parents?: GroupState[];
+};
+/** @hidden */
+export declare const getGroupExpandableOptions: (groupExpandable?: boolean | TableGroupExpandableSettings) => TableGroupExpandableSettings;
+/** @hidden */
+export declare const findGroupExpand: (groupExpand: GroupExpandDescriptor[], group: GroupState) => GroupExpandDescriptor | undefined;
+/** @hidden */
+export declare const isExpanded: (groupExpand: GroupExpandDescriptor[], group: GroupState) => boolean;
+/** @hidden */
+export declare const flatToTree: (flat: GroupState[]) => GroupExpandDescriptor[];
+/** @hidden */
+export declare const groupExpandReducer: (state: GroupExpandDescriptor[], action: GroupExpandAction, options?: TableGroupExpandableSettings) => GroupExpandDescriptor[];

package/header/CellProps.d.ts

@@ -0,0 +1,83 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import * as React from 'react';
+export interface CellProps {
+    /**
+     * @hidden
+     */
+    id: string;
+    /**
+     * The index applied to the `aria-colindex` attribute.
+     */
+    ariaColumnIndex: number;
+    /**
+     * Indicates if the cell is selected.
+     */
+    isSelected: boolean;
+    /** @hidden */
+    isHighlighted?: boolean;
+    /** @hidden */
+    isInEdit?: boolean;
+    /**
+     * Indicates if the cell is sorted.
+     */
+    isSorted?: boolean;
+    /**
+     * Indicates if the cell is alt.
+     */
+    isAlt?: boolean;
+    /**
+     * Indicates if the cell is expanded.
+     */
+    expanded?: boolean;
+    /**
+     * Custom CSS classes for the cell.
+     */
+    className?: string;
+    /**
+     * Inline styles for the cell.
+     */
+    style?: React.CSSProperties;
+    /**
+     * The data field that the cell binds to.
+     */
+    field?: string;
+    /**
+     * The data item for the current row.
+     */
+    dataItem: any;
+    /**
+     * The format applied to the value before display.
+     * Takes the `{0:format}` form where `format` is a standard number format, a custom number format,
+     * a standard date format, or a custom date format.
+     */
+    format?: string;
+    /**
+     * The column span of the cell.
+     */
+    colSpan?: number;
+    /**
+     * Fires when the cell is selected.
+     */
+    selectionChange?: (event: {
+        syntheticEvent: React.SyntheticEvent<any>;
+    }) => void;
+    /**
+     * Fires when the cell value changes.
+     */
+    onChange?: (event: {
+        dataItem: any;
+        syntheticEvent: React.SyntheticEvent<any>;
+        field?: string;
+        value?: any;
+    }) => void;
+    /**
+     * Overrides the default cell rendering.
+     */
+    render?: (defaultRendering: React.ReactElement<HTMLTableCellElement> | null, props: CellProps) => React.ReactElement<HTMLTableCellElement> | null;
+}

package/header/ColumnProps.d.ts

@@ -0,0 +1,167 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { ComponentType } from 'react';
+import { HeaderCellProps } from './HeaderCell.js';
+import { CellProps } from './CellProps.js';
+import { FilterCellProps } from '../filteringCells/FilterCellProps.js';
+import { ColumnSortSettings } from './SortSettings.js';
+import { ColumnMenuProps } from '../columnmenu/index.js';
+export interface ColumnBaseProps<C = CellProps> {
+    /**
+     * Sets the data field that the column binds to.
+     */
+    field?: string;
+    /**
+     * Sets the column header text.
+     */
+    title?: string;
+    /**
+     * Enables header click to emit the `sortChange` event. Handle `sortChange` to sort the data.
+     *
+     * @default true
+     */
+    sortable?: boolean | ColumnSortSettings;
+    /**
+     * Sets the width of the column (in pixels).
+     */
+    width?: string | number;
+    /**
+     * Indicates that the header selection checkbox is checked when `true`.
+     */
+    headerSelectionValue?: boolean;
+    /**
+     * Applies a format to the value before display.
+     * Takes the `{0:format}` form where `format` is a standard number format, a custom number format,
+     * a standard date format, or a custom date format. For more information on supported formats see the
+     * [kendo-intl](https://github.com/telerik/kendo-intl/blob/develop/docs/index.md) documentation.
+     */
+    format?: string;
+    /**
+     * Sets custom CSS classes on the header cell.
+     */
+    headerClassName?: string;
+    /**
+     * Sets custom CSS classes on the column cells.
+     */
+    className?: string;
+    /**
+     * Enables column resizing when `true`.
+     *
+     * @default true
+     */
+    resizable?: boolean;
+    /**
+     * Enables column reordering when `true`.
+     *
+     * @default true
+     */
+    reorderable?: boolean;
+    /**
+     * Disables the ability to reorder when another column is dragged over it or tried to be reordered with keyboard.
+     *
+     * @default false
+     */
+    disableReorder?: boolean;
+    /**
+     * Sets the minimum resize width (in pixels).
+     *
+     * @default 10
+     */
+    minResizableWidth?: number;
+    /**
+     * Determines the column position. Smaller `orderIndex` values render first.
+     *
+     * @default 0
+     */
+    orderIndex?: number;
+    /**
+     * Sets the column id for distinguishing columns (multi header, resize, or keyboard navigation scenarios).
+     * Also used as the unique key for rendering cells. If not set, a unique id is generated.
+     */
+    id?: string;
+    /**
+     * Defines the component rendered as a cell. If not set, a `Cell` renders.
+     */
+    cell?: ComponentType<C>;
+    /**
+     * @hidden
+     */
+    navigatable?: boolean;
+    /**
+     * @hidden
+     */
+    locked?: boolean;
+}
+/**
+ * @hidden
+ */
+export interface TreeColumnBaseProps<C = CellProps, H = HeaderCellProps, F = FilterCellProps> extends ColumnBaseProps<C> {
+    /**
+     * A collection of child columns.
+     */
+    children?: TreeColumnBaseProps<C, H, F>[];
+    /**
+     * The column menu component. Pass the [ColumnMenuTextColumn](https://www.telerik.com/kendo-react-ui/components/datatools/api/columnmenutextcolumn),
+     * [ColumnMenuNumericColumn](https://www.telerik.com/kendo-react-ui/components/datatools/api/columnmenunumericcolumn),
+     * [ColumnMenuDateColumn](https://www.telerik.com/kendo-react-ui/components/datatools/api/columnmenudatecolumn),
+     * [ColumnMenuBooleanColumn](https://www.telerik.com/kendo-react-ui/components/datatools/api/columnmenubooleancolumn)
+     * or a custom component base on the type of the column data.
+     */
+    columnMenu?: React.ComponentType<ColumnMenuProps>;
+    /**
+     * If set to `true`, the column will render the icons that are used for expanding and collapsing child rows.
+     */
+    expandable?: boolean;
+    /**
+     * Defines the component that will be rendered as an edit cell.
+     */
+    editCell?: ComponentType<C>;
+    /**
+     * Defines the component that will be rendered as a header cell.
+     * If not set, a `HeaderCell` will be rendered by default.
+     */
+    headerCell?: ComponentType<H>;
+    /**
+     * **Deprecated**. Use `filterCell` prop instead.
+     */
+    filter?: ComponentType<F>;
+    /**
+     * Defines the component that will be rendered as a filter cell.
+     */
+    filterCell?: ComponentType<F>;
+}
+/**
+ * @hidden
+ */
+export interface ExtendedColumnProps<C = CellProps, H = HeaderCellProps, F = FilterCellProps> extends TreeColumnBaseProps<C, H, F> {
+    declarationIndex: number;
+    parentIndex: number;
+    colSpan: number;
+    rowSpan: number;
+    depth: number;
+    kFirst?: boolean;
+    index: number;
+    children: ExtendedColumnProps<C, H, F>[];
+    left: number;
+    right: number;
+    rightBorder: boolean;
+    groupable: boolean;
+    ariaColumnIndex: number;
+    isAccessible: boolean;
+}
+/**
+ * @hidden
+ */
+export declare const ColumnDefaultProps: {
+    filterable: boolean;
+    editable: boolean;
+    sortable: boolean;
+    resizable: boolean;
+    reorderable: boolean;
+    groupable: boolean;
+};

package/header/FilterRow.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { FilterDescriptor, SortDescriptor } from '@progress/kendo-data-query';
+import { ExtendedColumnProps } from './ColumnProps.js';
+import * as React from 'react';
+/**
+ * @hidden
+ */
+export declare const FILTER_ROW_CLASS = "k-table-row k-filter-row";
+/**
+ * @hidden
+ */
+export interface FilterRowProps {
+    columns: ExtendedColumnProps[];
+    filter?: FilterDescriptor[];
+    filterChange: (event: {
+        filter: FilterDescriptor[];
+        field: string;
+        syntheticEvent: React.SyntheticEvent<any>;
+    }) => void;
+    sort?: SortDescriptor[];
+    ariaRowIndex?: number;
+}
+/**
+ * @hidden
+ */
+export declare const FilterRow: (props: FilterRowProps) => React.JSX.Element;

package/header/Header.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { ColumnResize } from './../drag/ColumnResize.js';
+import * as React from 'react';
+/**
+ * @hidden
+ */
+export interface HeaderProps {
+    headerRow: React.ReactElement<any>;
+    filterRow?: React.ReactElement<any>;
+    columnResize?: ColumnResize;
+    reorderable?: boolean;
+}
+/**
+ * @hidden
+ */
+export declare class Header extends React.Component<HeaderProps> {
+    private element;
+    componentDidMount(): void;
+    render(): React.JSX.Element;
+}

package/header/HeaderCell.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import * as React from 'react';
+/**
+ * @hidden
+ */
+export interface HeaderCellBaseProps {
+    /**
+     * The column field in which the cell is located.
+     */
+    field?: string;
+    /**
+     * The title of the column in which the cell is located.
+     */
+    title?: string;
+    /**
+     * The `click` event handler of the cell.
+     */
+    onClick?: any;
+    /**
+     * The `selectionChange` event handler of the cell.
+     */
+    selectionChange: any;
+    /**
+     * The `selectionValue` event handler of the column in which the cell is located.
+     */
+    selectionValue: any;
+    /**
+     * A function for overriding the default rendering of the header cell.
+     */
+    render?: (defaultRendering: React.ReactNode | null, props: HeaderCellBaseProps) => React.ReactNode;
+    /**
+     * The current sort icons.
+     */
+    children: React.ReactNode;
+}
+/**
+ * @hidden
+ */
+export interface HeaderCellProps extends HeaderCellBaseProps {
+    /**
+     * A function for overriding the default rendering of the header cell.
+     */
+    render?: (defaultRendering: React.ReactNode | null, props: HeaderCellProps) => React.ReactNode;
+}
+/**
+ * @hidden
+ */
+export declare function HeaderCell(props: HeaderCellProps): React.JSX.Element;

package/header/HeaderRow.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { SortDescriptor, CompositeFilterDescriptor, FilterDescriptor } from '@progress/kendo-data-query';
+import { TreeColumnBaseProps, ExtendedColumnProps } from './ColumnProps.js';
+import { HeaderCellProps } from './HeaderCell.js';
+import { SortSettings } from './SortSettings.js';
+import { ColumnResize } from '../drag/ColumnResize.js';
+import { ColumnDraggableProps } from '../drag/ColumnDraggable.js';
+import { ColumnMenuProps } from '../columnmenu/index.js';
+import { CellProps } from './CellProps.js';
+import { FilterCellProps } from '../filteringCells/index.js';
+import * as React from 'react';
+/**
+ * @hidden
+ */
+export interface HeaderRowProps<C = CellProps, H = HeaderCellProps, F = FilterCellProps> extends ColumnDraggableProps {
+    sortable?: SortSettings;
+    sortChange?: (e: React.SyntheticEvent<any>, descriptors: SortDescriptor[], field?: string) => void;
+    filterChange?: (e: React.SyntheticEvent<any>, descriptors: FilterDescriptor[], field?: string) => void;
+    sort?: SortDescriptor[];
+    columns: ExtendedColumnProps<C, H, F>[];
+    columnsMap: number[][];
+    selectionChange: (e: any) => void;
+    cellRender?: (defaultRendering: React.ReactNode | null, props: HeaderCellProps) => React.ReactNode;
+    columnResize?: ColumnResize<C, H, F>;
+    columnMenu?: React.ComponentType<ColumnMenuProps>;
+    columnMenuFilter?: CompositeFilterDescriptor[];
+    columnMenuFilterChange?: (e: React.SyntheticEvent<any>, filter: CompositeFilterDescriptor[], field?: string) => void;
+}
+/**
+ * @hidden
+ */
+export declare class HeaderRow<C = CellProps, H = HeaderCellProps, F = FilterCellProps> extends React.Component<HeaderRowProps<C, H, F>, {}> {
+    cellClick: (e: React.MouseEvent<HTMLSpanElement> | React.KeyboardEvent<HTMLElement>, column: TreeColumnBaseProps<C, H, F>) => void;
+    cellKeyDown: (event: React.KeyboardEvent<HTMLElement>, column: TreeColumnBaseProps<C, H, F>) => void;
+    sortIcon(sortIndex: number): (false | React.JSX.Element)[] | null;
+    render(): React.JSX.Element[];
+    private cells;
+}

package/header/HeaderSelectionCell.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { HeaderCellProps } from './HeaderCell.js';
+import * as React from 'react';
+/**
+ * @hidden
+ */
+export interface HeaderSelectionCellProps extends HeaderCellProps {
+    inputId: string;
+}
+/**
+ * @hidden
+ */
+export declare function HeaderSelectionCell(props: HeaderSelectionCellProps): React.JSX.Element;

package/header/HeaderTdElement.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import * as React from 'react';
+export interface HeaderTdElementProps extends React.TdHTMLAttributes<HTMLTableCellElement> {
+    /** ARIA sort state indicating column sorting direction */
+    ariaSort?: 'none' | 'ascending' | 'descending';
+    /** ARIA label for accessibility */
+    ariaLabel?: string;
+    /** ARIA column index for screen readers */
+    ariaColumnIndex?: number;
+    /** ARIA selected state for the header cell */
+    ariaSelected?: boolean;
+    /** ARIA description for additional context */
+    ariaDescription?: string;
+    /** Number of columns the cell spans */
+    colSpan?: number;
+    /** Number of rows the cell spans */
+    rowSpan?: number;
+    /** ARIA role for the element */
+    role?: string;
+    /** Unique identifier for the column */
+    columnId: string;
+    /** CSS class names for styling */
+    className?: string;
+    /** Inline styles for the element */
+    style?: any;
+    /** Child elements to render inside the header cell */
+    children?: any;
+    /** Keyboard event handler */
+    onKeyDown?: any;
+    /** Whether the cell supports keyboard navigation */
+    navigatable?: boolean;
+}
+export declare const HeaderTdElement: {
+    (props: HeaderTdElementProps): React.JSX.Element;
+    displayName: string;
+};

package/header/HeaderThElement.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import * as React from 'react';
+export interface HeaderThElementProps extends React.ThHTMLAttributes<HTMLTableCellElement> {
+    /** ARIA sort state indicating column sorting direction */
+    ariaSort?: 'none' | 'ascending' | 'descending';
+    /** ARIA label for accessibility */
+    ariaLabel?: string;
+    /** ARIA column index for screen readers */
+    ariaColumnIndex?: number;
+    /** ARIA selected state for the header cell */
+    ariaSelected?: boolean;
+    /** ARIA description for additional context */
+    ariaDescription?: string;
+    /** Number of columns the cell spans */
+    colSpan?: number;
+    /** Number of rows the cell spans */
+    rowSpan?: number;
+    /** ARIA role for the element */
+    role?: string;
+    /** Unique identifier for the column */
+    columnId: string;
+    /** CSS class names for styling */
+    className?: string;
+    /** Inline styles for the element */
+    style?: any;
+    /** Child elements to render inside the header cell */
+    children?: any;
+    /** Keyboard event handler */
+    onKeyDown?: any;
+    /** Whether the cell supports keyboard navigation */
+    navigatable?: boolean;
+}
+export declare const HeaderThElement: {
+    (props: HeaderThElementProps): React.JSX.Element;
+    displayName: string;
+};

package/header/SortSettings.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * The settings for sorting the columns of the component.
+ */
+export interface ColumnSortSettings {
+    /**
+     * Enables the removal of the column sorting functionality.
+     */
+    allowUnsort?: boolean;
+}
+/**
+ * The settings for sorting the component data.
+ */
+export type SortSettings = boolean | (ColumnSortSettings & {
+    /**
+     * The sort mode of the component.
+     *
+     * The available modes are:
+     * - `single`
+     * - `multiple`
+     */
+    mode?: 'single' | 'multiple';
+});
+/**
+ * @hidden
+ */
+export declare const normalize: (...settings: (SortSettings | ColumnSortSettings)[]) => any;

package/header/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+export * from './CellProps.js';
+export * from './ColumnProps.js';
+export * from './FilterRow.js';
+export * from './Header.js';
+export * from './HeaderCell.js';
+export * from './HeaderRow.js';
+export * from './HeaderSelectionCell.js';
+export * from './SortSettings.js';
+export * from './utils/index.js';
+export * from './HeaderThElement.js';
+export * from './HeaderTdElement.js';