@progress/kendo-vue-data-tools 7.0.3-develop.1 → 7.1.0-develop.2

package/index.d.mts

@@ -194,7 +194,7 @@ export declare interface CellProps {
 export declare const closestTagName: (target: HTMLElement | null, tagName: 'TD' | 'TR' | 'TABLE') => HTMLElement | null;
 
 /**
- * @hidden
+ * Base interface for column props
  */
 export declare interface ColumnBaseProps {
     /**
@@ -336,6 +336,9 @@ export declare type ColumnSortSettings = boolean | {
     allowUnsort?: boolean;
 };
 
+/** @hidden */
+export declare const combineFilters: (first?: CompositeFilterDescriptor, second?: CompositeFilterDescriptor) => CompositeFilterDescriptor;
+
 /**
  * @hidden
  */
@@ -412,6 +415,34 @@ export declare const defaultHideSecondFilter: {
     boolean: boolean;
 };
 
+/** @hidden */
+export declare enum DETAIL_EXPAND_ACTION {
+    DETAIL_EXPAND = "DETAIL_EXPAND_DETAIL_EXPAND",
+    COLLAPSE = "DETAIL_EXPAND_COLLAPSE",
+    TOGGLE = "DETAIL_EXPAND_TOGGLE",
+    SET = "DETAIL_EXPAND_SET"
+}
+
+/** @hidden */
+export declare type DetailExpandAction = {
+    type: DETAIL_EXPAND_ACTION.TOGGLE | DETAIL_EXPAND_ACTION.DETAIL_EXPAND | DETAIL_EXPAND_ACTION.COLLAPSE;
+    id: string;
+} | {
+    type: DETAIL_EXPAND_ACTION.SET;
+    id: string;
+    payload: boolean;
+};
+
+/**
+ * The descriptor used to define the expanded state of the detail-row.
+ */
+export declare type DetailExpandDescriptor = {
+    [id: string]: boolean;
+};
+
+/** @hidden */
+export declare const detailExpandReducer: (state: DetailExpandDescriptor, action: DetailExpandAction) => DetailExpandDescriptor;
+
 /**
  * @hidden
  */
@@ -433,6 +464,65 @@ left: number;
 top: number;
 }, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 
+/**
+ * @hidden
+ */
+export declare enum EDIT_ACTION {
+    ENTER_EDIT = "EDITING_ENTER_EDIT",
+    ENTER_FIELD_EDIT = "EDITING_ENTER_FIELD_EDIT",
+    ADD_EDIT = "EDITING_ADD_EDIT",
+    ADD_FIELD_EDIT = "EDITING_ADD_FIELD_EDIT",
+    EXIT_EDIT = "EDITING_EXIT_EDIT",
+    EXIT_FIELD_EDIT = "EDITING_EXIT_FIELD_EDIT",
+    TOGGLE_EDIT = "EDITING_TOGGLE_EDIT",
+    TOGGLE_FIELD_EDIT = "EDITING_TOGGLE_FIELD_EDIT"
+}
+
+/**
+ * @hidden
+ */
+export declare type EditAction = {
+    type: EDIT_ACTION.ENTER_EDIT | EDIT_ACTION.ADD_EDIT | EDIT_ACTION.EXIT_EDIT | EDIT_ACTION.TOGGLE_EDIT;
+    payload: {
+        id: string;
+    };
+} | {
+    type: EDIT_ACTION.ENTER_FIELD_EDIT | EDIT_ACTION.ADD_FIELD_EDIT | EDIT_ACTION.EXIT_FIELD_EDIT | EDIT_ACTION.TOGGLE_FIELD_EDIT;
+    payload: {
+        id: string;
+        field: string;
+    };
+};
+
+/**
+ * The `edit` descriptor used to identify which data-items are in edit mode.
+ *
+ * @example
+ * ```ts
+ * const data = [
+ *   { id: 0, name: 'Jane Doe' },
+ *   { id: 1, name: 'John Doe' }
+ * ]
+ *
+ * const edit = {
+ *  1: true
+ * }
+ * ```
+ */
+export declare type EditDescriptor = {
+    /**
+     * The data-item id is in edit mode.
+     * If the value is `true` if the whole item (row) is in edit mode.
+     * If the value is an array of strings if only specific fields (cells) are in edit mode.
+     */
+    [id: string]: boolean | string[];
+};
+
+/**
+ * @hidden
+ */
+export declare const editReducer: (state: EditDescriptor, action: EditAction) => EditDescriptor;
+
 /**
  * @hidden
  */
@@ -947,6 +1037,12 @@ export declare interface FilterRowProps {
     size?: string;
 }
 
+/** @hidden */
+export declare const findGroupExpand: (groupExpand: GroupExpandDescriptor[], group: GroupState) => GroupExpandDescriptor | undefined;
+
+/** @hidden */
+export declare const flatToTree: (flat: GroupState[]) => GroupExpandDescriptor[];
+
 /**
  * @hidden
  */
@@ -960,11 +1056,22 @@ export declare const getColumnIndex: (element: HTMLTableCellElement) => number;
  */
 export declare const getDefaultOperator: (filterOperators: FilterOperators | FilterOperator[], filterType?: string) => any;
 
+/** @hidden */
+export declare const getDetailExpandableOptions: (expandable?: boolean | TableExpandableSettings) => TableExpandableSettings;
+
+/**
+ * @hidden
+ */
+export declare const getEditableOptions: (editable?: boolean | TableEditableSettings) => Required<TableEditableSettings>;
+
 /**
  * @hidden
  */
 export declare const getFilterType: (filterType: 'text' | 'numeric' | 'boolean' | 'date' | undefined) => "boolean" | "text" | "date" | "numeric";
 
+/** @hidden */
+export declare const getGroupExpandableOptions: (groupExpandable?: boolean | TableGroupExpandableSettings) => TableGroupExpandableSettings;
+
 /**
  * Get all group ids from the data.
  *
@@ -986,6 +1093,9 @@ export declare const getOffset: (offsetParent: any) => any;
 /** @hidden */
 export declare const getRowIndex: (element: HTMLTableRowElement) => number;
 
+/** @hidden */
+export declare const getSearchFromString: (search: CompositeFilterDescriptor, value: string) => CompositeFilterDescriptor;
+
 /**
  * Get selected state from the component selection event.
  *
@@ -1026,6 +1136,9 @@ export declare const getSelectionOptions: (selectable?: TableSelectableSettings)
     cell: boolean;
 };
 
+/** @hidden */
+export declare const getStringFromSearch: (search: CompositeFilterDescriptor | undefined) => string;
+
 /**
  * The pager settings of the Grid ([see example]({% slug paging_grid %})).
  *
@@ -1086,6 +1199,14 @@ export declare interface GridPagerSettings {
  */
 export declare type GridPagerType = 'numeric' | 'input';
 
+/** @hidden */
+export declare enum GROUP_EXPAND_ACTION {
+    TOGGLE = "GROUP-EXPAND_TOGGLE",
+    EXPAND = "GROUP-EXPAND_EXPAND",
+    COLLAPSE = "GROUP-EXPAND_COLLAPSE",
+    RESET = "GROUP-EXPAND_RESET"
+}
+
 /**
  * @hidden
  */
@@ -1096,6 +1217,25 @@ export declare interface GroupChangeEvent {
     nextFilter: CompositeFilterDescriptor;
 }
 
+/** @hidden */
+export declare type GroupExpandAction = {
+    type: GROUP_EXPAND_ACTION;
+    group: GroupState;
+};
+
+/**
+ * The descriptor used to define the expanded state of a group.
+ */
+export declare type GroupExpandDescriptor = {
+    value: any;
+    field: string;
+    expanded?: boolean;
+    groups?: GroupExpandDescriptor[];
+};
+
+/** @hidden */
+export declare const groupExpandReducer: (state: GroupExpandDescriptor[], action: GroupExpandAction, options?: TableGroupExpandableSettings) => GroupExpandDescriptor[];
+
 /**
  * @hidden
  */
@@ -1155,6 +1295,14 @@ export declare interface GroupRemoveEvent {
     filter: CompositeFilterDescriptor;
 }
 
+/** @hidden */
+export declare type GroupState = {
+    value: any;
+    field: string;
+    expanded?: boolean;
+    parents?: GroupState[];
+};
+
 /**
  * @hidden
  */
@@ -1525,6 +1673,9 @@ export declare interface HeaderThElementProps {
     navigatable?: boolean;
 }
 
+/** @hidden */
+export declare const isExpanded: (groupExpand: GroupExpandDescriptor[], group: GroupState) => boolean;
+
 /**
  * @hidden
  */
@@ -1587,7 +1738,18 @@ export declare function mapColumns(columns: Array<{
     right: number;
     rightBorder: boolean;
     ariaColumnIndex: number;
-}>): number[][];
+}>, changedColumnLength?: boolean): number[][];
+
+/**
+ * @hidden
+ */
+export declare function nextColumn(columns: {
+    depth: number;
+    locked?: boolean;
+}[], current: number): {
+    depth: number;
+    locked?: boolean;
+};
 
 /**
  * @hidden
@@ -2068,7 +2230,7 @@ export declare interface PagerProps extends GridPagerSettings {
 /**
  * @hidden
  */
-export declare function readColumns(elements: TreeColumnBaseProps[], idInfo: {
+export declare function readColumns<C = CellProps, H = HeaderCellProps, F = FilterCellProps>(elements: TreeColumnBaseProps[], idInfo: {
     prevId: number;
     idPrefix: string;
 }, depth?: number): ExtendedColumnProps[];
@@ -2076,6 +2238,24 @@ export declare function readColumns(elements: TreeColumnBaseProps[], idInfo: {
 /** @hidden */
 export declare const relativeContextElement: (element: any) => any;
 
+/**
+ * Represents the SearchField that configures the way a data field is searched.
+ */
+export declare interface SearchField {
+    /**
+     * The name of the searched field.
+     */
+    field: string;
+    /**
+     * The string operator that will be used for search.
+     */
+    operator?: string;
+    /**
+     * Defines if the search is case sensitive.
+     */
+    ignoreCase?: boolean;
+}
+
 /**
  * Apply the `expanded` prop to the group items in data based on the provided collection of group ids.
  *
@@ -2216,6 +2396,36 @@ export declare interface TableDragSelectionReleaseEvent {
     isDrag: boolean;
 }
 
+export declare interface TableEditableSettings {
+    /**
+     * Determines if the editing is enabled.
+     *
+     * @default false
+     */
+    enabled?: boolean;
+    /**
+     * Determines the editing mode.
+     * The available values are:
+     * * `inline`
+     * * `incell`
+     *
+     * @default 'incell
+     */
+    mode?: 'inline' | 'incell' | 'dialog';
+}
+
+/** @hidden */
+export declare type TableExpandableSettings = {
+    enabled?: boolean;
+    column?: string;
+};
+
+/** @hidden */
+export declare type TableGroupExpandableSettings = {
+    enabled?: boolean;
+    defaultExpand?: boolean;
+};
+
 /**
  * @hidden
  */
@@ -2329,7 +2539,7 @@ export declare interface TableKeyboardNavigationStateType {
  * @hidden
  */
 export declare const tableKeyboardNavigationTools: {
-    generateNavigatableId: (navigationId: string, idPrefix: string, type?: 'column' | 'cell') => string;
+    generateNavigatableId: (navigationId: string, idPrefix: string, type?: 'column' | 'cell' | 'group' | 'expand' | 'nodata') => string;
     getNavigatableId: (element: Element | null) => string;
     getNavigatableLevel: (element: Element | null) => number;
     getNavigatableElement: (scope: HTMLElement, options?: {
@@ -2541,6 +2751,10 @@ export declare interface TreeColumnBaseProps extends ColumnBaseProps {
      * 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;
 }
 
 /**
@@ -2548,4 +2762,42 @@ export declare interface TreeColumnBaseProps extends ColumnBaseProps {
  */
 export declare const unaryOperator: (operator: any) => boolean;
 
+/**
+ * @hidden
+ */
+export declare function updateLeft(columnsMap: number[][], columns: Array<{
+    parentIndex: number;
+    colSpan?: number;
+    rowSpan: number;
+    depth: number;
+    kFirst?: boolean;
+    children: any[];
+    width?: string | number;
+    locked?: boolean;
+    index: number;
+    left: number;
+    right: number;
+    rightBorder: boolean;
+    ariaColumnIndex: number;
+}>, generateLeft?: boolean): void;
+
+/**
+ * @hidden
+ */
+export declare function updateRight(columnsMap: number[][], columns: Array<{
+    parentIndex: number;
+    colSpan?: number;
+    rowSpan: number;
+    depth: number;
+    kFirst?: boolean;
+    children: any[];
+    width?: string | number;
+    locked?: boolean;
+    index: number;
+    left: number;
+    right: number;
+    rightBorder: boolean;
+    ariaColumnIndex: number;
+}>, generateRight?: boolean): void;
+
 export { }