@progress/kendo-react-data-tools 9.3.1 → 9.4.0-develop.10

package/index.d.mts

@@ -17,7 +17,6 @@ import { JSX as JSX_2 } from 'react/jsx-runtime';
 import * as React_2 from 'react';
 import { SortDescriptor } from '@progress/kendo-data-query';
 import { SVGIcon } from '@progress/kendo-react-common';
-import { TableSelectableMode as TableSelectableMode_2 } from './TableSelectableSettings';
 
 /**
  * Represents the base object of the `onPageChange` event. It is usually used
@@ -109,6 +108,8 @@ export declare interface CellProps {
      * Indicates if the cell is selected.
      */
     isSelected: boolean;
+    /** @hidden */
+    isInEdit?: boolean;
     /**
      * Indicates if the cell is sorted.
      */
@@ -651,6 +652,9 @@ export declare interface ColumnSortSettings {
     allowUnsort?: boolean;
 }
 
+/** @hidden */
+export declare const combineFilters: (first?: CompositeFilterDescriptor, second?: CompositeFilterDescriptor) => CompositeFilterDescriptor | undefined;
+
 /**
  * @hidden
  */
@@ -742,6 +746,32 @@ declare const DateFilterCell_base: React_2.ComponentClass<FilterComponentProps_2
 export declare interface DateFilterProps extends TextFilterProps {
 }
 
+/** @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;
+};
+
+/** @hidden */
+export declare type DetailExpandDescriptor = {
+    [id: string]: boolean;
+};
+
+/** @hidden */
+export declare const detailExpandReducer: (state: DetailExpandDescriptor, action: DetailExpandAction) => DetailExpandDescriptor;
+
 /**
  * @hidden
  */
@@ -785,6 +815,67 @@ declare interface DropClueState {
     height: number;
 }
 
+/**
+ * @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.
+ * TODO: uncomment
+ *
+ * @hidden
+ * @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 | undefined, action: EditAction) => EditDescriptor;
+
 /**
  * The EnumFilter component used for editing the value of FilterDescriptor object.
  * It renders a DropDownList and allows you to choose a value from the predefined list.
@@ -1135,14 +1226,31 @@ export declare interface FilterRowProps {
     ariaRowIndex?: number;
 }
 
+/** @hidden */
+export declare const findGroupExpand: (groupExpand: GroupExpandDescriptor[], group: GroupState) => GroupExpandDescriptor | undefined;
+
 /**
  * @hidden
  */
 export declare function flatData(data: any[], getChildren: (dataItem: any) => any[], itemMap: (item: any) => any): DataItemWrapper[];
 
+/** @hidden */
+export declare const flatToTree: (flat: GroupState[]) => GroupExpandDescriptor[];
+
 /** @hidden */
 export declare const getColumnIndex: (element: HTMLTableCellElement) => number | undefined;
 
+/** @hidden */
+export declare const getDetailExpandableOptions: (expandable?: boolean | TableExpandableSettings) => TableExpandableSettings;
+
+/**
+ * @hidden
+ */
+export declare const getEditableOptions: (editable?: boolean | TableEditableSettings) => Required<TableEditableSettings>;
+
+/** @hidden */
+export declare const getGroupExpandableOptions: (groupExpandable?: boolean | TableGroupExpandableSettings) => TableGroupExpandableSettings;
+
 /**
  * Get all group ids from the data.
  *
@@ -1174,6 +1282,9 @@ export declare const getOffset: (offsetParent: any) => any;
 /** @hidden */
 export declare const getRowIndex: (element: HTMLTableRowElement) => number | undefined;
 
+/** @hidden */
+export declare const getSearchFromString: (search: CompositeFilterDescriptor, value: string) => CompositeFilterDescriptor;
+
 /**
  * Get selected state from the component selection event.
  *
@@ -1207,12 +1318,10 @@ export declare const getSelectedStateFromKeyDown: (options: {
 };
 
 /** @hidden */
-export declare const getSelectionOptions: (selectable?: TableSelectableSettings) => {
-    enabled: boolean;
-    drag: boolean;
-    mode: TableSelectableMode_2;
-    cell: boolean;
-};
+export declare const getSelectionOptions: (selectable?: boolean | TableSelectableSettings) => Required<TableSelectableSettings>;
+
+/** @hidden */
+export declare const getStringFromSearch: (search: CompositeFilterDescriptor | undefined) => string;
 
 /**
  * @hidden
@@ -1239,6 +1348,14 @@ export declare class Group extends React_2.Component<GroupProps> {
     private onRemove;
 }
 
+/** @hidden */
+export declare enum GROUP_EXPAND_ACTION {
+    TOGGLE = "GROUP-EXPAND_TOGGLE",
+    EXPAND = "GROUP-EXPAND_EXPAND",
+    COLLAPSE = "GROUP-EXPAND_COLLAPSE",
+    RESET = "GROUP-EXPAND_RESET"
+}
+
 /**
  * @hidden
  */
@@ -1247,6 +1364,23 @@ export declare interface GroupChangeEvent extends BaseEvent<Group> {
     nextFilter: CompositeFilterDescriptor;
 }
 
+/** @hidden */
+export declare type GroupExpandAction = {
+    type: GROUP_EXPAND_ACTION;
+    group: GroupState;
+};
+
+/** @hidden */
+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
  */
@@ -1267,6 +1401,14 @@ export declare interface GroupRemoveEvent extends BaseEvent<Group> {
     filter: CompositeFilterDescriptor;
 }
 
+/** @hidden */
+export declare type GroupState = {
+    value: any;
+    field: string;
+    expanded?: boolean;
+    parents?: GroupState[];
+};
+
 /**
  * @hidden
  */
@@ -1425,6 +1567,9 @@ export declare interface HeaderThElementProps extends React_2.ThHTMLAttributes<H
     navigatable?: boolean;
 }
 
+/** @hidden */
+export declare const isExpanded: (groupExpand: GroupExpandDescriptor[], group: GroupState) => boolean;
+
 /** @hidden */
 export declare const isInNonSelectable: (target: HTMLElement | null) => boolean;
 
@@ -1868,6 +2013,32 @@ export declare const relativeContextElement: (element: any) => any;
  */
 export declare const removeItems: (data: any[], subItemsField: string, condition: (item: any) => boolean) => 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;
+}
+
+/**
+ * @hidden
+ * TODO: document
+ */
+export declare type SelectDescriptor = {
+    [id: string]: boolean | number[];
+};
+
 /**
  * @hidden
  */
@@ -1951,6 +2122,8 @@ export declare function tableColumnsVirtualization(args: {
     }[];
     tableViewPortWidth: number;
     scrollLeft: number;
+    getColSpan?: any;
+    dataItem?: any;
 }): {
     colSpans: number[];
     hiddenColumns: boolean[];
@@ -2008,6 +2181,37 @@ export declare interface TableDragSelectionReleaseEvent {
     isDrag: boolean;
 }
 
+/** @hidden */
+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';
+}
+
+/** @hidden */
+export declare type TableExpandableSettings = {
+    enabled?: boolean;
+    column?: string;
+};
+
+/** @hidden */
+export declare type TableGroupExpandableSettings = {
+    enabled?: boolean;
+    defaultExpand?: boolean;
+};
+
 /**
  * @hidden
  */
@@ -2084,9 +2288,7 @@ export declare const tableKeyboardNavigation: {
     focusFirstDataElement: (options: {
         scope?: HTMLElement | undefined;
         contextStateRef: {
-            current?: TableKeyboardNavigationContextType | undefined; /**
-            * @hidden
-            */
+            current?: TableKeyboardNavigationContextType | undefined;
         };
         navigationStateRef: {
             current?: TableKeyboardNavigationStateType | undefined;
@@ -2417,7 +2619,7 @@ export declare const unaryOperator: (operator: any) => boolean;
  */
 export declare function updateLeft(columnsMap: number[][], columns: Array<{
     parentIndex: number;
-    colSpan: number;
+    colSpan?: number;
     rowSpan: number;
     depth: number;
     kFirst?: boolean;
@@ -2436,7 +2638,7 @@ export declare function updateLeft(columnsMap: number[][], columns: Array<{
  */
 export declare function updateRight(columnsMap: number[][], columns: Array<{
     parentIndex: number;
-    colSpan: number;
+    colSpan?: number;
     rowSpan: number;
     depth: number;
     kFirst?: boolean;

package/index.d.ts

@@ -17,7 +17,6 @@ import { JSX as JSX_2 } from 'react/jsx-runtime';
 import * as React_2 from 'react';
 import { SortDescriptor } from '@progress/kendo-data-query';
 import { SVGIcon } from '@progress/kendo-react-common';
-import { TableSelectableMode as TableSelectableMode_2 } from './TableSelectableSettings';
 
 /**
  * Represents the base object of the `onPageChange` event. It is usually used
@@ -109,6 +108,8 @@ export declare interface CellProps {
      * Indicates if the cell is selected.
      */
     isSelected: boolean;
+    /** @hidden */
+    isInEdit?: boolean;
     /**
      * Indicates if the cell is sorted.
      */
@@ -651,6 +652,9 @@ export declare interface ColumnSortSettings {
     allowUnsort?: boolean;
 }
 
+/** @hidden */
+export declare const combineFilters: (first?: CompositeFilterDescriptor, second?: CompositeFilterDescriptor) => CompositeFilterDescriptor | undefined;
+
 /**
  * @hidden
  */
@@ -742,6 +746,32 @@ declare const DateFilterCell_base: React_2.ComponentClass<FilterComponentProps_2
 export declare interface DateFilterProps extends TextFilterProps {
 }
 
+/** @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;
+};
+
+/** @hidden */
+export declare type DetailExpandDescriptor = {
+    [id: string]: boolean;
+};
+
+/** @hidden */
+export declare const detailExpandReducer: (state: DetailExpandDescriptor, action: DetailExpandAction) => DetailExpandDescriptor;
+
 /**
  * @hidden
  */
@@ -785,6 +815,67 @@ declare interface DropClueState {
     height: number;
 }
 
+/**
+ * @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.
+ * TODO: uncomment
+ *
+ * @hidden
+ * @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 | undefined, action: EditAction) => EditDescriptor;
+
 /**
  * The EnumFilter component used for editing the value of FilterDescriptor object.
  * It renders a DropDownList and allows you to choose a value from the predefined list.
@@ -1135,14 +1226,31 @@ export declare interface FilterRowProps {
     ariaRowIndex?: number;
 }
 
+/** @hidden */
+export declare const findGroupExpand: (groupExpand: GroupExpandDescriptor[], group: GroupState) => GroupExpandDescriptor | undefined;
+
 /**
  * @hidden
  */
 export declare function flatData(data: any[], getChildren: (dataItem: any) => any[], itemMap: (item: any) => any): DataItemWrapper[];
 
+/** @hidden */
+export declare const flatToTree: (flat: GroupState[]) => GroupExpandDescriptor[];
+
 /** @hidden */
 export declare const getColumnIndex: (element: HTMLTableCellElement) => number | undefined;
 
+/** @hidden */
+export declare const getDetailExpandableOptions: (expandable?: boolean | TableExpandableSettings) => TableExpandableSettings;
+
+/**
+ * @hidden
+ */
+export declare const getEditableOptions: (editable?: boolean | TableEditableSettings) => Required<TableEditableSettings>;
+
+/** @hidden */
+export declare const getGroupExpandableOptions: (groupExpandable?: boolean | TableGroupExpandableSettings) => TableGroupExpandableSettings;
+
 /**
  * Get all group ids from the data.
  *
@@ -1174,6 +1282,9 @@ export declare const getOffset: (offsetParent: any) => any;
 /** @hidden */
 export declare const getRowIndex: (element: HTMLTableRowElement) => number | undefined;
 
+/** @hidden */
+export declare const getSearchFromString: (search: CompositeFilterDescriptor, value: string) => CompositeFilterDescriptor;
+
 /**
  * Get selected state from the component selection event.
  *
@@ -1207,12 +1318,10 @@ export declare const getSelectedStateFromKeyDown: (options: {
 };
 
 /** @hidden */
-export declare const getSelectionOptions: (selectable?: TableSelectableSettings) => {
-    enabled: boolean;
-    drag: boolean;
-    mode: TableSelectableMode_2;
-    cell: boolean;
-};
+export declare const getSelectionOptions: (selectable?: boolean | TableSelectableSettings) => Required<TableSelectableSettings>;
+
+/** @hidden */
+export declare const getStringFromSearch: (search: CompositeFilterDescriptor | undefined) => string;
 
 /**
  * @hidden
@@ -1239,6 +1348,14 @@ export declare class Group extends React_2.Component<GroupProps> {
     private onRemove;
 }
 
+/** @hidden */
+export declare enum GROUP_EXPAND_ACTION {
+    TOGGLE = "GROUP-EXPAND_TOGGLE",
+    EXPAND = "GROUP-EXPAND_EXPAND",
+    COLLAPSE = "GROUP-EXPAND_COLLAPSE",
+    RESET = "GROUP-EXPAND_RESET"
+}
+
 /**
  * @hidden
  */
@@ -1247,6 +1364,23 @@ export declare interface GroupChangeEvent extends BaseEvent<Group> {
     nextFilter: CompositeFilterDescriptor;
 }
 
+/** @hidden */
+export declare type GroupExpandAction = {
+    type: GROUP_EXPAND_ACTION;
+    group: GroupState;
+};
+
+/** @hidden */
+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
  */
@@ -1267,6 +1401,14 @@ export declare interface GroupRemoveEvent extends BaseEvent<Group> {
     filter: CompositeFilterDescriptor;
 }
 
+/** @hidden */
+export declare type GroupState = {
+    value: any;
+    field: string;
+    expanded?: boolean;
+    parents?: GroupState[];
+};
+
 /**
  * @hidden
  */
@@ -1425,6 +1567,9 @@ export declare interface HeaderThElementProps extends React_2.ThHTMLAttributes<H
     navigatable?: boolean;
 }
 
+/** @hidden */
+export declare const isExpanded: (groupExpand: GroupExpandDescriptor[], group: GroupState) => boolean;
+
 /** @hidden */
 export declare const isInNonSelectable: (target: HTMLElement | null) => boolean;
 
@@ -1868,6 +2013,32 @@ export declare const relativeContextElement: (element: any) => any;
  */
 export declare const removeItems: (data: any[], subItemsField: string, condition: (item: any) => boolean) => 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;
+}
+
+/**
+ * @hidden
+ * TODO: document
+ */
+export declare type SelectDescriptor = {
+    [id: string]: boolean | number[];
+};
+
 /**
  * @hidden
  */
@@ -1951,6 +2122,8 @@ export declare function tableColumnsVirtualization(args: {
     }[];
     tableViewPortWidth: number;
     scrollLeft: number;
+    getColSpan?: any;
+    dataItem?: any;
 }): {
     colSpans: number[];
     hiddenColumns: boolean[];
@@ -2008,6 +2181,37 @@ export declare interface TableDragSelectionReleaseEvent {
     isDrag: boolean;
 }
 
+/** @hidden */
+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';
+}
+
+/** @hidden */
+export declare type TableExpandableSettings = {
+    enabled?: boolean;
+    column?: string;
+};
+
+/** @hidden */
+export declare type TableGroupExpandableSettings = {
+    enabled?: boolean;
+    defaultExpand?: boolean;
+};
+
 /**
  * @hidden
  */
@@ -2084,9 +2288,7 @@ export declare const tableKeyboardNavigation: {
     focusFirstDataElement: (options: {
         scope?: HTMLElement | undefined;
         contextStateRef: {
-            current?: TableKeyboardNavigationContextType | undefined; /**
-            * @hidden
-            */
+            current?: TableKeyboardNavigationContextType | undefined;
         };
         navigationStateRef: {
             current?: TableKeyboardNavigationStateType | undefined;
@@ -2417,7 +2619,7 @@ export declare const unaryOperator: (operator: any) => boolean;
  */
 export declare function updateLeft(columnsMap: number[][], columns: Array<{
     parentIndex: number;
-    colSpan: number;
+    colSpan?: number;
     rowSpan: number;
     depth: number;
     kFirst?: boolean;
@@ -2436,7 +2638,7 @@ export declare function updateLeft(columnsMap: number[][], columns: Array<{
  */
 export declare function updateRight(columnsMap: number[][], columns: Array<{
     parentIndex: number;
-    colSpan: number;
+    colSpan?: number;
     rowSpan: number;
     depth: number;
     kFirst?: boolean;