@progress/kendo-react-grid/utils/index.d.ts

React Data Grid (Table) provides 100+ ready-to-use data grid features. KendoReact Grid package

/**
 * @license
 *-------------------------------------------------------------------------------------------
 * Copyright © 2026 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the package root for more information
 *-------------------------------------------------------------------------------------------
 */
import { GridProps } from '../interfaces/GridProps.js';
import { ExtendedColumnProps } from '../GridColumn.js';
import { DataResult, GroupDescriptor, SortDescriptor } from '@progress/kendo-data-query';
import { GridRowType } from '../interfaces/GridRowType.js';
import { GridColumnProps } from '../interfaces/GridColumnProps.js';
import { DetailExpandDescriptor, GroupExpandDescriptor, GroupState } from '@progress/kendo-react-data-tools';
import { GridCellsSettings } from '../interfaces/GridCellsSettings.js';
import { GridContextMenuItemNames } from '../contextMenu/enums.js';
import { GridDetailExpandableSettings } from '../interfaces/GridDetailExpandableSettings.js';
import { GridCellProps } from '../interfaces/GridCellProps.js';
import { GridRowSpannableSettings } from '../interfaces/GridRowSpannableSettings.js';
import { GridRowReorderSettings } from '../interfaces/GridRowReorderSettings.js';
import { GridColumnState } from '../interfaces/GridColumnState.js';
import * as React from 'react';
/**
 * @hidden
 */
export declare function getNestedValue(fieldName: string | undefined, dataItem: any): any;
/**
 * @hidden
 */
export interface DataItemWrapper {
    dataItem: any;
    rowType: GridRowType;
    level: number;
    expanded: boolean;
    dataIndex: number;
    group?: GroupState;
}
/**
 * @hidden
 */
export declare function flatData(output: Array<DataItemWrapper>, input: Array<any>, footer: 'always' | 'visible' | 'none', dataIndex: {
    index: number;
}, groupDefined: boolean, expand?: DetailExpandDescriptor, groupExpand?: GroupExpandDescriptor[], defaultGroupExpand?: boolean, dataItemKey?: string, level?: number, parentGroup?: GroupState | undefined): number;
/**
 * @hidden
 */
export declare function syncLockedColumns(columns: Array<{
    locked?: boolean;
    index: number;
}>, columnsState: GridColumnState[]): void;
/**
 * @hidden
 */
export declare const getColSpan: (column: GridColumnProps, dataItem: any) => number;
/**
 * @hidden
 */
export declare function checkPropCompatibility(props: GridProps): void;
/**
 * @hidden
 */
export declare function mapColumns(columns: Array<{
    parentIndex: number;
    rowSpan: number;
    depth: number;
    kFirst?: boolean;
    children: any[];
    headerColSpan: number;
    width?: string | number;
    locked?: boolean;
    index: number;
    left: number;
    right: number;
    rightBorder: boolean;
    ariaColumnIndex: number;
}>, columnsState: GridColumnState[], changedColumnLength?: boolean): number[][];
/**
 * @hidden
 */
export declare function readColumns(elements: (React.ReactNode | React.ReactElement | GridColumnProps)[], columnsState: GridColumnState[], idInfo: {
    prevId: number;
    idPrefix: string;
}, depth?: number, parentHidden?: boolean): ExtendedColumnProps[];
/**
 * @hidden
 */
export declare const getDataAsArray: (data: any[] | DataResult | null | undefined) => any[];
/**
 * @hidden
 */
export declare function autoGenerateColumns(data: any[] | DataResult | null | undefined, group: GroupDescriptor[] | undefined, expandable: GridDetailExpandableSettings, idInfo: {
    prevId: number;
    idPrefix: string;
}): ExtendedColumnProps[];
/**
 * @hidden
 */
export declare const footerColumns: (columns: ExtendedColumnProps[]) => ExtendedColumnProps[];
/**
 * @hidden
 */
export declare const getColumnWidth: (column: ExtendedColumnProps) => string | undefined;
/**
 * @hidden
 */
export declare const isSorted: (field: string | undefined, sort?: SortDescriptor[]) => boolean | undefined;
/**
 * @hidden
 */
export declare const sanitizeColumns: (columns: ExtendedColumnProps[]) => GridColumnProps[];
/**
 * @hidden
 */
export declare const clientColumn: (column: ExtendedColumnProps) => ExtendedColumnProps;
/**
 * @hidden
 */
export declare const getColumnState: (column: ExtendedColumnProps) => GridColumnState;
/**
 * @hidden
 */
export declare const getColumnsState: (columns: ExtendedColumnProps[]) => GridColumnState[];
/**
 * @hidden
 */
export declare const getFlatColumnsState: (state: GridColumnState[]) => GridColumnState[];
/**
 * @hidden
 */
export declare const firefox: boolean;
/**
 * @hidden
 */
export declare const firefoxMaxHeight = 17895697;
/**
 * @hidden
 */
export declare const getDefaultHeadContextMenuItems: (options: {
    pdf?: boolean;
    sortable?: boolean;
    selectable?: boolean;
    editable?: boolean;
    reorderable?: boolean;
    clipboard?: boolean;
}) => GridContextMenuItemNames[];
/**
 * @hidden
 */
export declare const getDefaultBodyContextMenuItems: (options: {
    pdf?: boolean;
    sortable?: boolean;
    selectable?: boolean;
    editable?: boolean;
    rowReorderable?: boolean;
    clipboard?: boolean;
}) => GridContextMenuItemNames[];
/**
 * @hidden
 */
export declare const resolveCells: (gridCells?: GridCellsSettings, columnCells?: GridCellsSettings) => GridCellsSettings | undefined;
/**
 * @hidden
 */
export declare const isRowReorderEnabled: (rowReorderable?: GridRowReorderSettings | boolean) => boolean;
/**
 * @hidden
 */
export declare const isClient: () => boolean;
/**
 * @hidden
 */
export declare const isClientReference: (component: any) => boolean;
/**
 * @hidden
 */
export declare const getClientCellProps: (props: GridCellProps) => GridCellProps;
/**
 * @hidden
 */
export declare const getRowSpanOptions: (rowSpannable?: boolean | GridRowSpannableSettings) => Required<GridRowSpannableSettings>;
/** @hidden */
export declare const getReactElement: (children: React.ReactElement<any> | undefined) => React.ReactElement<any>;
/** @hidden */
export declare const cloneReactElement: (children: React.ReactElement<any>, props: any) => React.ReactElement<any, string | React.JSXElementConstructor<any>> | null;
/** @hidden */
export declare const calcRowHeight: (tableBody: HTMLTableSectionElement | null) => number;