@progress/kendo-vue-grid 8.0.3-develop.2 → 8.0.3-develop.3

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 { 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: FilterDescriptor[];
+    /**
+     * The logical operator ('and' | 'or') used to combine the filters.
+     */
+    logic: 'and' | 'or';
+}

package/interfaces/ExtendedColumnProps.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
+ *-------------------------------------------------------------------------------------------
+ */
+import { GridColumnProps } from './GridColumnProps';
+import { GridRowSpannableSettings } from './GridRowSpannableSettings';
+/**
+ * @hidden
+ */
+export interface ExtendedColumnProps extends GridColumnProps {
+    declarationIndex: number;
+    parentIndex: number;
+    rowSpan: number;
+    depth: number;
+    colSpan: number;
+    kFirst?: boolean;
+    index: number;
+    headerColSpan: number;
+    children: ExtendedColumnProps[];
+    left: number;
+    right: number;
+    rightBorder: boolean;
+    ariaColumnIndex: number;
+    isAccessible: boolean;
+    /** @hidden _internal usage only */
+    _type?: 'edit' | 'expand';
+    rowSpannable?: Required<GridRowSpannableSettings>;
+    defaultCell?: any;
+    defaultHeaderCell?: any;
+}

package/interfaces/GridCellProps.d.ts

@@ -0,0 +1,176 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { GroupState } from '@progress/kendo-vue-data-tools';
+/**
+ * @hidden
+ */
+export interface GridCellProps {
+    /**
+     * @hidden
+     */
+    id: string;
+    /**
+     * The field to which the cell is bound ([see example]({% slug sorting_grid %})).
+     */
+    key?: number;
+    /**
+     * The field to which the cell is bound ([see example]({% slug sorting_grid %})).
+     */
+    field: string;
+    /**
+     * The data object that represents the current row.
+     */
+    dataItem: any;
+    /**
+     *
+     */
+    dataIndex?: number;
+    /**
+     * The format that is applied to the value before the value is displayed. Takes the `{0:format}`
+     * form where `format` is any of the following:
+     * * A standard number format
+     * * A custom number format
+     * * A standard date format
+     * * A custom date format
+     *
+     * For more information on the supported date and number formats,
+     * refer to the [kendo-intl](https://github.com/telerik/kendo-intl/blob/develop/docs/index.md) documentation.
+     */
+    format?: string;
+    /**
+     * The data Item read format.
+     */
+    readFormat?: string;
+    /**
+     * The custom CSS classes of the cells.
+     */
+    className?: string;
+    /**
+     * The index to be applied to the `aria-colindex` attribute.
+     */
+    ariaColumnIndex: number;
+    /**
+     * The index of all rendered columns.
+     */
+    columnIndex?: number;
+    /**
+     * The number of rendered columns in the Grid.
+     */
+    columnsCount?: number;
+    /**
+     * The type of the row.
+     */
+    rowType?: string;
+    /**
+     * @hidden
+     */
+    level?: number;
+    /**
+     * The expanded value of the cell when hierarchy or grouping are used.
+     */
+    expanded?: boolean;
+    /**
+     * The event that is fired when the cell is selected.
+     */
+    selectionchange?: (event: any, dataItem: any) => void;
+    /**
+     * @hidden
+     */
+    style?: any;
+    /**
+     * The column span of the cell.
+     */
+    colSpan?: number;
+    /**
+     * Indicates if the cell is selected.
+     */
+    isSelected: boolean;
+    /**
+     * Indicates if the cell is highlighted.
+     */
+    isHighlighted: boolean;
+    /**
+     * Indicates if the cell is in rtl direction.
+     */
+    isRtl: boolean;
+    /**
+     * The event that is fired when the cell value is changed.
+     */
+    onChange?: (event: {
+        dataItem: any;
+        event: any;
+        field?: string;
+        value?: any;
+    }) => void;
+    /**
+     * The event that is fired when the keydown event of the cell is triggered.
+     */
+    onCellkeydown?: (event: {
+        event: any;
+        dataItem: any;
+        field: string;
+    }) => void;
+    /**
+     * The event that is fired when the cell is clicked.
+     */
+    onCellclick?: (event: {
+        dataItem: any;
+        field: string;
+    }) => void;
+    /**
+     * The event that is fired when the cell is about to be added.
+     */
+    onAdd?: (event: {
+        dataItem: any;
+    }) => void;
+    /**
+     * The event that is fired when the cell is about to be edited.
+     */
+    onEdit?: (event: {
+        dataItem: any;
+    }) => void;
+    /**
+     * The event that is fired when the cell is about to be saved.
+     */
+    save?: (event: {
+        dataItem: any;
+    }) => void;
+    /**
+     * The event that is fired when the cell is about to be removed.
+     */
+    remove?: (event: {
+        dataItem: any;
+    }) => void;
+    /**
+     * The event that is fired when the cell is about to be canceled.
+     */
+    onCancel?: (event: {
+        dataItem: any;
+    }) => void;
+    /**
+     * The type of the data which will be used when formatting the cell data.
+     * Could be one of the following values 'text' | 'numeric' | 'boolean' | 'date'.
+     */
+    type?: string;
+    /**
+     * The type of the editor which will be used when the cell is in edit mode.
+     * Could be one of the following values 'text' | 'numeric' | 'boolean' | 'date'.
+     */
+    editor?: string;
+    /**
+     * The method for rendering the cell.
+     */
+    render?: any;
+    /** @hidden */
+    group?: GroupState;
+    /** @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;
+}

package/interfaces/GridColSpanProps.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { GridColumnProps } from './GridColumnProps';
+/**
+ * Represents the properties of the callback used when spanning a column.
+ */
+export type GridColSpanProps = {
+    /**
+     * Represents the properties of the spanned column.
+     */
+    column: GridColumnProps;
+    /**
+     * Represents the current row data item.
+     */
+    dataItem: any;
+};

package/interfaces/GridColumnChildrenProps.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * The type of elements that the children property of the Grid accepts.
+ */
+export interface GridColumnChildrenProps {
+}

package/interfaces/GridColumnMenuBaseProps.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { GridColumnMenuColumnProps } from './GridColumnMenuColumnProps';
+/**
+ * @hidden
+ */
+export interface GridColumnMenuBaseProps {
+    /**
+     * The current column options.
+     */
+    column: GridColumnMenuColumnProps;
+    /**
+     * The method that will be called to close the column menu.
+     */
+    onClosemenu?: Function;
+}

package/interfaces/GridColumnMenuColumnProps.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * The column props passed by the ColumnMenu.
+ */
+export interface GridColumnMenuColumnProps {
+    /**
+     * The field to which the column is bound.
+     */
+    field?: string;
+    /**
+     * Defines the filter type that is displayed inside the filter row. Defaults to `text`.
+     */
+    filter?: 'text' | 'numeric' | 'boolean' | 'date';
+}

package/interfaces/GridColumnMenuColumnsChooserBaseProps.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { GridColumnMenuBaseProps } from './GridColumnMenuBaseProps';
+import { GridColumnState } from './GridColumnState';
+/**
+ *  The props passed to the ColumnMenu ColumnsChooser component.
+ */
+export interface GridColumnMenuColumnsChooserBaseProps extends GridColumnMenuBaseProps {
+    /**
+     * The columns state of the KendoReact GridColumnMenuColumnsChooser component.
+     */
+    columnsState?: GridColumnState[];
+    /**
+     * The method that will be called when the new columns state is applied.
+     */
+    onColumnsstatechange?: Function;
+}

package/interfaces/GridColumnMenuExtendedFilterProps.d.ts

@@ -0,0 +1,49 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { GridColumnMenuFilterProps } from './GridColumnMenuFilterProps';
+/**
+ * @hidden
+ */
+export interface GridColumnMenuExtendedFilterProps extends GridColumnMenuFilterProps {
+    /**
+     * Allows you to control the expand state of the filter component.
+     */
+    expanded?: boolean;
+    /**
+     * Triggered on each subsequent expand state of the filter component.
+     */
+    onExpandchange?: (nextExpandState: boolean) => void;
+    /**
+     * If set to `false`, the second filter operator and the input will be hidden.
+     */
+    hideSecondFilter?: boolean;
+    /**
+     * Specifies a Vue element that will be cloned and rendered inside the UI of the column-menu filter component.
+     */
+    filterUI?: any;
+}
+/**
+ * @hidden
+ */
+export interface GridColumnMenuBooleanFilterProps extends GridColumnMenuExtendedFilterProps {
+}
+/**
+ * @hidden
+ */
+export interface GridColumnMenuDateFilterProps extends GridColumnMenuExtendedFilterProps {
+}
+/**
+ * @hidden
+ */
+export interface GridColumnMenuNumericFilterProps extends GridColumnMenuExtendedFilterProps {
+}
+/**
+ * @hidden
+ */
+export interface GridColumnMenuTextFilterProps extends GridColumnMenuExtendedFilterProps {
+}

package/interfaces/GridColumnMenuFilterBaseProps.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @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 } from '@progress/kendo-data-query';
+import { PopupAnimation } from '@progress/kendo-vue-popup';
+import { GridColumnMenuColumnProps } from './GridColumnMenuColumnProps';
+import { GridFilterOperators } from './GridFilterOperators';
+/**
+ * The props passed to the ColumnMenu filter component.
+ */
+export interface GridColumnMenuFilterBaseProps {
+    /**
+     * Controls the ColumnMenu animation. By default, the opening and closing animations are enabled.
+     */
+    animate?: boolean | PopupAnimation;
+    /**
+     * The current column options.
+     */
+    column: GridColumnMenuColumnProps;
+    /**
+     * The method that will be called to close the column menu.
+     */
+    onClosemenu?: Function;
+    /**
+     * The current filter state of the Grid.
+     */
+    filter?: CompositeFilterDescriptor;
+    /**
+     * The filterable option of the column.
+     */
+    filterable?: boolean | undefined;
+    /**
+     * The filter operators for the Grid filters.
+     */
+    filterOperators: GridFilterOperators;
+    /**
+     * The template that can customize the check all checkbox item.
+     */
+    checkAllItem?: string | object | Function | boolean;
+    /**
+     * The template that can customize the checkbox item.
+     */
+    item?: string | object | Function | boolean;
+    /**
+     * The trigger focus event.
+     */
+    onFocus?: (e: any) => void;
+    /**
+     * The method that will be called to notify the parent Grid about a filter change.
+     */
+    onFilterchange?: (filter: CompositeFilterDescriptor | null, syntheticEvent: any) => any;
+}

package/interfaces/GridColumnMenuFilterProps.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @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 } from '@progress/kendo-data-query';
+import { GridColumnProps } from './GridColumnProps';
+/**
+ * @hidden
+ */
+export interface GridColumnMenuFilterProps {
+    /**
+     * The current column options.
+     */
+    column: GridColumnProps;
+    /**
+     * The method that will be called to close the column menu.
+     */
+    onCloseMenu?: Function;
+    /**
+     * The current filter state of the Grid.
+     */
+    filter?: CompositeFilterDescriptor;
+    /**
+     * The filterable option of the column.
+     */
+    filterable?: boolean | undefined;
+    /**
+     * The method that will be called to notify the parent Grid about a filter change.
+     */
+    onFilterchange?: (filter: CompositeFilterDescriptor | null, event: any) => any;
+}

package/interfaces/GridColumnMenuFilterUIProps.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { GridFilterCellProps } from './GridFilterCellProps';
+/**
+ * The props that will be passed to the UI of the ColumnMenu filter component.
+ */
+export interface GridColumnMenuFilterUIProps {
+    /**
+     * The options of the first filter.
+     */
+    firstFilterProps: GridFilterCellProps;
+    /**
+     * The options of the second filter.
+     */
+    secondFilterProps: GridFilterCellProps;
+    /**
+     * The current value of the filter logic.
+     */
+    logicValue?: {
+        text: string;
+        operator: any;
+    };
+    /**
+     * The list of the filter logic options.
+     */
+    logicData: {
+        text: string;
+        operator: any;
+    }[];
+    /**
+     * The method that will be called to notify the parent about a change in the filter logic.
+     */
+    onLogicchange?: (e: any) => void;
+    /**
+     * The method that will be called to notify the parent about a change in the filter.
+     */
+    onChange?: (e: any, filterIndex: number) => void;
+    /**
+     * The trigger focus event.
+     */
+    onFocus?: (e: any) => void;
+    /**
+     * Indicates if the second filter will be hidden.
+     */
+    hideSecondFilter?: boolean;
+    /**
+     * The list of the default operators for the current filter type.
+     */
+    operators: Array<{
+        text: string;
+        operator: any;
+    }>;
+    /**
+     * The method for rendering the cell.
+     */
+    render?: any;
+}

package/interfaces/GridColumnMenuGroupBaseProps.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 { GroupDescriptor } from '@progress/kendo-data-query';
+import { GridColumnMenuBaseProps } from './GridColumnMenuBaseProps';
+/**
+ *  The props passed to the ColumnMenu group component.
+ */
+export interface GridColumnMenuGroupBaseProps extends GridColumnMenuBaseProps {
+    /**
+     * The groupable option of the column.
+     */
+    groupable?: boolean;
+    /**
+     * The current group state of the Grid. It takes value of type [GroupDescriptor]({% slug api_kendo-data-query_groupdescriptor %})[]
+     */
+    group?: GroupDescriptor[];
+    /**
+     * The method that will be called to notify the parent Grid about a group change.
+     */
+    onGroupchange?: (groups: GroupDescriptor[], event: any) => void;
+}

package/interfaces/GridColumnMenuProps.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { SVGIcon } from '@progress/kendo-vue-common';
+import { GridColumnMenuFilterBaseProps } from './GridColumnMenuFilterBaseProps';
+import { GridColumnMenuSortBaseProps } from './GridColumnMenuSortBaseProps';
+import { SortDescriptor } from '@progress/kendo-data-query';
+/**
+ * The props which the ColumnMenu passes to its children.
+ */
+export interface GridColumnMenuProps extends GridColumnMenuFilterBaseProps, GridColumnMenuSortBaseProps {
+    /**
+     * The key of the column menu.
+     */
+    key?: any;
+    /**
+     * The method for rendering the column menu.
+     */
+    render?: any;
+    /**
+     * The opened column menu.
+     */
+    opened?: boolean;
+    /**
+     * The icon that overrides the default(three vertical dots) icon displayed in the column menu of each column.
+     */
+    columnMenuIcon?: SVGIcon;
+    /**
+     * The event that is fired when the column menu is focused.
+     */
+    onContentfocus?: (event: any) => void;
+    /**
+     * The event that is fired when the column menu is expanded or collapsed.
+     */
+    onExpandchange?: (event: any) => void;
+    /**
+     * The event that is fired when the column menu is closed.
+     */
+    onClose?: (event: any) => void;
+    /**
+     * The event that is fired when the column menu is about to be sorted.
+     */
+    onSortchange?: (event: any, sort: SortDescriptor[]) => void;
+}