@progress/kendo-react-grid 9.4.0-develop.27 → 9.4.0-develop.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.mts CHANGED
@@ -228,10 +228,6 @@ export declare const contextMenuItemsMap: {
228
228
  };
229
229
  };
230
230
 
231
- export { DetailExpandDescriptor }
232
-
233
- export { EditDescriptor }
234
-
235
231
  /**
236
232
  * @hidden
237
233
  */
@@ -1093,6 +1089,8 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
1093
1089
  media?: string;
1094
1090
  /**
1095
1091
  * Defines the component that will be rendered as a cell. If not set, a `GridCell` will be rendered by default.
1092
+ *
1093
+ * @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridcolumnprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
1096
1094
  */
1097
1095
  cell?: ComponentType<GridCellProps>;
1098
1096
  /**
@@ -1101,10 +1099,14 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
1101
1099
  cells?: GridCellsSettings;
1102
1100
  /**
1103
1101
  * Defines the component that will be rendered as a filter cell. If not set, a `GridFilterCell` will be rendered by default.
1102
+ *
1103
+ * @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridcolumnprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
1104
1104
  */
1105
1105
  filterCell?: ComponentType<GridFilterCellProps>;
1106
1106
  /**
1107
1107
  * Defines the component that will be rendered as a header cell. If not set, a `GridHeaderCell` will be rendered by default.
1108
+ *
1109
+ * @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridcolumnprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
1108
1110
  */
1109
1111
  headerCell?: ComponentType<GridHeaderCellProps>;
1110
1112
  /**
@@ -1119,6 +1121,8 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
1119
1121
  * )}
1120
1122
  * />
1121
1123
  * ```
1124
+ *
1125
+ * @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridcolumnprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
1122
1126
  */
1123
1127
  footerCell?: ComponentType<GridFooterCellProps>;
1124
1128
  /**
@@ -1562,10 +1566,10 @@ export declare interface GridDragSelectionReleaseEvent extends TableDragSelectio
1562
1566
  }
1563
1567
 
1564
1568
  /**
1565
- * TODO: uncomment
1566
- * Represents the Grid editable settings.
1569
+ * Represents the Grid editable settings:
1570
+ * - `enabled` &mdash; Determines if the editing is enabled.
1571
+ * - `mode` &mdash; Determines the editing mode.
1567
1572
  *
1568
- * @hidden
1569
1573
  */
1570
1574
  declare interface GridEditableSettings extends TableEditableSettings {
1571
1575
  }
@@ -1789,7 +1793,9 @@ export declare interface GridGroupChangeEvent extends GridEvent {
1789
1793
  group: GroupDescriptor[];
1790
1794
  }
1791
1795
 
1792
- /** @hidden */
1796
+ /**
1797
+ * Represents the Grid group expandable settings.
1798
+ */
1793
1799
  declare type GridGroupExpandableSettings = TableGroupExpandableSettings;
1794
1800
 
1795
1801
  /** @hidden */
@@ -2161,7 +2167,12 @@ declare type GridPagerType = 'numeric' | 'input';
2161
2167
  * Represents the props of the [KendoReact Grid component]({% slug overview_grid %}).
2162
2168
  */
2163
2169
  export declare interface GridProps extends KendoReactComponentBaseProps {
2164
- /** @hidden */
2170
+ /**
2171
+ * Enables data-processing inside the GridComponent based on it's state.
2172
+ * Provides an easy, built-in way to handle data operations like sorting, filtering, grouping, and paging.
2173
+ *
2174
+ * @default false
2175
+ */
2165
2176
  autoProcessData?: boolean | {
2166
2177
  filter?: boolean;
2167
2178
  search?: boolean;
@@ -2210,7 +2221,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2210
2221
  * The ([descriptors]({% slug api_kendo-data-query_sortdescriptor %})) by which the data is sorted. Applies the sorting styles and buttons to the affected columns.
2211
2222
  */
2212
2223
  sort?: SortDescriptor[];
2213
- /** @hidden */
2224
+ /**
2225
+ * The default `sort` state that will be applied to the Grid when using uncontrolled mode.
2226
+ */
2214
2227
  defaultSort?: SortDescriptor[];
2215
2228
  /**
2216
2229
  * Enables the filtering of the columns with their `field` option set ([more information and examples]({% slug filtering_grid %})).
@@ -2220,7 +2233,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2220
2233
  * The [descriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}) by which the data is filtered ([more information and examples]({% slug filtering_grid %})). This affects the values and buttons in the `FilterRow` of the Grid.
2221
2234
  */
2222
2235
  filter?: CompositeFilterDescriptor;
2223
- /** @hidden */
2236
+ /**
2237
+ * The default `filter` state that will be applied to the Grid when using uncontrolled mode.
2238
+ */
2224
2239
  defaultFilter?: CompositeFilterDescriptor;
2225
2240
  /**
2226
2241
  * The filter operators for the Grid filters.
@@ -2259,7 +2274,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2259
2274
  * ([more information and examples]({% slug groupingbasics_grid %})).
2260
2275
  */
2261
2276
  group?: GroupDescriptor[];
2262
- /** @hidden */
2277
+ /**
2278
+ * The default `group` state that will be applied to the Grid when using uncontrolled mode.
2279
+ */
2263
2280
  defaultGroup?: GroupDescriptor[];
2264
2281
  /**
2265
2282
  * Fires when the grouping of the Grid is changed. You have to handle the event yourself and group the data
@@ -2290,7 +2307,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2290
2307
  * Alias of `pageSize` property. If `take` is set, `pageSize` will be ignored.
2291
2308
  */
2292
2309
  take?: number;
2293
- /** @hidden */
2310
+ /**
2311
+ * The default `take` state that will be applied to the Grid when using uncontrolled mode.
2312
+ */
2294
2313
  defaultTake?: number;
2295
2314
  /**
2296
2315
  * Fires when the page of the Grid is changed ([see example]({% slug paging_grid %})). You have to handle the event yourself and page the data.
@@ -2304,36 +2323,60 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2304
2323
  * Defines the number of records that will be skipped by the pager ([see example]({% slug paging_grid %})). Required by the paging functionality.
2305
2324
  */
2306
2325
  skip?: number;
2307
- /** @hidden */
2326
+ /**
2327
+ * The default `skip` state that will be applied to the Grid when using uncontrolled mode.
2328
+ */
2308
2329
  defaultSkip?: number;
2309
2330
  /**
2310
2331
  * Determines if the scroll position will be updated after data change. If set to `true` the scroll will remain on the same position.
2311
2332
  */
2312
2333
  fixedScroll?: boolean;
2313
- /** @hidden */
2334
+ /**
2335
+ * The [descriptor]({% slug api_data-tools_detailexpanddescriptor %}) by which the detail-row is expanded.
2336
+ */
2314
2337
  detailExpand?: DetailExpandDescriptor;
2315
- /** @hidden */
2338
+ /**
2339
+ * The default `detailExpand` state that will be applied to the Grid when using uncontrolled mode.
2340
+ */
2316
2341
  defaultDetailExpand?: DetailExpandDescriptor;
2317
- /** @hidden */
2318
- /** @hidden */
2342
+ /**
2343
+ * Fires when the user expand or collapse a detail-row.
2344
+ */
2319
2345
  onDetailExpandChange?: (event: GridDetailExpandChangeEvent) => void;
2320
- /** @hidden */
2346
+ /**
2347
+ * The [descriptor]({% slug api_data-tools_groupexpanddescriptor %}) by which the group is expanded.
2348
+ */
2321
2349
  groupExpand?: GroupExpandDescriptor[];
2322
- /** @hidden */
2350
+ /**
2351
+ * The default `groupExpand` state that will be applied to the Grid when using uncontrolled mode.
2352
+ */
2323
2353
  defaultGroupExpand?: GroupExpandDescriptor[];
2324
- /** @hidden */
2354
+ /**
2355
+ * Fires when the user expands or collapse a group.
2356
+ */
2325
2357
  onGroupExpandChange?: (event: GridGroupExpandChangeEvent) => void;
2326
2358
  /**
2327
2359
  * Fires when the user tries to expand or collapse a row.
2360
+ *
2361
+ * @deprecated This prop is deprecated in favor of the [onDetailExpandChange]({% slug api_grid_gridprops %}#toc-ondetailexpandchange) and [onGroupExpandChange]({% slug api_grid_gridprops %}#toc-ongroupexpandchange) props.
2362
+ * We’re removing this prop in version 11.0.0.
2328
2363
  */
2329
2364
  onExpandChange?: (event: GridExpandChangeEvent) => void;
2330
2365
  /**
2331
2366
  * Specifies the name of the field which will provide a Boolean representation of the expanded state of the item ([see example]({% slug detailrow_grid %})).
2367
+ *
2368
+ * @deprecated This prop is deprecated in favor of the ([detailExpand]({% slug api_grid_gridprops %}#toc-detailexpand)) and ([groupExpand]({% slug api_grid_gridprops %}#toc-groupexpand)) props.
2369
+ * We’re removing this prop in version 11.0.0.
2332
2370
  */
2333
2371
  expandField?: string;
2334
- /** @hidden */
2372
+ /**
2373
+ * The [descriptor]({% slug api_data-tools_selectdescriptor %}) by which the selected state of an item is defined.
2374
+ * Passing a boolean value will select the whole row, while passing an array of strings will select individual.
2375
+ */
2335
2376
  select?: SelectDescriptor;
2336
- /** @hidden */
2377
+ /**
2378
+ * The default `select` state that will be applied to the Grid when using uncontrolled mode.
2379
+ */
2337
2380
  defaultSelect?: SelectDescriptor;
2338
2381
  /**
2339
2382
  * The Grid selectable settings.
@@ -2343,6 +2386,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2343
2386
  * Specifies the name of the field which will provide a:
2344
2387
  * - Boolean representation of the selected state of the item ([see example]({% slug selection_grid %})) for row selection
2345
2388
  * - String array of the selected columns of the item for cell selection
2389
+ *
2390
+ * @deprecated This prop is deprecated in favor of the ([select]({% slug api_grid_gridprops %}#toc-select)) prop.
2391
+ * We’re removing this prop in version 11.0.0.
2346
2392
  */
2347
2393
  selectedField?: string;
2348
2394
  /**
@@ -2365,16 +2411,27 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2365
2411
  * Fires when the user changes the values of the item. The event is not debounced and fires on every `onChange` event of the input in the current `EditCell` ([more information and examples]({% slug editing_inline_grid %})).
2366
2412
  */
2367
2413
  onItemChange?: (event: GridItemChangeEvent) => void;
2368
- /** @hidden */
2414
+ /**
2415
+ * The [descriptor]({% slug api_data-tools_editdescriptor %}) by which the in-edit mode of an item is defined.
2416
+ */
2369
2417
  edit?: EditDescriptor;
2370
- /** @hidden */
2418
+ /**
2419
+ * The default `edit` state that will be applied to the Grid when using uncontrolled mode.
2420
+ */
2371
2421
  defaultEdit?: EditDescriptor;
2372
- /** @hidden */
2422
+ /**
2423
+ * The Grid editable settings.
2424
+ */
2373
2425
  editable?: boolean | GridEditableSettings;
2374
- /** @hidden */
2426
+ /**
2427
+ * Fires when the user enters or exits an in-edit mode of a row or cell.
2428
+ */
2375
2429
  onEditChange?: (event: GridEditChangeEvent) => void;
2376
2430
  /**
2377
2431
  * Specifies the name of the field which will provide a Boolean representation of the edit state of the current item ([more information and examples]({% slug editing_inline_grid %})).
2432
+ *
2433
+ * @deprecated This prop is deprecated in favor of the ([edit]({% slug api_grid_gridprops %}#toc-edit)) prop.
2434
+ * We’re removing this prop in version 11.0.0.
2378
2435
  */
2379
2436
  editField?: string;
2380
2437
  /**
@@ -2450,18 +2507,26 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2450
2507
  onColumnReorder?: (event: GridColumnReorderEvent) => void;
2451
2508
  /**
2452
2509
  * Fires when a row is about to be rendered. Overrides the default appearance of the row.
2510
+ *
2511
+ * @deprecated This prop is deprecated in favor of the ([rows]({% slug api_grid_gridprops %}#toc-rows)) prop. We’re removing this prop in version 11.0.0.
2453
2512
  */
2454
2513
  rowRender?: (row: React.ReactElement<HTMLTableRowElement>, props: GridRowProps) => React.ReactNode;
2455
2514
  /**
2456
2515
  * Fires when a cell is about to be rendered. Used to override the default appearance of the cell ([see example]({% slug groupingaggregates_grid %})).
2516
+ *
2517
+ * @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
2457
2518
  */
2458
2519
  cellRender?: (defaultRendering: React.ReactElement<HTMLTableCellElement> | null, props: GridCellProps) => React.ReactElement<HTMLTableCellElement> | React.ReactElement<HTMLTableCellElement>[] | null;
2459
2520
  /**
2460
2521
  * Fires when a filter cell is about to be rendered. Overrides the default appearance of the filter cell.
2522
+ *
2523
+ * @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
2461
2524
  */
2462
2525
  filterCellRender?: (defaultRendering: React.ReactElement<any> | null, props: GridFilterCellProps) => React.ReactElement<any> | null;
2463
2526
  /**
2464
2527
  * Fires when a header cell is about to be rendered. Overrides the default appearance of the header cell.
2528
+ *
2529
+ * @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
2465
2530
  */
2466
2531
  headerCellRender?: (defaultRendering: React.ReactNode | null, props: GridHeaderCellProps) => React.ReactNode;
2467
2532
  /**
@@ -2910,8 +2975,6 @@ export declare interface GridToolbarProps {
2910
2975
  ariaControls?: string;
2911
2976
  }
2912
2977
 
2913
- export { GroupExpandDescriptor }
2914
-
2915
2978
  /**
2916
2979
  * @hidden
2917
2980
  */
@@ -2988,8 +3051,6 @@ export declare const rootFilterOrDefault: (rootFilter: CompositeFilterDescriptor
2988
3051
 
2989
3052
  declare type ScrollMode = 'none' | 'scrollable' | 'virtual';
2990
3053
 
2991
- export { SelectDescriptor }
2992
-
2993
3054
  /**
2994
3055
  * Represents a server counterpart of every Grid event. It strips out all arguments from the event that are not serializable to the server.
2995
3056
  */
package/index.d.ts CHANGED
@@ -228,10 +228,6 @@ export declare const contextMenuItemsMap: {
228
228
  };
229
229
  };
230
230
 
231
- export { DetailExpandDescriptor }
232
-
233
- export { EditDescriptor }
234
-
235
231
  /**
236
232
  * @hidden
237
233
  */
@@ -1093,6 +1089,8 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
1093
1089
  media?: string;
1094
1090
  /**
1095
1091
  * Defines the component that will be rendered as a cell. If not set, a `GridCell` will be rendered by default.
1092
+ *
1093
+ * @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridcolumnprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
1096
1094
  */
1097
1095
  cell?: ComponentType<GridCellProps>;
1098
1096
  /**
@@ -1101,10 +1099,14 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
1101
1099
  cells?: GridCellsSettings;
1102
1100
  /**
1103
1101
  * Defines the component that will be rendered as a filter cell. If not set, a `GridFilterCell` will be rendered by default.
1102
+ *
1103
+ * @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridcolumnprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
1104
1104
  */
1105
1105
  filterCell?: ComponentType<GridFilterCellProps>;
1106
1106
  /**
1107
1107
  * Defines the component that will be rendered as a header cell. If not set, a `GridHeaderCell` will be rendered by default.
1108
+ *
1109
+ * @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridcolumnprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
1108
1110
  */
1109
1111
  headerCell?: ComponentType<GridHeaderCellProps>;
1110
1112
  /**
@@ -1119,6 +1121,8 @@ export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
1119
1121
  * )}
1120
1122
  * />
1121
1123
  * ```
1124
+ *
1125
+ * @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridcolumnprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
1122
1126
  */
1123
1127
  footerCell?: ComponentType<GridFooterCellProps>;
1124
1128
  /**
@@ -1562,10 +1566,10 @@ export declare interface GridDragSelectionReleaseEvent extends TableDragSelectio
1562
1566
  }
1563
1567
 
1564
1568
  /**
1565
- * TODO: uncomment
1566
- * Represents the Grid editable settings.
1569
+ * Represents the Grid editable settings:
1570
+ * - `enabled` &mdash; Determines if the editing is enabled.
1571
+ * - `mode` &mdash; Determines the editing mode.
1567
1572
  *
1568
- * @hidden
1569
1573
  */
1570
1574
  declare interface GridEditableSettings extends TableEditableSettings {
1571
1575
  }
@@ -1789,7 +1793,9 @@ export declare interface GridGroupChangeEvent extends GridEvent {
1789
1793
  group: GroupDescriptor[];
1790
1794
  }
1791
1795
 
1792
- /** @hidden */
1796
+ /**
1797
+ * Represents the Grid group expandable settings.
1798
+ */
1793
1799
  declare type GridGroupExpandableSettings = TableGroupExpandableSettings;
1794
1800
 
1795
1801
  /** @hidden */
@@ -2161,7 +2167,12 @@ declare type GridPagerType = 'numeric' | 'input';
2161
2167
  * Represents the props of the [KendoReact Grid component]({% slug overview_grid %}).
2162
2168
  */
2163
2169
  export declare interface GridProps extends KendoReactComponentBaseProps {
2164
- /** @hidden */
2170
+ /**
2171
+ * Enables data-processing inside the GridComponent based on it's state.
2172
+ * Provides an easy, built-in way to handle data operations like sorting, filtering, grouping, and paging.
2173
+ *
2174
+ * @default false
2175
+ */
2165
2176
  autoProcessData?: boolean | {
2166
2177
  filter?: boolean;
2167
2178
  search?: boolean;
@@ -2210,7 +2221,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2210
2221
  * The ([descriptors]({% slug api_kendo-data-query_sortdescriptor %})) by which the data is sorted. Applies the sorting styles and buttons to the affected columns.
2211
2222
  */
2212
2223
  sort?: SortDescriptor[];
2213
- /** @hidden */
2224
+ /**
2225
+ * The default `sort` state that will be applied to the Grid when using uncontrolled mode.
2226
+ */
2214
2227
  defaultSort?: SortDescriptor[];
2215
2228
  /**
2216
2229
  * Enables the filtering of the columns with their `field` option set ([more information and examples]({% slug filtering_grid %})).
@@ -2220,7 +2233,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2220
2233
  * The [descriptor]({% slug api_kendo-data-query_compositefilterdescriptor %}) by which the data is filtered ([more information and examples]({% slug filtering_grid %})). This affects the values and buttons in the `FilterRow` of the Grid.
2221
2234
  */
2222
2235
  filter?: CompositeFilterDescriptor;
2223
- /** @hidden */
2236
+ /**
2237
+ * The default `filter` state that will be applied to the Grid when using uncontrolled mode.
2238
+ */
2224
2239
  defaultFilter?: CompositeFilterDescriptor;
2225
2240
  /**
2226
2241
  * The filter operators for the Grid filters.
@@ -2259,7 +2274,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2259
2274
  * ([more information and examples]({% slug groupingbasics_grid %})).
2260
2275
  */
2261
2276
  group?: GroupDescriptor[];
2262
- /** @hidden */
2277
+ /**
2278
+ * The default `group` state that will be applied to the Grid when using uncontrolled mode.
2279
+ */
2263
2280
  defaultGroup?: GroupDescriptor[];
2264
2281
  /**
2265
2282
  * Fires when the grouping of the Grid is changed. You have to handle the event yourself and group the data
@@ -2290,7 +2307,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2290
2307
  * Alias of `pageSize` property. If `take` is set, `pageSize` will be ignored.
2291
2308
  */
2292
2309
  take?: number;
2293
- /** @hidden */
2310
+ /**
2311
+ * The default `take` state that will be applied to the Grid when using uncontrolled mode.
2312
+ */
2294
2313
  defaultTake?: number;
2295
2314
  /**
2296
2315
  * Fires when the page of the Grid is changed ([see example]({% slug paging_grid %})). You have to handle the event yourself and page the data.
@@ -2304,36 +2323,60 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2304
2323
  * Defines the number of records that will be skipped by the pager ([see example]({% slug paging_grid %})). Required by the paging functionality.
2305
2324
  */
2306
2325
  skip?: number;
2307
- /** @hidden */
2326
+ /**
2327
+ * The default `skip` state that will be applied to the Grid when using uncontrolled mode.
2328
+ */
2308
2329
  defaultSkip?: number;
2309
2330
  /**
2310
2331
  * Determines if the scroll position will be updated after data change. If set to `true` the scroll will remain on the same position.
2311
2332
  */
2312
2333
  fixedScroll?: boolean;
2313
- /** @hidden */
2334
+ /**
2335
+ * The [descriptor]({% slug api_data-tools_detailexpanddescriptor %}) by which the detail-row is expanded.
2336
+ */
2314
2337
  detailExpand?: DetailExpandDescriptor;
2315
- /** @hidden */
2338
+ /**
2339
+ * The default `detailExpand` state that will be applied to the Grid when using uncontrolled mode.
2340
+ */
2316
2341
  defaultDetailExpand?: DetailExpandDescriptor;
2317
- /** @hidden */
2318
- /** @hidden */
2342
+ /**
2343
+ * Fires when the user expand or collapse a detail-row.
2344
+ */
2319
2345
  onDetailExpandChange?: (event: GridDetailExpandChangeEvent) => void;
2320
- /** @hidden */
2346
+ /**
2347
+ * The [descriptor]({% slug api_data-tools_groupexpanddescriptor %}) by which the group is expanded.
2348
+ */
2321
2349
  groupExpand?: GroupExpandDescriptor[];
2322
- /** @hidden */
2350
+ /**
2351
+ * The default `groupExpand` state that will be applied to the Grid when using uncontrolled mode.
2352
+ */
2323
2353
  defaultGroupExpand?: GroupExpandDescriptor[];
2324
- /** @hidden */
2354
+ /**
2355
+ * Fires when the user expands or collapse a group.
2356
+ */
2325
2357
  onGroupExpandChange?: (event: GridGroupExpandChangeEvent) => void;
2326
2358
  /**
2327
2359
  * Fires when the user tries to expand or collapse a row.
2360
+ *
2361
+ * @deprecated This prop is deprecated in favor of the [onDetailExpandChange]({% slug api_grid_gridprops %}#toc-ondetailexpandchange) and [onGroupExpandChange]({% slug api_grid_gridprops %}#toc-ongroupexpandchange) props.
2362
+ * We’re removing this prop in version 11.0.0.
2328
2363
  */
2329
2364
  onExpandChange?: (event: GridExpandChangeEvent) => void;
2330
2365
  /**
2331
2366
  * Specifies the name of the field which will provide a Boolean representation of the expanded state of the item ([see example]({% slug detailrow_grid %})).
2367
+ *
2368
+ * @deprecated This prop is deprecated in favor of the ([detailExpand]({% slug api_grid_gridprops %}#toc-detailexpand)) and ([groupExpand]({% slug api_grid_gridprops %}#toc-groupexpand)) props.
2369
+ * We’re removing this prop in version 11.0.0.
2332
2370
  */
2333
2371
  expandField?: string;
2334
- /** @hidden */
2372
+ /**
2373
+ * The [descriptor]({% slug api_data-tools_selectdescriptor %}) by which the selected state of an item is defined.
2374
+ * Passing a boolean value will select the whole row, while passing an array of strings will select individual.
2375
+ */
2335
2376
  select?: SelectDescriptor;
2336
- /** @hidden */
2377
+ /**
2378
+ * The default `select` state that will be applied to the Grid when using uncontrolled mode.
2379
+ */
2337
2380
  defaultSelect?: SelectDescriptor;
2338
2381
  /**
2339
2382
  * The Grid selectable settings.
@@ -2343,6 +2386,9 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2343
2386
  * Specifies the name of the field which will provide a:
2344
2387
  * - Boolean representation of the selected state of the item ([see example]({% slug selection_grid %})) for row selection
2345
2388
  * - String array of the selected columns of the item for cell selection
2389
+ *
2390
+ * @deprecated This prop is deprecated in favor of the ([select]({% slug api_grid_gridprops %}#toc-select)) prop.
2391
+ * We’re removing this prop in version 11.0.0.
2346
2392
  */
2347
2393
  selectedField?: string;
2348
2394
  /**
@@ -2365,16 +2411,27 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2365
2411
  * Fires when the user changes the values of the item. The event is not debounced and fires on every `onChange` event of the input in the current `EditCell` ([more information and examples]({% slug editing_inline_grid %})).
2366
2412
  */
2367
2413
  onItemChange?: (event: GridItemChangeEvent) => void;
2368
- /** @hidden */
2414
+ /**
2415
+ * The [descriptor]({% slug api_data-tools_editdescriptor %}) by which the in-edit mode of an item is defined.
2416
+ */
2369
2417
  edit?: EditDescriptor;
2370
- /** @hidden */
2418
+ /**
2419
+ * The default `edit` state that will be applied to the Grid when using uncontrolled mode.
2420
+ */
2371
2421
  defaultEdit?: EditDescriptor;
2372
- /** @hidden */
2422
+ /**
2423
+ * The Grid editable settings.
2424
+ */
2373
2425
  editable?: boolean | GridEditableSettings;
2374
- /** @hidden */
2426
+ /**
2427
+ * Fires when the user enters or exits an in-edit mode of a row or cell.
2428
+ */
2375
2429
  onEditChange?: (event: GridEditChangeEvent) => void;
2376
2430
  /**
2377
2431
  * Specifies the name of the field which will provide a Boolean representation of the edit state of the current item ([more information and examples]({% slug editing_inline_grid %})).
2432
+ *
2433
+ * @deprecated This prop is deprecated in favor of the ([edit]({% slug api_grid_gridprops %}#toc-edit)) prop.
2434
+ * We’re removing this prop in version 11.0.0.
2378
2435
  */
2379
2436
  editField?: string;
2380
2437
  /**
@@ -2450,18 +2507,26 @@ export declare interface GridProps extends KendoReactComponentBaseProps {
2450
2507
  onColumnReorder?: (event: GridColumnReorderEvent) => void;
2451
2508
  /**
2452
2509
  * Fires when a row is about to be rendered. Overrides the default appearance of the row.
2510
+ *
2511
+ * @deprecated This prop is deprecated in favor of the ([rows]({% slug api_grid_gridprops %}#toc-rows)) prop. We’re removing this prop in version 11.0.0.
2453
2512
  */
2454
2513
  rowRender?: (row: React.ReactElement<HTMLTableRowElement>, props: GridRowProps) => React.ReactNode;
2455
2514
  /**
2456
2515
  * Fires when a cell is about to be rendered. Used to override the default appearance of the cell ([see example]({% slug groupingaggregates_grid %})).
2516
+ *
2517
+ * @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
2457
2518
  */
2458
2519
  cellRender?: (defaultRendering: React.ReactElement<HTMLTableCellElement> | null, props: GridCellProps) => React.ReactElement<HTMLTableCellElement> | React.ReactElement<HTMLTableCellElement>[] | null;
2459
2520
  /**
2460
2521
  * Fires when a filter cell is about to be rendered. Overrides the default appearance of the filter cell.
2522
+ *
2523
+ * @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
2461
2524
  */
2462
2525
  filterCellRender?: (defaultRendering: React.ReactElement<any> | null, props: GridFilterCellProps) => React.ReactElement<any> | null;
2463
2526
  /**
2464
2527
  * Fires when a header cell is about to be rendered. Overrides the default appearance of the header cell.
2528
+ *
2529
+ * @deprecated This prop is deprecated in favor of the ([cells]({% slug api_grid_gridprops %}#toc-cells)) prop. We’re removing this prop in version 11.0.0.
2465
2530
  */
2466
2531
  headerCellRender?: (defaultRendering: React.ReactNode | null, props: GridHeaderCellProps) => React.ReactNode;
2467
2532
  /**
@@ -2910,8 +2975,6 @@ export declare interface GridToolbarProps {
2910
2975
  ariaControls?: string;
2911
2976
  }
2912
2977
 
2913
- export { GroupExpandDescriptor }
2914
-
2915
2978
  /**
2916
2979
  * @hidden
2917
2980
  */
@@ -2988,8 +3051,6 @@ export declare const rootFilterOrDefault: (rootFilter: CompositeFilterDescriptor
2988
3051
 
2989
3052
  declare type ScrollMode = 'none' | 'scrollable' | 'virtual';
2990
3053
 
2991
- export { SelectDescriptor }
2992
-
2993
3054
  /**
2994
3055
  * Represents a server counterpart of every Grid event. It strips out all arguments from the event that are not serializable to the server.
2995
3056
  */
@@ -5,4 +5,4 @@
5
5
  * Licensed under commercial license. See LICENSE.md in the package root for more information
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e={name:"@progress/kendo-react-grid",productName:"KendoReact",productCode:"KENDOUIREACT",productCodes:["KENDOUIREACT"],publishDate: 1739192167,version:"9.4.0-develop.27",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"};exports.packageMetadata=e;
8
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e={name:"@progress/kendo-react-grid",productName:"KendoReact",productCode:"KENDOUIREACT",productCodes:["KENDOUIREACT"],publishDate: 1739278473,version:"9.4.0-develop.29",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"};exports.packageMetadata=e;
@@ -10,8 +10,8 @@ const e = {
10
10
  productName: "KendoReact",
11
11
  productCode: "KENDOUIREACT",
12
12
  productCodes: ["KENDOUIREACT"],
13
- publishDate: 1739192167,
14
- version: "9.4.0-develop.27",
13
+ publishDate: 1739278473,
14
+ version: "9.4.0-develop.29",
15
15
  licensingDocsUrl: "https://www.telerik.com/kendo-react-ui/components/my-license/"
16
16
  };
17
17
  export {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@progress/kendo-react-grid",
3
- "version": "9.4.0-develop.27",
3
+ "version": "9.4.0-develop.29",
4
4
  "description": "React Data Grid (Table) provides 100+ ready-to-use data grid features. KendoReact Grid package",
5
5
  "author": "Progress",
6
6
  "license": "SEE LICENSE IN LICENSE.md",
@@ -28,17 +28,17 @@
28
28
  "@progress/kendo-data-query": "^1.0.0",
29
29
  "@progress/kendo-drawing": "^1.21.2",
30
30
  "@progress/kendo-licensing": "^1.4.0",
31
- "@progress/kendo-react-animation": "9.4.0-develop.27",
32
- "@progress/kendo-react-buttons": "9.4.0-develop.27",
33
- "@progress/kendo-react-common": "9.4.0-develop.27",
34
- "@progress/kendo-react-data-tools": "9.4.0-develop.27",
35
- "@progress/kendo-react-dateinputs": "9.4.0-develop.27",
36
- "@progress/kendo-react-indicators": "9.4.0-develop.27",
37
- "@progress/kendo-react-dropdowns": "9.4.0-develop.27",
38
- "@progress/kendo-react-inputs": "9.4.0-develop.27",
39
- "@progress/kendo-react-intl": "9.4.0-develop.27",
40
- "@progress/kendo-react-popup": "9.4.0-develop.27",
41
- "@progress/kendo-react-layout": "9.4.0-develop.27",
31
+ "@progress/kendo-react-animation": "9.4.0-develop.29",
32
+ "@progress/kendo-react-buttons": "9.4.0-develop.29",
33
+ "@progress/kendo-react-common": "9.4.0-develop.29",
34
+ "@progress/kendo-react-data-tools": "9.4.0-develop.29",
35
+ "@progress/kendo-react-dateinputs": "9.4.0-develop.29",
36
+ "@progress/kendo-react-indicators": "9.4.0-develop.29",
37
+ "@progress/kendo-react-dropdowns": "9.4.0-develop.29",
38
+ "@progress/kendo-react-inputs": "9.4.0-develop.29",
39
+ "@progress/kendo-react-intl": "9.4.0-develop.29",
40
+ "@progress/kendo-react-popup": "9.4.0-develop.29",
41
+ "@progress/kendo-react-layout": "9.4.0-develop.29",
42
42
  "@progress/kendo-svg-icons": "^4.0.0",
43
43
  "react": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc",
44
44
  "react-dom": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc"
@@ -84,7 +84,7 @@
84
84
  "package": {
85
85
  "productName": "KendoReact",
86
86
  "productCode": "KENDOUIREACT",
87
- "publishDate": 1739192167,
87
+ "publishDate": 1739278473,
88
88
  "licensingDocsUrl": "https://www.telerik.com/kendo-react-ui/components/my-license/"
89
89
  }
90
90
  },