@progress/kendo-vue-data-tools 8.0.3-develop.2 → 8.0.3-develop.4

package/interfaces/ColumnProps.d.ts

@@ -0,0 +1,155 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { ColumnSortSettings } from './SortSettings';
+/**
+ * Base interface for column props
+ */
+export interface ColumnBaseProps {
+    /**
+     * The field to which the column is bound.
+     */
+    field?: string;
+    /**
+     * The title of the column.
+     */
+    title?: string;
+    /**
+     * Allows the column headers to be clicked and the `sortChange` event emitted.
+     * You have to handle the `sortChange` event yourself and sort the data.
+     * Defaults to `true`.
+     */
+    sortable?: boolean | ColumnSortSettings;
+    /**
+     * The width of the column (in pixels).
+     */
+    width?: string | number;
+    /**
+     * 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 a standard number format, a custom number format,
+     * a standard date format, or 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 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 resizable.
+     */
+    resizable?: boolean;
+    /**
+     * Indicates whether the column is reorderable.
+     */
+    reorderable?: boolean;
+    /**
+     * The width of the column (in pixels) below which the user is not able to resize the column through the UI. Defaults to `10`.
+     */
+    minResizableWidth?: number;
+    /**
+     * Determinates the position of the column.
+     * Columns with smaller `orderIndex` will appear before columns with bigger `orderIndex`.
+     * Defaults to `0`.
+     */
+    orderIndex?: number;
+    /**
+     * The column identifier used to distinguish columns for example in multi column header scenarios with resize and keyboard navigation.
+     * Also used for unique key for rendering the component cells.
+     * If not set, the component will generate unique `id` automatically.
+     */
+    id?: string;
+    /**
+     * Defines the component that will be rendered as a cell.
+     * If not set, a `Cell` will be rendered by default.
+     */
+    cell?: any;
+    /**
+     * @hidden
+     */
+    navigatable?: boolean;
+    /**
+     * @hidden
+     */
+    locked?: boolean;
+}
+/**
+ * @hidden
+ */
+export interface TreeColumnBaseProps extends ColumnBaseProps {
+    /**
+     * A collection of child columns.
+     */
+    children?: TreeColumnBaseProps[];
+    /**
+     * The column menu component. If set to `true`, the column menu will be rendered.
+     */
+    columnMenu?: any;
+    /**
+     * 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?: any;
+    /**
+     * Defines the component that will be rendered as a header cell.
+     * If not set, a `HeaderCell` will be rendered by default.
+     */
+    headerCell?: any;
+    /**
+     * **Deprecated**. Use `filterCell` prop instead.
+     */
+    filter?: any;
+    /**
+     * Defines the component that will be rendered as a filter cell.
+     */
+    filterCell?: any;
+    /**
+     * Defines the component that will be rendered as a footer cell.
+     */
+    footerCell?: any;
+}
+/**
+ * @hidden
+ */
+export interface ExtendedColumnProps extends TreeColumnBaseProps {
+    declarationIndex: number;
+    parentIndex: number;
+    colSpan: number;
+    rowSpan: number;
+    depth: number;
+    kFirst?: boolean;
+    index: number;
+    children: ExtendedColumnProps[];
+    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/interfaces/FilterCellProps.d.ts

@@ -0,0 +1,90 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2026 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { FilterOperator } from './FilterOperator';
+import { FilterOperators } from './FilterOperators';
+/**
+ * The props of the FilterCell component
+ * ([more information and examples]({% slug filtering_grid %})).
+ */
+/**
+ * @hidden
+ */
+export interface FilterCellProps {
+    /**
+     * @hidden
+     */
+    id: string;
+    /**
+     * The instance of the  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?: FilterOperators[];
+    /**
+     * The list of values for the Boolean filter.
+     */
+    booleanValues: FilterOperator[];
+    /**
+     * The method that will be called if the cell needs to inform its parent  about a change.
+     */
+    onChange?: (event: {
+        value: any;
+        operator: string | Function;
+        event: any;
+    }) => void;
+    /**
+     * The method for rendering the filter cell.
+     */
+    render?: any;
+    /**
+     * The title of the clear button.
+     */
+    clearButtonTitle?: string;
+    /**
+     * 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/FilterOperator.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
+ *-------------------------------------------------------------------------------------------
+ */
+/**
+ * A filter operator object.
+ */
+export interface FilterOperator {
+    /**
+     * The label of the operator.
+     */
+    text: string;
+    /**
+     * The operator value.
+     */
+    operator: any;
+}

package/interfaces/FilterOperators.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 { FilterOperator } from './FilterOperator';
+/**
+ * The filter operators for the filters.
+ *
+ * @example
+ * ```jsx-no-run
+ * // Default 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 FilterOperators {
+    [type: string]: FilterOperator[];
+}

package/interfaces/HeaderCellProps.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 { SortSettings } from './SortSettings';
+/**
+ * The props of the HeaderCellProps component.
+ */
+/**
+ * @hidden
+ */
+export interface HeaderCellProps {
+    /**
+     * 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?: SortSettings;
+    /**
+     * The method for rendering the cell.
+     */
+    render?: any;
+    /**
+     * The event that is fired when the header cell is clicked.
+     */
+    onHeadercellclick?: any;
+}

package/interfaces/HeaderSelectionCellProps.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 { HeaderCellProps } from './HeaderCellProps';
+/**
+ * The props of the HeaderSelectionCellProps component.
+ */
+/**
+ * @hidden
+ */
+export interface HeaderSelectionCellProps extends HeaderCellProps {
+    /**
+     * 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/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 type ColumnSortSettings = boolean | {
+    /**
+     * 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;