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

package/interfaces/GridColumnMenuSortBaseProps.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @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 } from '@progress/kendo-data-query';
+import { GridSortSettings } from './GridSortSettings';
+import { GridColumnMenuColumnProps } from './GridColumnMenuColumnProps';
+/**
+ *  The props passed to the ColumnMenu sort component.
+ */
+export interface GridColumnMenuSortBaseProps {
+    /**
+     * The current column options.
+     */
+    column: GridColumnMenuColumnProps;
+    /**
+     * The method that will be called to close the column menu.
+     */
+    onClosemenu?: Function;
+    /**
+     * The sortable option of the column.
+     */
+    sortable?: GridSortSettings;
+    /**
+     * The current sort state of the Grid.
+     */
+    sort?: SortDescriptor[];
+    /**
+     * The method that will be called to notify the parent Grid about a sort change.
+     */
+    onSortchange?: (descriptors: SortDescriptor[], e: any) => void;
+}

package/interfaces/GridColumnProps.d.ts

@@ -0,0 +1,207 @@
+/**
+ * @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 { GridRowSpannableSettings } from './GridRowSpannableSettings';
+import { GridColSpanProps } from './GridColSpanProps';
+import { GridDataType } from './GridDataType';
+import { GridColumnSortSettings } from './GridSortSettings';
+import { ColumnBaseProps } from '@progress/kendo-vue-data-tools';
+import { GridColumnType } from './ColumnType';
+import { GridHeaderCellProps } from './GridHeaderCellProps';
+import { GridCellProps } from './GridCellProps';
+import { GridFilterCellProps } from './GridFilterCellProps';
+import { GridFooterCellProps } from './GridFooterCellProps';
+/**
+ * The props that can be assigned to the Grid column.
+ */
+export interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
+    /**
+     * The field to which the column is bound.
+     */
+    field?: string;
+    /**
+     * The title of the column.
+     */
+    title?: string;
+    /**
+     * Defines whether the column is editable
+     * ([more information and examples]({% slug editing_inline_grid %})).
+     */
+    editable?: boolean;
+    /**
+     * Allows the column headers to be clicked and the `sortChange` event emitted.
+     * You have to handle the `sortChange` event yourself and sort the data.
+     *
+     * @default true
+     */
+    sortable?: GridColumnSortSettings;
+    /**
+     * Defines the custom rendering of the cell. Accepts a Vue component, a `render` function, or a slot name.
+     * If not set, a `GridCell` will be rendered by default.
+     */
+    cell?: ((h: any, defaultRendering: any | null, props: GridCellProps, listeners: any) => any) | string | any;
+    /**
+     * @hidden
+     */
+    internalCell?: any;
+    /**
+     * @hidden
+     */
+    internalHeaderCell?: any;
+    /**
+     * Defines the custom rendering of the filter cell. Accepts a Vue component, a `render` function, or a slot name.
+     * If not set, a `GridFilterCell` will be rendered by default.
+     */
+    filterCell?: ((h: any, defaultRendering: any | null, props: GridFilterCellProps, listeners: any) => any) | string | any;
+    /**
+     * Defines if a filter UI will be rendered for this column.
+     *
+     * @default true
+     */
+    filterable?: boolean;
+    /**
+     * Defines the title which will be set to the input element in the filter cell.
+     *
+     */
+    filterTitle?: string;
+    /**
+     * Defines the filter type that will be rendered inside the filter row.
+     *
+     * @default 'text'
+     */
+    filter?: GridDataType;
+    /**
+     * Defines the editor type. Used when the column enters the edit mode ([more information and examples]({% slug editing_inline_grid %})).
+     *
+     * @default 'text'
+     */
+    editor?: GridDataType;
+    /**
+    * Overrides the default(three vertical dots) column menu icon or the icon set through the ([`columnMenuIcon`]({% slug api_grid_gridprops %}#toc-columnmenuicon)) property.
+    */
+    menuIcon?: SVGIcon;
+    /**
+     * The width of the column (in pixels).
+     */
+    width?: string | number;
+    /**
+     * The width of the column (in pixels) below which the user is not able to resize the column through the UI.
+     * Defaults to `10`. It is responsible only for the minimal width that is observed after the manual drag and it is
+     * not responsible for the width of the columns when the browser is resized
+     */
+    minResizableWidth?: number;
+    /**
+     * Defines the custom rendering of the header cell. Accepts a Vue component, a `render` function, or a slot name.
+     * If not set, a `GridHeaderCell` will be rendered by default.
+     */
+    headerCell?: ((h: any, defaultRendering: any | null, props: GridHeaderCellProps, listeners: any) => any) | string | any;
+    /**
+     * Defines the custom rendering of the footer cell.
+     * The footer cell have to render an `HTMLTableCellElement` (TD element) and
+     *  apply its `style` and `colspan` values from the footer component `props`.
+     * Accepts a Vue component, a `render` function, or a slot name.
+     */
+    footerCell?: ((h: any, defaultRendering: any | null, props: GridFooterCellProps, listeners: any) => any) | string | any;
+    /**
+     * Sets the custom CSS classes to the column footer cell if there is footer.
+     */
+    footerClassName?: string;
+    /**
+     * Defines if the header selection checkbox is checked.
+     */
+    headerSelectionValue?: boolean;
+    /**
+     * The format that is applied to the value before it 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;
+    /**
+     * Sets the colSpan of the column which will make the row content span over multiple cells.
+     * As arguments, it takes either a number or a function that returns a number.
+     *
+     * @default 1
+     */
+    colSpan?: number | ((colSpanProps: GridColSpanProps) => number);
+    /**
+     * Controls the visibility of the Grid's column.
+     *
+     * @default false
+     */
+    hidden?: boolean;
+    /**
+     * Sets the screen size condition that needs to be satisfied for a column to remain visible. If you set the hidden property, the behavior of media is overridden.
+     *
+     */
+    media?: string;
+    /**
+   * Sets the custom CSS classes to the column header cell.
+   */
+    headerClassName?: string;
+    /**
+     * Sets the custom CSS classes to the column cells.
+     */
+    className?: string;
+    /**
+     * Indicates whether the column is reorderable.
+     */
+    reorderable?: boolean;
+    /**
+     * Indicates whether the column is resizable.
+     */
+    resizable?: boolean;
+    /**
+     * Determinates the position of the column. Columns with smaller `orderIndex` will appear
+     * before columns with bigger `orderIndex`. Defaults to `0`.
+     */
+    orderIndex?: number;
+    /**
+     * Determines if the column can be dragged to the group panel. Defaults to `true`.
+     */
+    groupable?: boolean;
+    /**
+     * A collection of child columns.
+     */
+    children?: (GridColumnProps)[] | (any)[];
+    /**
+     * Defines if the column menu will be shown for the column.
+     * Accepts Boolean, a Vue component, a `render` function, or a slot name
+     */
+    columnMenu?: boolean | any;
+    /**
+     * Defines if the column menu is opened.
+     */
+    columnMenuOpened?: boolean;
+    /**
+     *
+     */
+    locked?: boolean;
+    /**
+     * The type of the data which will be used when formatting the cell data.
+     * Could be one of the following values 'string' | 'number' | 'boolean' | 'date'.
+     * Defaults to `string`.
+     */
+    type?: 'string' | 'number' | 'boolean' | 'date';
+    /**
+     * Sets the type of the column and renders a dedicated column for interaction.
+     *
+     * @default "data"
+     */
+    columnType?: GridColumnType;
+    /**
+     * Defines if the cells of the column should be spanned when their values are the same.
+     *
+     */
+    rowSpannable?: boolean | GridRowSpannableSettings;
+}

package/interfaces/GridColumnState.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
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * The state of the GridColumn
+ */
+export interface GridColumnState {
+    /**
+     * The id of the column.
+     */
+    id: string;
+    /**
+     * The field of the column.
+     */
+    field?: string;
+    /**
+     * The title of the column.
+     */
+    title?: string;
+    /**
+     * The value indicating whether a column is visible or not.
+     */
+    hidden?: boolean;
+    /**
+     * The width of the column (in pixels).
+     */
+    width?: string | number;
+    /**
+     * The position of the column.
+     */
+    orderIndex?: number;
+    /**
+     * A collection of child states.
+     */
+    children?: GridColumnState[];
+    /**
+     * Determines if the column is locked to the left or right side of the grid.
+     */
+    locked?: boolean;
+}

package/interfaces/GridDataType.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
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * Exposes the data types available when setting the [filter](slug:api_grid_gridcolumnprops#toc-filter) or
+ * [editor](slug:api_grid_gridcolumnprops#toc-editor) property of the Grid columns.
+ */
+export type GridDataType = 'text' | 'numeric' | 'boolean' | 'date';

package/interfaces/GridDetailExpandableSettings.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { TableExpandableSettings } from '@progress/kendo-vue-data-tools';
+/** @hidden */
+export interface GridDetailExpandableSettings extends TableExpandableSettings {
+}

package/interfaces/GridDetailRowProps.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @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 GridDetailRowProps {
+    /**
+     * The data object that represents the current row.
+     */
+    dataItem: any;
+}

package/interfaces/GridEditableSettings.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { TableEditableSettings } from '@progress/kendo-vue-data-tools';
+/**
+ * Represents the Grid editable settings:
+ * - `enabled` — Determines if the editing is enabled.
+ * - `mode` — Determines the editing mode.
+ *
+ */
+export interface GridEditableSettings extends TableEditableSettings {
+}

package/interfaces/GridFilterCellProps.d.ts

@@ -0,0 +1,86 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { GridFilterOperator } from './GridFilterOperator';
+import { GridFilterOperators } from './GridFilterOperators';
+/**
+ * The props of the GridFilterCell component
+ * ([more information and examples]({% slug filtering_grid %})).
+ */
+/**
+ * @hidden
+ */
+export interface GridFilterCellProps {
+    /**
+     * @hidden
+     */
+    id: string;
+    /**
+     * The instance of the Grid component.
+     */
+    grid?: any;
+    /**
+     * The title of the filter editor.
+     */
+    title?: string;
+    /**
+     * The column span of the cell.
+     */
+    colSpan?: number;
+    /**
+     * The column field in which the cell is located.
+     */
+    field?: string;
+    /**
+     * The type of the filter. Determines which editor will be rendered for filtering.
+     * The supported values are the following 0 'text' | 'numeric' | 'boolean' | 'date;
+     */
+    filterType: string;
+    /**
+     * The value of the cell.
+     */
+    value: any;
+    /**
+     * The operator that will be used for the cell filtering.
+     */
+    operator: string;
+    /**
+     * The list of the default operators for the current filter type.
+     */
+    operators: GridFilterOperators[];
+    /**
+     * The list of values for the Boolean filter.
+     */
+    booleanValues: GridFilterOperator[];
+    /**
+     * The method that will be called if the cell needs to inform its parent Grid about a change.
+     */
+    onChange?: (event: {
+        value: any;
+        operator: string | Function;
+        event: any;
+    }) => void;
+    /**
+     * The method for rendering the filter cell.
+     */
+    render?: any;
+    /**
+     * The ariaLabel of the filter editor.
+     */
+    ariaLabel?: string;
+    /**
+     * Configures the `size` of the cell.
+     *
+     * The available options are:
+     * - small
+     * - medium
+     * - large
+     *
+     * @default `undefined`
+     */
+    size?: 'small' | 'medium' | 'large';
+}

package/interfaces/GridFilterOperator.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * The filter operator for the Grid filters.
+ */
+export interface GridFilterOperator {
+    text: string;
+    operator: any;
+}

package/interfaces/GridFilterOperators.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 { GridFilterOperator } from './GridFilterOperator';
+/**
+ * The filter operators for the Grid filters.
+ *
+ * @example
+ * ```jsx-no-run
+ * // Default Grid filter operators:
+ * const filterOperators: {
+ *     'text': [
+ *         { text: 'grid.filterContainsOperator', operator: 'contains' },
+ *         { text: 'grid.filterNotContainsOperator', operator: 'doesnotcontain' },
+ *         { text: 'grid.filterEqOperator', operator: 'eq' },
+ *         { text: 'grid.filterNotEqOperator', operator: 'neq' },
+ *         { text: 'grid.filterStartsWithOperator', operator: 'startswith' },
+ *         { text: 'grid.filterEndsWithOperator', operator: 'endswith' },
+ *         { text: 'grid.filterIsNullOperator', operator: 'isnull' },
+ *         { text: 'grid.filterIsNotNullOperator', operator: 'isnotnull' },
+ *         { text: 'grid.filterIsEmptyOperator', operator: 'isempty' },
+ *         { text: 'grid.filterIsNotEmptyOperator', operator: 'isnotempty' }
+ *     ],
+ *     'numeric': [
+ *         { text: 'grid.filterEqOperator', operator: 'eq' },
+ *         { text: 'grid.filterNotEqOperator', operator: 'neq' },
+ *         { text: 'grid.filterGteOperator', operator: 'gte' },
+ *         { text: 'grid.filterGtOperator', operator: 'gt' },
+ *         { text: 'grid.filterLteOperator', operator: 'lte' },
+ *         { text: 'grid.filterLtOperator', operator: 'lt' },
+ *         { text: 'grid.filterIsNullOperator', operator: 'isnull' },
+ *         { text: 'grid.filterIsNotNullOperator', operator: 'isnotnull' }
+ *     ],
+ *     'date': [
+ *         { text: 'grid.filterEqOperator', operator: 'eq' },
+ *         { text: 'grid.filterNotEqOperator', operator: 'neq' },
+ *         { text: 'grid.filterAfterOrEqualOperator', operator: 'gte' },
+ *         { text: 'grid.filterAfterOperator', operator: 'gt' },
+ *         { text: 'grid.filterBeforeOperator', operator: 'lt' },
+ *         { text: 'grid.filterBeforeOrEqualOperator', operator: 'lte' },
+ *         { text: 'grid.filterIsNullOperator', operator: 'isnull' },
+ *         { text: 'grid.filterIsNotNullOperator', operator: 'isnotnull' }
+ *     ],
+ *     'boolean': [
+ *         { text: 'grid.filterEqOperator', operator: 'eq' }
+ *     ]
+ * }
+ * ```
+ */
+export interface GridFilterOperators {
+    [type: string]: GridFilterOperator[];
+}

package/interfaces/GridFooterCellProps.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+export interface GridFooterCellProps {
+    /**
+     * The field to which the footer cell is bound.
+     */
+    field?: string;
+    colSpan?: number;
+}

package/interfaces/GridGroupExpandableSettings.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 { TableGroupExpandableSettings } from '@progress/kendo-vue-data-tools';
+/**
+ * Represents the Grid group expandable settings.
+ */
+export interface GridGroupExpandableSettings extends TableGroupExpandableSettings {
+    /**
+     * Determines the default expand state for groups.
+     * When set to `true`, all groups are expanded by default.
+     */
+    defaultExpand?: boolean;
+    /**
+     * Determines if group expanding functionality is enabled.
+     */
+    enabled?: boolean;
+}

package/interfaces/GridGroupableSettings.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { GridGroupExpandableSettings } from './GridGroupExpandableSettings';
+/**
+ * The settings for grouping the data of the Grid
+ * ([see example]({% slug groupingaggregates_grid %})).
+ */
+export interface GridGroupableSettings {
+    /**
+     * Determines if grouping by dragging and dropping the column headers is allowed
+     * and if the group header is visible.
+     */
+    enabled?: boolean;
+    /**
+     * Determines if the group footer row is visible when the group is collapsed. Defaults to `false`.
+     */
+    footer?: 'always' | 'visible' | 'none';
+    /**
+     * The group expandable settings.
+     */
+    expandable?: boolean | GridGroupExpandableSettings;
+}

package/interfaces/GridHeaderCellProps.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 { GridSortSettings } from '../interfaces/GridSortSettings';
+/**
+ * The props of the GridHeaderCellProps component.
+ */
+/**
+ * @hidden
+ */
+export interface GridHeaderCellProps {
+    /**
+     * The key in which the cell is located.
+     */
+    key?: any;
+    /**
+     * 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;
+    /**
+     * @hidden
+     */
+    selectionValue?: any;
+    /**
+     * The method for rendering the header cell.
+     */
+    sortable?: GridSortSettings;
+    /**
+     * The method for rendering the cell.
+     */
+    render?: any;
+}

package/interfaces/GridHeaderSelectionCellProps.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { GridHeaderCellProps } from './GridHeaderCellProps';
+/**
+ * The props of the GridHeaderSelectionCellProps component.
+ */
+/**
+ * @hidden
+ */
+export interface GridHeaderSelectionCellProps extends GridHeaderCellProps {
+    /**
+     * The `selectionChange` event handler of the cell.
+     */
+    selectionChange?: any;
+    /**
+     * The `selectionValue` event handler of the column in which the cell is located.
+     */
+    selectionValue: any;
+}

package/interfaces/GridHighlightDescriptor.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+export type GridHighlightDescriptor = {
+    [id: string]: boolean | number[];
+};

package/interfaces/GridNoRecordsProps.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * The props of the GridNoRecords component.
+ */
+export interface GridNoRecordsProps {
+    /**
+     * The Vue slots that will be rendered inside the Grid when no records are available.
+     */
+    children?: any;
+}