@progress/kendo-react-grid 9.4.0-develop.24 → 9.4.0-develop.4

package/index.d.mts

@@ -7,6 +7,7 @@
  */
 import { BaseEvent } from '@progress/kendo-react-common';
 import { CellProps } from '@progress/kendo-react-data-tools';
+import { ClipboardDataEvent } from '@progress/kendo-react-data-tools';
 import { ClipboardSettings } from '@progress/kendo-react-data-tools';
 import { ColumnBaseProps } from '@progress/kendo-react-data-tools';
 import { ColumnSortSettings } from '@progress/kendo-react-data-tools';
@@ -21,16 +22,13 @@ import { FilterOperator } from '@progress/kendo-react-data-tools';
 import { getSelectedState } from '@progress/kendo-react-data-tools';
 import { getSelectedStateFromKeyDown } from '@progress/kendo-react-data-tools';
 import { GridClassStructure } from '@progress/kendo-react-common';
-import { GridClipboardEvent } from '@progress/kendo-react-data-tools';
 import { GroupDescriptor } from '@progress/kendo-data-query';
 import { GroupExpandDescriptor } from '@progress/kendo-react-data-tools';
 import { GroupState } from '@progress/kendo-react-data-tools';
 import { HeaderCellBaseProps } from '@progress/kendo-react-data-tools';
 import { HeaderThElementProps } from '@progress/kendo-react-data-tools';
-import { IntlService } from '@progress/kendo-react-intl';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { KendoReactComponentBaseProps } from '@progress/kendo-react-common';
-import { LocalizationService } from '@progress/kendo-react-intl';
 import { MenuItemModel } from '@progress/kendo-react-layout';
 import { MenuSelectEvent } from '@progress/kendo-react-layout';
 import { NavigatableSettings } from '@progress/kendo-react-data-tools';
@@ -40,7 +38,6 @@ import { PagerProps } from '@progress/kendo-react-data-tools';
 import { PagerTargetEvent } from '@progress/kendo-react-data-tools';
 import * as React_2 from 'react';
 import { ReactElement } from 'react';
-import { SearchField } from '@progress/kendo-react-data-tools';
 import { SelectDescriptor } from '@progress/kendo-react-data-tools';
 import { setSelectedState } from '@progress/kendo-react-data-tools';
 import { SortDescriptor } from '@progress/kendo-data-query';
@@ -56,8 +53,6 @@ import { TableKeyDownEvent } from '@progress/kendo-react-data-tools';
 import { TableSelectableMode } from '@progress/kendo-react-data-tools';
 import { TableSelectableSettings } from '@progress/kendo-react-data-tools';
 import { TableSelectionChangeEvent } from '@progress/kendo-react-data-tools';
-import { TextBoxChangeEvent } from '@progress/kendo-react-inputs';
-import { TextBoxProps } from '@progress/kendo-react-inputs';
 
 /**
  * The value of the filter operators displayed in the boolean filter menu.
@@ -252,7 +247,6 @@ declare interface ExtendedColumnProps extends GridColumnProps {
     isAccessible: boolean;
     /** @hidden _internal usage only */
     _type?: 'edit' | 'expand';
-    rowSpannable?: Required<GridRowSpannableSettings>;
 }
 
 /**
@@ -306,7 +300,7 @@ export declare const GRID_PREVENT_SELECTION_ELEMENT = "data-prevent-selection";
 /** The attribute required by the Grid selection on Grid `tr` elements. */
 export declare const GRID_ROW_INDEX_ATTRIBUTE = "data-grid-row-index";
 
-export declare const GridCell: (props: GridCellProps) => JSX_2.Element | null;
+export declare const GridCell: (props: GridCellProps) => JSX_2.Element;
 
 /**
  * Represents the `GridCellBaseOptions` object that are passed to the handler.
@@ -407,15 +401,6 @@ export declare interface GridCellProps extends Omit<CellProps, 'onChange' | 'ren
     columnPosition: any;
     /** @hidden */
     group?: GroupState;
-    /** @hidden */
-    localization?: LocalizationService;
-    /** @hidden */
-    intl?: IntlService;
-    /** @hidden */
-    _rowSpan?: {
-        count: number | null;
-        value: any;
-    };
 }
 
 /**
@@ -559,31 +544,6 @@ export declare interface GridColumnMenuColumnProps {
     id?: string;
 }
 
-/**
- * Represents the KendoReact GridColumnMenuColumnsChooser component.
- */
-export declare const GridColumnMenuColumnsChooser: React_2.FunctionComponent<GridColumnMenuColumnsChooserProps>;
-
-/**
- *  The props passed to the ColumnMenu ColumnsChooser component.
- */
-declare interface GridColumnMenuColumnsChooserBaseProps extends GridColumnMenuBaseProps {
-    /**
-     * The columns state of the KendoReact GridColumnMenuColumnsChooser component.
-     */
-    columnsState?: GridColumnState[];
-    /**
-     * The method that will be called when the new columns state is applied.
-     */
-    onColumnsStateChange?: Function;
-}
-
-/**
- * The props of the GridColumnMenuColumnsChooser component.
- */
-export declare interface GridColumnMenuColumnsChooserProps extends GridColumnMenuColumnsChooserBaseProps {
-}
-
 /**
  * Represents the KendoReact GridColumnMenuColumnsList component.
  */
@@ -911,7 +871,7 @@ declare interface GridColumnMenuItemProps {
 /**
  * The props which the ColumnMenu passes to its children.
  */
-export declare interface GridColumnMenuProps extends GridColumnMenuFilterBaseProps, GridColumnMenuSortBaseProps, GridColumnMenuGroupBaseProps, GridColumnMenuColumnsChooserBaseProps {
+export declare interface GridColumnMenuProps extends GridColumnMenuFilterBaseProps, GridColumnMenuSortBaseProps, GridColumnMenuGroupBaseProps {
     navigatable?: boolean;
     show?: boolean;
 }
@@ -1127,10 +1087,6 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
      * @default "data"
      */
     columnType?: GridColumnType;
-    /**
-     * Defines if the cells of the column should be spanned when their values are the same.
-     */
-    rowSpannable?: boolean | GridRowSpannableSettings;
 }
 
 /**
@@ -1204,46 +1160,6 @@ export declare interface GridColumnResizeEvent {
 declare interface GridColumnSortSettings extends ColumnSortSettings {
 }
 
-/**
- * Represents the object of the `onColumnsStateChange` Grid event.
- */
-export declare interface GridColumnsStateChangeEvent {
-    /**
-     * An event target.
-     */
-    target: GridHandle;
-    /**
-     * The columns state collection.
-     */
-    columnsState: GridColumnState[];
-}
-
-/**
- * The state of the GridColumn
- */
-export declare 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;
-    /**
-     * A collection of child states.
-     */
-    children?: GridColumnState[];
-}
-
 /**
  * Sets the column type.
  *
@@ -1473,20 +1389,6 @@ export declare interface GridCustomHeaderCellProps extends GridHeaderCellProps {
     index?: number;
 }
 
-/**
- * The properties of the default Grid Row.
- */
-export declare interface GridCustomRowProps extends GridRowProps {
-    /**
-     * The props and attributes that are applied to the tr element by default.
-     */
-    trProps?: React.HTMLAttributes<HTMLTableRowElement> | null;
-    /**
-     * The default children of the table row.
-     */
-    children?: React.ReactNode | React.ReactNode[];
-}
-
 /**
  * Represents the object of the `onDataStateChange` Grid event.
  */
@@ -2002,7 +1904,6 @@ export declare const gridMessages: {
     "grid.pagerOf": string;
     "grid.pagerTotalPages": string;
     "grid.searchPlaceholder": string;
-    "grid.searchboxPlaceholder": string;
     "grid.filterCheckAll": string;
     "grid.filterChooseOperator": string;
     "grid.filterSelectedItems": string;
@@ -2164,7 +2065,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
     /** @hidden */
     autoProcessData?: boolean | {
         filter?: boolean;
-        search?: boolean;
         sort?: boolean;
         group?: boolean;
         page?: boolean;
@@ -2182,10 +2082,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
      * Sets a set of custom components that the Grid will render instead of the built-in cell.
      */
     cells?: GridCellsSettings;
-    /**
-     * Sets a set of custom components that the Grid will render instead of the built-in row.
-     */
-    rows?: GridRowsSettings;
     /**
      * Sets the data of the Grid ([see example]({% slug paging_grid %})). If you use paging, the `data` option has to contain only the items for the current page. It takes values of type null, any or [DataResult]({% slug api_kendo-data-query_dataresult%})
      */
@@ -2199,9 +2095,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
      */
     clipboard?: ClipboardSettings | boolean;
     /**
-     * Fires when clipboard support is enabled and the one of the actions 'copy'. The event accepts type [GridClipboardEvent]({% slug api_data-tools_gridclipboardevent %}). Only fired when the Grid is run as a client component.
+     * Fires when clipboard support is enabled and the one of the actions 'copy'. The event accepts type [ClipboardDataEvent]({% slug api_data-tools_clipboarddataevent %}). Only fired when the Grid is run as a client component.
      */
-    onClipboard?: (event: GridClipboardEvent) => void;
+    onClipboard?: (event: ClipboardDataEvent) => void;
     /**
      * Fires when the sorting of the Grid is changed ([see example]({% slug sorting_grid %})). You have to handle the event yourself and sort the data.
      */
@@ -2230,14 +2126,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
      * Fires when the Grid filter is modified through the UI ([more information and examples]({% slug filtering_grid %})). You have to handle the event yourself and filter the data.
      */
     onFilterChange?: (event: GridFilterChangeEvent) => void;
-    /**
-     * Specifies if the loader of the Grid will be displayed.
-     */
-    showLoader?: boolean;
-    /**
-     * A custom component that the Grid will render instead of the built-in loader.
-     */
-    loader?: React.ReactNode;
     /**
      * Fires when the user reorders a row.
      */
@@ -2398,22 +2286,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
      * Specifies a React element that will be cloned and rendered inside the detail rows of the currently expanded items ([see example]({% slug hierarchy_grid %})). An item will be rendered as expanded if the value of its `expandField` is `true`.
      */
     detail?: null | ComponentType<GridDetailRowProps>;
-    /**
-     * The [descriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}) by which the data is searched. Its first FilterDescriptor populates the GridSearchBox.
-     */
-    search?: CompositeFilterDescriptor;
-    /**
-     * The [descriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}) by which the data is searched by default. Its first FilterDescriptor populates the GridSearchBox.
-     */
-    defaultSearch?: CompositeFilterDescriptor;
-    /**
-     * Defines the fields of the data that are filtered by the GridSearchBox.
-     */
-    searchFields?: (string | SearchField)[];
-    /**
-     * Fires when the search value of the GridSearchBox is changed.
-     */
-    onSearchChange?: (event: GridSearchChangeEvent) => void;
     /**
      * Represents the `style` HTML attribute.
      */
@@ -2526,22 +2398,6 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
      * @hidden
      */
     unstyled?: GridClassStructure;
-    /**
-     * @hidden
-     */
-    rowSpannable?: boolean | GridRowSpannableSettings;
-    /**
-     * @hidden
-     */
-    columnsState?: GridColumnState[];
-    /**
-     * @hidden
-     */
-    defaultColumnsState?: GridColumnState[];
-    /**
-     * Fires when the columns state of the Grid is changed.
-     */
-    onColumnsStateChange?: (event: GridColumnsStateChangeEvent) => void;
 }
 
 /**
@@ -2618,10 +2474,6 @@ export declare interface GridRowProps extends KendoReactComponentBaseProps {
      * A function for overriding the default rendering of the row.
      */
     render?: (row: React.ReactElement<HTMLTableRowElement>, props: GridRowProps) => React.ReactNode;
-    /**
-     * Sets a set of rows components that the Grid will render instead of the built-in row.
-     */
-    rows?: GridRowsSettings;
     /**
      * The index to be applied to the `aria-rowindex` attribute.
      */
@@ -2693,42 +2545,6 @@ export declare type GridRowReorderSettings = {
     dragClue?: string | ((dataItem: any) => React.ReactNode);
 };
 
-/**
- * Represents the settings for the row-spanning functionality of the Grid.
- *
- * @example
- *
- * ```tsx
- * <Grid
- *    data={data}
- *    rowSpannable={{
- *      enabled: true,
- *      valueGetter: (dataItem, field) => `${dataItem['id']} - ${dataItem[field]}`,
- *    }}
- * />
- * ```
- */
-export declare type GridRowSpannableSettings = {
-    /**
-     * Determines if the row-spanning functionality is enabled or disabled
-     */
-    enabled?: boolean;
-    /**
-     * A function that returns the value of the cell that should span the row.
-     * The value could be combined from multiple fields of the dataItem to create a unique identifier and prevent the cell from being row-spanned.
-     */
-    valueGetter?: (dataItem: any, field: string) => any;
-};
-
-/**
- * The settings of the rows prop options.
- */
-export declare interface GridRowsSettings {
-    groupHeader?: ComponentType<GridCustomRowProps>;
-    data?: ComponentType<GridCustomRowProps>;
-    groupFooter?: ComponentType<GridCustomRowProps>;
-}
-
 /**
  * The type of the GridRow component.
  *
@@ -2739,28 +2555,6 @@ export declare interface GridRowsSettings {
  */
 export declare type GridRowType = 'groupFooter' | 'groupHeader' | 'data';
 
-/**
- * Represents the properties of the KendoReact GridSearchBox component.
- */
-export declare const GridSearchBox: (props: GridSearchBoxProps) => JSX_2.Element;
-
-export declare interface GridSearchBoxChangeEvent extends TextBoxChangeEvent {
-}
-
-export declare interface GridSearchBoxProps extends TextBoxProps {
-    onChange?: (event: GridSearchBoxChangeEvent) => void;
-}
-
-/**
- * Represents the object of the `onSearchChange` Grid event.
- */
-export declare interface GridSearchChangeEvent extends GridEvent {
-    /**
-     * The new search based on the user action.
-     */
-    search: CompositeFilterDescriptor;
-}
-
 /**
  * Represents the available selection modes.
  */