@progress/kendo-vue-grid 3.5.0 → 3.5.1-dev.202208150613

package/dist/esm/interfaces/GridColumnMenuColumnProps.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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/dist/esm/interfaces/GridColumnMenuColumnProps.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridColumnMenuExtendedFilterProps.d.ts

@@ -0,0 +1,42 @@
+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/dist/esm/interfaces/GridColumnMenuExtendedFilterProps.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridColumnMenuFilterBaseProps.d.ts

@@ -0,0 +1,49 @@
+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/dist/esm/interfaces/GridColumnMenuFilterBaseProps.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridColumnMenuFilterProps.d.ts

@@ -0,0 +1,27 @@
+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/dist/esm/interfaces/GridColumnMenuFilterProps.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridColumnMenuFilterUIProps.d.ts

@@ -0,0 +1,55 @@
+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/dist/esm/interfaces/GridColumnMenuFilterUIProps.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridColumnMenuProps.d.ts

@@ -0,0 +1,19 @@
+import { GridColumnMenuFilterBaseProps } from './GridColumnMenuFilterBaseProps';
+import { GridColumnMenuSortBaseProps } from './GridColumnMenuSortBaseProps';
+/**
+ * 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;
+}

package/dist/esm/interfaces/GridColumnMenuProps.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridColumnMenuSortBaseProps.d.ts

@@ -0,0 +1,28 @@
+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/dist/esm/interfaces/GridColumnMenuSortBaseProps.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridColumnProps.d.ts

@@ -0,0 +1,147 @@
+import { GridFilterCellProps, GridHeaderCellProps, GridFooterCellProps, GridCellProps } from '../main';
+/**
+ * The props that can be assigned to the Grid column.
+ */
+export interface GridColumnProps {
+    /**
+     * 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.
+     */
+    sortable?: boolean;
+    /**
+     * 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 displayed for this column. Defaults to `true`.
+     */
+    filterable?: boolean;
+    /**
+     * Defines the filter type that is displayed inside the filter row.
+     * Defaults to `text`.
+     */
+    filter?: 'text' | 'numeric' | 'boolean' | 'date';
+    /**
+     * Defines the editor type. Used when the column enters the edit mode
+     * ([more information and examples]({% slug editing_inline_grid %})).
+     * Defaults to `text`.
+     */
+    editor?: 'text' | 'numeric' | 'boolean' | 'date';
+    /**
+     * 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;
+    /**
+     * Indicates whether the column is hidden.
+     */
+    hidden?: boolean;
+    /**
+     * 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;
+    /**
+     *
+     */
+    locked?: boolean;
+    /**
+     * 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'.
+     * Defaults to `text`.
+     */
+    type?: 'text' | 'numeric' | 'boolean' | 'date';
+}

package/dist/esm/interfaces/GridColumnProps.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridDetailRowProps.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @hidden
+ */
+export interface GridDetailRowProps {
+    /**
+     * The data object that represents the current row.
+     */
+    dataItem: any;
+}

package/dist/esm/interfaces/GridDetailRowProps.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridFilterCellProps.d.ts

@@ -0,0 +1,64 @@
+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;
+}

package/dist/esm/interfaces/GridFilterCellProps.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridFilterOperator.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The filter operator for the Grid filters.
+ */
+export interface GridFilterOperator {
+    text: string;
+    operator: any;
+}

package/dist/esm/interfaces/GridFilterOperator.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridFilterOperators.d.ts

@@ -0,0 +1,49 @@
+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/dist/esm/interfaces/GridFilterOperators.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridFooterCellProps.d.ts

@@ -0,0 +1,7 @@
+export interface GridFooterCellProps {
+    /**
+     * The field to which the footer cell is bound.
+     */
+    field?: string;
+    colSpan?: number;
+}

package/dist/esm/interfaces/GridFooterCellProps.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridGroupableSettings.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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';
+}

package/dist/esm/interfaces/GridGroupableSettings.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridHeaderCellProps.d.ts

@@ -0,0 +1,37 @@
+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/dist/esm/interfaces/GridHeaderCellProps.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridHeaderSelectionCellProps.d.ts

@@ -0,0 +1,17 @@
+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/dist/esm/interfaces/GridHeaderSelectionCellProps.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/GridNoRecordsProps.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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;
+}

package/dist/esm/interfaces/GridNoRecordsProps.js

@@ -0,0 +1 @@
+export {};