@progress/kendo-vue-grid 11.0.0 → 11.0.1-develop.1

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.
@@ -24,8 +24,8 @@ import { GridRowsSettings } from './GridRowsSettings';
24
24
  import { GridSelectableSettings } from './GridSelectableSettings';
25
25
  import { AutoProcessDataConfig } from '../utils/dataProcessing';
26
26
  /**
27
- * Represents the CSV export options for the Grid component.
28
- * Extends CSVExportOptions from @progress/kendo-csv with all properties optional.
27
+ * Represents the CSV export options of the Grid.
28
+ * Extends `CSVExportOptions` from `@progress/kendo-csv` and makes all properties optional.
29
29
  *
30
30
  * @example
31
31
  * ```vue
@@ -50,8 +50,8 @@ export interface GridCSVExportOptions extends Omit<Partial<CSVExportOptions>, 'd
50
50
  */
51
51
  fileName?: string;
52
52
  /**
53
- * Optional data to export to CSV instead of using the Grid's data prop.
54
- * Useful when you want to export different data than what's displayed in the Grid.
53
+ * Sets the data to export to CSV instead of the Grid data.
54
+ * Use it when you want to export data that differs from the data the Grid shows.
55
55
  *
56
56
  * @example
57
57
  * ```vue
@@ -60,9 +60,9 @@ export interface GridCSVExportOptions extends Omit<Partial<CSVExportOptions>, 'd
60
60
  */
61
61
  data?: any[] | DataResult | null;
62
62
  /**
63
- * Specifies whether to export all pages or only the current page when paging is enabled.
64
- * When `true`, exports all data ignoring pagination.
65
- * When `false`, exports only the current page of data.
63
+ * Specifies whether to export all pages or only the current page when you enable paging.
64
+ * When `true`, the Grid exports all data and ignores paging.
65
+ * When `false`, the Grid exports only the data of the current page.
66
66
  *
67
67
  * @default true
68
68
  *
@@ -78,11 +78,11 @@ export interface GridCSVExportOptions extends Omit<Partial<CSVExportOptions>, 'd
78
78
  allPages?: boolean;
79
79
  }
80
80
  /**
81
- * Represents the props of the [Kendo UI for Vue Grid component]({% slug overview_grid %}).
81
+ * Represents the props of the [Kendo UI for Vue Grid component](slug:overview_grid).
82
82
  */
83
83
  export interface GridProps {
84
84
  /**
85
- * Sets the `id` property of the top div element of the component.
85
+ * Sets the `id` attribute of the top `div` element of the Grid.
86
86
  *
87
87
  * @example
88
88
  * ```vue
@@ -91,8 +91,8 @@ export interface GridProps {
91
91
  */
92
92
  id?: string;
93
93
  /**
94
- * Enables data-processing inside the GridComponent based on its state.
95
- * Provides an easy, built-in way to handle data operations like sorting, filtering, grouping, and paging.
94
+ * Enables built-in data processing in the Grid based on its state.
95
+ * The Grid handles data operations such as sorting, filtering, grouping, and paging for you.
96
96
  *
97
97
  * @default false
98
98
  *
@@ -111,30 +111,29 @@ export interface GridProps {
111
111
  */
112
112
  autoProcessData?: boolean | AutoProcessDataConfig;
113
113
  /**
114
- * Sets the Grid row key prop to the value of this field in the dataItem.
115
- * If not set, the dataItem index will be used for the row key, which
116
- * might lead to row not updated during paging or scrolling.
114
+ * Sets the field of the data item that the Grid uses as the row key.
115
+ * If you do not set it, the Grid uses the index of the data item as the row key.
116
+ * This can stop rows from updating during paging or scrolling.
117
117
  */
118
118
  dataItemKey?: string;
119
119
  /**
120
- * When set to `true` it sets the alternating of the rows per groups so each group could start
121
- * with the same color row. There is a known limitation when virtual scrolling with groups and
122
- * alternatePerGroup set to `true`- there may be a slight flicker of the alternating rows in
123
- * groups with larger amount of items - in this case we would rather recommend
124
- * using rowTemplates and set the row alternating based on the data or dataItems.
120
+ * When set to `true`, the Grid restarts the row alternation in each group, so every group starts
121
+ * with a row of the same color. Known limitation: when you use virtual scrolling with groups and set
122
+ * `alternatePerGroup` to `true`, the alternating rows in large groups may flicker slightly.
123
+ * In this case, use row templates and set the row alternation based on the data or `dataItems`.
125
124
  */
126
125
  alternatePerGroup?: boolean;
127
126
  /**
128
- * Sets the properties of the columns that are used by the Grid.
127
+ * Sets the properties of the columns that the Grid uses.
129
128
  */
130
129
  columns?: GridColumnProps[] | null;
131
130
  /**
132
- * Sets the data of the Grid ([see example]({% slug paging_grid %})). If you use paging,
133
- * the `data` option has to contain only the items for the current page.
131
+ * Sets the data of the Grid ([see example](slug:paging_grid)). If you use paging,
132
+ * the `dataItems` option must contain only the items for the current page.
134
133
  */
135
134
  dataItems?: any[] | DataResult | null;
136
135
  /**
137
- * Defines a set of custom cell components that the Grid will render instead of the default cells.
136
+ * Defines a set of custom cell components that the Grid renders instead of the default cells.
138
137
  *
139
138
  * @example
140
139
  * ```vue
@@ -147,7 +146,7 @@ export interface GridProps {
147
146
  */
148
147
  cells?: GridCellsSettings;
149
148
  /**
150
- * Defines a set of custom row components that the Grid will render instead of the default rows.
149
+ * Defines a set of custom row components that the Grid renders instead of the default rows.
151
150
  *
152
151
  * @example
153
152
  * ```vue
@@ -160,28 +159,28 @@ export interface GridProps {
160
159
  */
161
160
  rows?: GridRowsSettings;
162
161
  /**
163
- * Enables the sorting for the columns with their `field` option set
164
- * ([see example]({% slug sorting_grid %})).
162
+ * Enables sorting for the columns that have their `field` option set
163
+ * ([see example](slug:sorting_grid)).
165
164
  */
166
165
  sortable?: GridSortSettings;
167
166
  /**
168
- * Fires when the sorting of the Grid is changed ([see example]({% slug sorting_grid %})).
169
- * You have to handle the event yourself and sort the data.
167
+ * Fires when the sorting of the Grid changes ([see example](slug:sorting_grid)).
168
+ * You have to handle the event and sort the data yourself.
170
169
  */
171
170
  onSortchange?: (event: GridSortChangeEvent) => void;
172
171
  /**
173
- * The descriptors by which the data is sorted.
174
- * Applies the sorting styles and buttons to the affected columns.
172
+ * The default descriptors by which the Grid sorts the data in uncontrolled mode.
173
+ * The Grid applies the sorting styles and buttons to the affected columns.
175
174
  */
176
175
  defaultSort?: SortDescriptor[];
177
176
  /**
178
- * The descriptors by which the data is sorted.
179
- * Applies the sorting styles and buttons to the affected columns.
177
+ * The descriptors by which the Grid sorts the data.
178
+ * The Grid applies the sorting styles and buttons to the affected columns.
180
179
  */
181
180
  sort?: SortDescriptor[];
182
181
  /**
183
182
  * Enables the row pinning feature.
184
- * When `false` or omitted, the row pinning feature is inactive.
183
+ * When `false` or not set, row pinning is off.
185
184
  *
186
185
  * @example
187
186
  * ```vue
@@ -190,9 +189,9 @@ export interface GridProps {
190
189
  */
191
190
  pinnable?: boolean;
192
191
  /**
193
- * The array of data items pinned to the top of the Grid.
194
- * Pinned rows remain visible while the body scrolls and are immune to filtering and pagination.
195
- * Requires `pinnable={true}`.
192
+ * The data items that the Grid pins to the top.
193
+ * Pinned rows stay visible while the body scrolls. Filtering and paging do not affect them.
194
+ * Requires `pinnable` set to `true`.
196
195
  *
197
196
  * @example
198
197
  * ```vue
@@ -201,9 +200,9 @@ export interface GridProps {
201
200
  */
202
201
  pinnedTopRows?: any[];
203
202
  /**
204
- * The array of data items pinned to the bottom of the Grid.
205
- * Pinned rows remain visible while the body scrolls and are immune to filtering and pagination.
206
- * Requires `pinnable={true}`.
203
+ * The data items that the Grid pins to the bottom.
204
+ * Pinned rows stay visible while the body scrolls. Filtering and paging do not affect them.
205
+ * Requires `pinnable` set to `true`.
207
206
  *
208
207
  * @example
209
208
  * ```vue
@@ -212,8 +211,8 @@ export interface GridProps {
212
211
  */
213
212
  pinnedBottomRows?: any[];
214
213
  /**
215
- * The default `pinnedTopRows` state applied to the Grid when using uncontrolled mode.
216
- * Requires `pinnable={true}`.
214
+ * The default `pinnedTopRows` state that the Grid applies in uncontrolled mode.
215
+ * Requires `pinnable` set to `true`.
217
216
  *
218
217
  * @example
219
218
  * ```vue
@@ -222,8 +221,8 @@ export interface GridProps {
222
221
  */
223
222
  defaultPinnedTopRows?: any[];
224
223
  /**
225
- * The default `pinnedBottomRows` state applied to the Grid when using uncontrolled mode.
226
- * Requires `pinnable={true}`.
224
+ * The default `pinnedBottomRows` state that the Grid applies in uncontrolled mode.
225
+ * Requires `pinnable` set to `true`.
227
226
  *
228
227
  * @example
229
228
  * ```vue
@@ -232,8 +231,8 @@ export interface GridProps {
232
231
  */
233
232
  defaultPinnedBottomRows?: any[];
234
233
  /**
235
- * Fires when a row is pinned, unpinned, or moved between pinned zones.
236
- * Requires `pinnable={true}`.
234
+ * Fires when the user pins, unpins, or moves a row between the pinned zones.
235
+ * Requires `pinnable` set to `true`.
237
236
  *
238
237
  * @example
239
238
  * ```vue
@@ -245,12 +244,12 @@ export interface GridProps {
245
244
  */
246
245
  onRowpinchange?: (event: GridRowPinChangeEvent) => void;
247
246
  /**
248
- * Enables the filtering of the columns with their `field` option set
249
- * ([more information and examples]({% slug filtering_grid %})).
247
+ * Enables filtering for the columns that have their `field` option set
248
+ * ([more information and examples](slug:filtering_grid)).
250
249
  */
251
250
  filterable?: boolean;
252
251
  /**
253
- * The descriptor by which the data is searched. Its first FilterDescriptor populates the GridSearchBox.
252
+ * The descriptor by which the Grid searches the data. Its first `FilterDescriptor` fills the GridSearchBox.
254
253
  *
255
254
  * @example
256
255
  * ```vue
@@ -259,7 +258,7 @@ export interface GridProps {
259
258
  */
260
259
  search?: CompositeFilterDescriptor;
261
260
  /**
262
- * The descriptor by which the data is searched by default. Its first FilterDescriptor populates the GridSearchBox.
261
+ * The default descriptor by which the Grid searches the data. Its first `FilterDescriptor` fills the GridSearchBox.
263
262
  *
264
263
  * @example
265
264
  * ```vue
@@ -268,7 +267,7 @@ export interface GridProps {
268
267
  */
269
268
  defaultSearch?: CompositeFilterDescriptor;
270
269
  /**
271
- * Defines the fields of the data that are filtered by the GridSearchBox.
270
+ * Defines the data fields that the GridSearchBox filters.
272
271
  *
273
272
  * @example
274
273
  * ```vue
@@ -277,54 +276,56 @@ export interface GridProps {
277
276
  */
278
277
  searchFields?: (string | SearchField)[];
279
278
  /**
280
- * Fires when the search descriptor of the Grid is changed.
281
- * You have to handle the event yourself and search the data.
279
+ * Fires when the search descriptor of the Grid changes.
280
+ * You have to handle the event and search the data yourself.
282
281
  */
283
282
  onSearchchange?: (event: GridSearchChangeEvent) => void;
284
283
  /**
285
- * The default descriptor by which the data is filtered
286
- * ([more information and examples]({% slug filtering_grid %})).
284
+ * The default descriptor by which the Grid filters the data
285
+ * ([more information and examples](slug:filtering_grid)).
287
286
  */
288
287
  defaultFilter?: CompositeFilterDescriptor;
289
288
  /**
290
- * The descriptor by which the data is filtered
291
- * ([more information and examples]({% slug filtering_grid %})).
292
- * Affects the values and buttons in the `FilterRow` of the Grid.
289
+ * The descriptor by which the Grid filters the data
290
+ * ([more information and examples](slug:filtering_grid)).
291
+ * It affects the values and buttons in the `FilterRow` of the Grid.
293
292
  */
294
293
  filter?: CompositeFilterDescriptor;
295
294
  /**
296
- * The filter operators for the Grid filters.
295
+ * Sets the filter operators that the Grid filters use.
297
296
  */
298
297
  filterOperators?: GridFilterOperators;
299
298
  /**
300
- * Fires when the Grid filter is modified through the UI
301
- * ([more information and examples]({% slug filtering_grid %})).
302
- * You have to handle the event yourself and filter the data.
299
+ * Fires when the user changes the Grid filter through the UI
300
+ * ([more information and examples](slug:filtering_grid)).
301
+ * You have to handle the event and filter the data yourself.
303
302
  */
304
303
  onFilterchange?: (event: GridFilterChangeEvent) => void;
305
304
  /**
306
- * The collection of column states of the grid.
305
+ * The collection of column states of the Grid.
307
306
  */
308
307
  columnsState?: GridColumnState[];
309
308
  /**
310
- * The default collection of column states of the grid.
309
+ * The default collection of column states of the Grid.
311
310
  */
312
311
  defaultColumnsState?: GridColumnState[];
313
312
  /**
314
- * Defines if the column menu will be shown for the column.
315
- * Accepts Boolean, a Vue component, a `render` function, or a slot name
313
+ * Defines whether the Grid shows the column menu for its columns.
314
+ * Accepts a `boolean`, a Vue component, a `render` function, or a slot name.
316
315
  */
317
316
  columnMenu?: boolean | any;
318
317
  /**
319
- * Globally overrides the default(three vertical dots) column menu icon for the whole Grid. If set, the prop can be overridden on column level using the ([menuIcon]({% slug api_grid_gridcolumnprops %}#toc-menuicon)) property.
318
+ * Overrides the default column menu icon (three vertical dots) for the whole Grid. You can override it for a single column with the ([menuIcon](slug:api_grid_gridcolumnprops#toc-menuicon)) property.
320
319
  */
321
320
  columnMenuIcon?: SVGIcon;
322
321
  /**
323
- * Controls the ColumnMenu animation. By default, the opening and closing animations are enabled.
322
+ * Controls the animation of the column menu. By default, the Grid animates the opening and closing of the menu.
323
+ *
324
+ * @default true
324
325
  */
325
326
  columnMenuAnimate?: boolean | PopupAnimation;
326
327
  /**
327
- * The descriptor by which the group is expanded.
328
+ * The descriptor by which the Grid expands the groups.
328
329
  *
329
330
  * @example
330
331
  * ```vue
@@ -333,7 +334,7 @@ export interface GridProps {
333
334
  */
334
335
  groupExpand?: GroupExpandDescriptor[];
335
336
  /**
336
- * The default `groupExpand` state applied to the Grid when using uncontrolled mode.
337
+ * The default `groupExpand` state that the Grid applies in uncontrolled mode.
337
338
  *
338
339
  * @example
339
340
  * ```vue
@@ -346,7 +347,7 @@ export interface GridProps {
346
347
  */
347
348
  onGroupexpandchange?: (event: GridGroupExpandChangeEvent) => void;
348
349
  /**
349
- * The descriptor by which the detail rows are expanded.
350
+ * The descriptor by which the Grid expands the detail rows.
350
351
  *
351
352
  * @example
352
353
  * ```vue
@@ -355,7 +356,7 @@ export interface GridProps {
355
356
  */
356
357
  detailExpand?: DetailExpandDescriptor;
357
358
  /**
358
- * The default `detailExpand` state applied to the Grid when using uncontrolled mode.
359
+ * The default `detailExpand` state that the Grid applies in uncontrolled mode.
359
360
  *
360
361
  * @example
361
362
  * ```vue
@@ -368,12 +369,12 @@ export interface GridProps {
368
369
  */
369
370
  onDetailexpandchange?: (event: GridDetailExpandChangeEvent) => void;
370
371
  /**
371
- * The descriptors by which the data will be grouped
372
- * ([more information and examples]({% slug groupingbasics_grid %})).
372
+ * The descriptors by which the Grid groups the data
373
+ * ([more information and examples](slug:groupingbasics_grid)).
373
374
  */
374
375
  group?: GroupDescriptor[];
375
376
  /**
376
- * The default `group` state applied to the Grid when using uncontrolled mode.
377
+ * The default `group` state that the Grid applies in uncontrolled mode.
377
378
  *
378
379
  * @example
379
380
  * ```vue
@@ -382,15 +383,15 @@ export interface GridProps {
382
383
  */
383
384
  defaultGroup?: GroupDescriptor[];
384
385
  /**
385
- * Fires when the grouping of the Grid is changed. You have to handle the event yourself and group the data
386
- * ([more information and examples]({% slug groupingbasics_grid %})).
386
+ * Fires when the grouping of the Grid changes. You have to handle the event and group the data yourself
387
+ * ([more information and examples](slug:groupingbasics_grid)).
387
388
  */
388
389
  onGroupchange?: (event: GridGroupChangeEvent) => void;
389
390
  /**
390
- * Configures the pager of the Grid ([see example]({% slug paging_grid %})).
391
+ * Configures the pager of the Grid ([see example](slug:paging_grid)).
391
392
  *
392
393
  * The available options are:
393
- * - `buttonCount: Number`&mdash;Sets the maximum numeric buttons count before the buttons are collapsed.
394
+ * - `buttonCount: Number`&mdash;Sets the maximum number of numeric buttons before the buttons collapse.
394
395
  * - `info: Boolean`&mdash;Toggles the information about the current page and the total number of records.
395
396
  * - `type: PagerType`&mdash;Accepts the `numeric` (buttons with numbers)
396
397
  * and `input` (input for typing the page number) values.
@@ -399,16 +400,16 @@ export interface GridProps {
399
400
  */
400
401
  pageable?: GridPagerSettings | any;
401
402
  /**
402
- * Defines the page size that is used by the Grid pager
403
- * ([see example]({% slug paging_grid %})). Required by the paging functionality.
403
+ * Defines the page size of the Grid pager
404
+ * ([see example](slug:paging_grid)). The paging feature requires it.
404
405
  */
405
406
  pageSize?: number;
406
407
  /**
407
- * Alias of the `pageSize` property. If `take` is set, `pageSize` will be ignored.
408
+ * Alias of the `pageSize` property. If you set `take`, the Grid ignores `pageSize`.
408
409
  */
409
410
  take?: number;
410
411
  /**
411
- * The default `take` state applied to the Grid when using uncontrolled mode.
412
+ * The default `take` state that the Grid applies in uncontrolled mode.
412
413
  *
413
414
  * @example
414
415
  * ```vue
@@ -417,22 +418,22 @@ export interface GridProps {
417
418
  */
418
419
  defaultTake?: number;
419
420
  /**
420
- * Fires when the page of the Grid is changed ([see example]({% slug paging_grid %})).
421
- * You have to handle the event yourself and page the data.
421
+ * Fires when the page of the Grid changes ([see example](slug:paging_grid)).
422
+ * You have to handle the event and page the data yourself.
422
423
  */
423
424
  onPagechange?: (event: GridPageChangeEvent) => void;
424
425
  /**
425
426
  * Defines the total number of data items in all pages
426
- * ([see example]({% slug paging_grid %})). Required by the paging functionality.
427
+ * ([see example](slug:paging_grid)). The paging feature requires it.
427
428
  */
428
429
  total?: number;
429
430
  /**
430
- * Defines the number of records that will be skipped by the pager
431
- * ([see example]({% slug paging_grid %})). Required by the paging functionality.
431
+ * Defines the number of records that the pager skips
432
+ * ([see example](slug:paging_grid)). The paging feature requires it.
432
433
  */
433
434
  skip?: number;
434
435
  /**
435
- * The default `skip` state applied to the Grid when using uncontrolled mode.
436
+ * The default `skip` state that the Grid applies in uncontrolled mode.
436
437
  *
437
438
  * @example
438
439
  * ```vue
@@ -441,35 +442,38 @@ export interface GridProps {
441
442
  */
442
443
  defaultSkip?: number;
443
444
  /**
444
- * Deprecated. Use 'onDetailexpandchange' or 'onGroupexpandchange' instead.
445
+ * Deprecated. Use `onDetailexpandchange` or `onGroupexpandchange` instead.
446
+ *
447
+ * Fires when the user expands or collapses an item.
445
448
  */
446
449
  onExpandchange?: (event: GridExpandChangeEvent) => void;
447
450
  /**
448
- * Determines if the scroll position will be updated after a data change.
449
- * If set to `true`, the scroll will remain in the same position.
451
+ * Determines whether the Grid keeps the scroll position after a data change.
452
+ * When set to `true`, the scroll stays in the same position.
450
453
  */
451
454
  fixedScroll?: boolean;
452
455
  /**
453
456
  *
454
457
  * `obsolete` Will be removed in the next major release. Set `dataItemKey` property instead.
455
458
  *
456
- * Specifies the name of the field which will provide a Boolean representation
457
- * of the expanded state of the item ([see example]({% slug detailrow_grid %}).
459
+ * Specifies the name of the field that provides a `boolean` representation
460
+ * of the expanded state of the item ([see example](slug:detailrow_grid)).
458
461
  */
459
462
  expandField?: string;
460
463
  /**
461
464
  * `obsolete` Will be removed in the next major release. Use `selectable` instead.
465
+ *
466
+ * Specifies the name of the field that provides the selected state of the item.
462
467
  */
463
468
  selectedField?: string;
464
469
  /**
465
470
  * Fires when the user tries to select or deselect a row
466
- * ([see example]({% slug selection_grid %})).
471
+ * ([see example](slug:selection_grid)).
467
472
  */
468
473
  onSelectionchange?: (event: GridSelectionChangeEvent) => void;
469
474
  /**
470
- * The descriptor by which the highlight state of an item is defined.
471
- * Passing a boolean value will highlight the whole row, while passing an object will highlight individual cells by their field.
472
- *
475
+ * The descriptor that defines the highlight state of an item.
476
+ * Pass a `boolean` value to highlight the whole row. Pass an object to highlight individual cells by their field.
473
477
  */
474
478
  highlight?: {
475
479
  [id: string]: boolean | {
@@ -477,7 +481,7 @@ export interface GridProps {
477
481
  };
478
482
  };
479
483
  /**
480
- * The default `select` state applied to the Grid when using uncontrolled mode.
484
+ * The default `select` state that the Grid applies in uncontrolled mode.
481
485
  *
482
486
  * @example
483
487
  * ```vue
@@ -486,8 +490,8 @@ export interface GridProps {
486
490
  */
487
491
  defaultSelect?: SelectDescriptor;
488
492
  /**
489
- * The [descriptor](https://www.telerik.com/kendo-vue-ui/components/datatools/api/selectdescriptor) by which the selected state of an item is defined.
490
- * Passing a boolean value will select the whole row, while passing an array of strings will select individual.
493
+ * The [descriptor](https://www.telerik.com/kendo-vue-ui/components/datatools/api/selectdescriptor) that defines the selected state of an item.
494
+ * Maps each item's `dataItemKey` value to its selection state. Set the value to `true` to select the whole row, or to an array of column indexes to select individual cells.
491
495
  *
492
496
  * @example
493
497
  * ```vue
@@ -496,17 +500,17 @@ export interface GridProps {
496
500
  */
497
501
  select?: SelectDescriptor;
498
502
  /**
499
- * The Grid selectable settings.
503
+ * The selectable settings of the Grid.
500
504
  *
501
505
  * @example
502
506
  * ```vue
503
- * <Grid :selectable="{ enabled: true, mode: 'single' }}" />
507
+ * <Grid :selectable="{ enabled: true, mode: 'single' }" />
504
508
  * ```
505
509
  */
506
510
  selectable?: boolean | GridSelectableSettings;
507
511
  /**
508
- * Fires when the user clicks the checkbox of a column header whose `field` matches `selectedField`.
509
- * ([see example]({% slug selection_grid %})).
512
+ * Fires when the user clicks the checkbox of a column header whose `field` matches `selectedField`
513
+ * ([see example](slug:selection_grid)).
510
514
  */
511
515
  onHeaderselectionchange?: (event: GridHeaderSelectionChangeEvent) => void;
512
516
  /**
@@ -514,7 +518,7 @@ export interface GridProps {
514
518
  */
515
519
  onRowclick?: (event: GridRowClickEvent) => void;
516
520
  /**
517
- * Fires when the user double clicks a row.
521
+ * Fires when the user double-clicks a row.
518
522
  */
519
523
  onRowdblclick?: (event: GridRowClickEvent) => void;
520
524
  /**
@@ -522,7 +526,7 @@ export interface GridProps {
522
526
  */
523
527
  onCellclick?: (event: any) => void;
524
528
  /**
525
- * Fires when Grid is scrolled.
529
+ * Fires when the user scrolls the Grid.
526
530
  */
527
531
  onScroll?: (event: any) => void;
528
532
  /**
@@ -543,13 +547,13 @@ export interface GridProps {
543
547
  onCancel?: (event: GridCancelEvent) => void;
544
548
  /**
545
549
  * Fires when the user changes the values of the item.
546
- * The event is not debounced and fires on every `onChange` event of the input in the current `EditCell`.
547
- * ([more information and examples]({% slug editing_inline_grid %})).
550
+ * The event is not debounced. It fires on every `onChange` event of the input in the current `EditCell`
551
+ * ([more information and examples](slug:editing_inline_grid)).
548
552
  */
549
553
  onItemchange?: (event: GridItemChangeEvent) => void;
550
554
  /**
551
- * Specifies the name of the field which will provide a Boolean representation of the edit state of the current
552
- * item ([more information and examples]({% slug editing_inline_grid %})).
555
+ * Specifies the name of the field that provides a `boolean` representation of the edit state of the current
556
+ * item ([more information and examples](slug:editing_inline_grid)).
553
557
  */
554
558
  editField?: string;
555
559
  /**
@@ -562,19 +566,21 @@ export interface GridProps {
562
566
  */
563
567
  rowSpannable?: boolean | GridRowSpannableSettings;
564
568
  /**
565
- * A function that returns a custom class applied to the row.
569
+ * A function that returns a custom class for the row.
566
570
  *
567
- * @param item - the item for the row.
571
+ * @param item The data item of the row.
568
572
  */
569
573
  rowClass?: Function;
570
574
  /**
571
- * Defines the scroll mode that is used by the Grid ([see example]({% slug scrollmmodes_grid %}).
575
+ * Defines the scroll mode of the Grid ([see example](slug:scrollmmodes_grid)).
572
576
  *
573
577
  * The available options are:
574
578
  * - `none`&mdash;Renders no scrollbar.
575
- * - `scrollable`&mdash;This is the default scroll mode. It requires the setting of the `height` option.
576
- * - `virtual`&mdash;Displays no pager and renders a portion of the data (optimized rendering)
577
- * while the user is scrolling the content.
579
+ * - `scrollable`&mdash;The default scroll mode. It requires you to set the `height` option.
580
+ * - `virtual`&mdash;Displays no pager and renders only a part of the data (optimized rendering)
581
+ * while the user scrolls the content.
582
+ *
583
+ * @default 'scrollable'
578
584
  */
579
585
  scrollable?: string;
580
586
  /**
@@ -584,7 +590,7 @@ export interface GridProps {
584
590
  * - small
585
591
  * - medium
586
592
  *
587
- * @default `undefined`
593
+ * @default 'medium'
588
594
  */
589
595
  size?: 'small' | 'medium' | string;
590
596
  /**
@@ -598,87 +604,95 @@ export interface GridProps {
598
604
  */
599
605
  dir?: string;
600
606
  /**
601
- * Defines the row height and forces an equal height to all rows
602
- * ([see example]({% slug scrollmmodes_grid %})).
607
+ * Defines the row height and makes all rows the same height
608
+ * ([see example](slug:scrollmmodes_grid)).
603
609
  */
604
610
  rowHeight?: number;
605
611
  /**
606
- * Defines the height of the detail row and forces an equal height to all detail rows
612
+ * Defines the height of the detail row and makes all detail rows the same height.
607
613
  */
608
614
  detailRowHeight?: number;
609
615
  /**
610
- * Specifies a custom rendering that will be cloned and rendered inside the detail rows
611
- * of the currently expanded items ([see example]({% slug master_detail_grid %}).
616
+ * Specifies a custom rendering that the Grid clones and renders inside the detail rows
617
+ * of the expanded items ([see example](slug:master_detail_grid)).
612
618
  * Accepts a Vue component, a `render` function, or a slot name.
613
- * The expand will be active if the `dataItemKey` is set.
619
+ * The expand feature works when you set `dataItemKey`.
614
620
  */
615
621
  detail?: null | any;
616
622
  /**
617
- * Defines the GridColumnProps of the expand column.
623
+ * Defines the `GridColumnProps` of the expand column.
618
624
  */
619
625
  expandColumn?: GridColumnProps;
620
626
  /**
621
- * Represents the `style` HTML attribute.
627
+ * Sets the `style` HTML attribute of the Grid.
622
628
  */
623
629
  style?: any;
624
630
  /**
625
- * Fires when the data state of the Grid is changed.
631
+ * Fires when the data state of the Grid changes.
626
632
  */
627
633
  onDatastatechange?: (event: GridDataStateChangeEvent) => void;
628
634
  /**
629
- * If set to `true`, the user can resize columns by dragging the edges (resize handles) of their
630
- * header cells ([see example]({% slug resizing_columns_grid %}).
635
+ * When set to `true`, the user can resize columns by dragging the edges (resize handles) of their
636
+ * header cells ([see example](slug:resizing_columns_grid)).
631
637
  */
632
638
  resizable?: boolean;
633
639
  /**
634
- * If set to `true`, the user can reorder columns by dragging their
635
- * header cells ([see example]({% slug reordering_columns_grid %}).
640
+ * When set to `true`, the user can reorder columns by dragging their
641
+ * header cells ([see example](slug:reordering_columns_grid)).
636
642
  */
637
643
  reorderable?: boolean;
638
644
  /**
639
- * Determines if grouping by dragging and dropping the column headers is allowed
640
- * ([more information and examples]({% slug groupingbasics_grid %})).
645
+ * Determines whether the user can group the data by dragging and dropping the column headers
646
+ * ([more information and examples](slug:groupingbasics_grid)).
641
647
  */
642
648
  groupable?: GridGroupableSettings | boolean;
643
649
  /**
644
- * Fires when a column is resized
650
+ * Fires when the user resizes a column.
645
651
  */
646
652
  onColumnresize?: (event: GridColumnResizeEvent) => void;
647
653
  /**
648
- * Fires when columns are reordered.
654
+ * Fires when the user reorders the columns.
649
655
  */
650
656
  onColumnreorder?: (event: GridColumnReorderEvent) => void;
651
657
  /**
652
- * `obsolete` Will be removed in the next major release. Use 'rows' prop instead.
658
+ * `obsolete` Will be removed in the next major release. Use the `rows` prop instead.
659
+ *
660
+ * Defines a custom rendering for the rows.
653
661
  */
654
662
  rowRender?: string | boolean | ((h: any, defaultRendering: any | null, defaultSlots: any, props: any, listeners: any) => any);
655
663
  /**
656
- * `obsolete` Will be removed in the next major release. Use 'cells' prop instead.
664
+ * `obsolete` Will be removed in the next major release. Use the `cells` prop instead.
665
+ *
666
+ * Defines a custom rendering for the cells.
657
667
  */
658
668
  cellRender?: ((h: any, defaultRendering: any | null, props: GridCellProps, listeners: any) => any) | string | null | boolean;
659
669
  /**
660
- * `obsolete` Will be removed in the next major release. Use 'cells.filterCell' prop instead.
670
+ * `obsolete` Will be removed in the next major release. Use the `cells.filterCell` prop instead.
671
+ *
672
+ * Defines a custom rendering for the filter cells.
661
673
  */
662
674
  filterCellRender?: ((h: any, defaultRendering: any | null, props: GridCellProps, listeners: any) => any) | string | any;
663
675
  /**
664
- * `obsolete` Will be removed in the next major release. Use 'cells.headerCell' prop instead.
676
+ * `obsolete` Will be removed in the next major release. Use the `cells.headerCell` prop instead.
677
+ *
678
+ * Defines a custom rendering for the header cells.
665
679
  */
666
680
  headerCellRender?: ((h: any, defaultRendering: any | null, props: GridCellProps, listeners: any) => any) | string | any;
667
681
  /**
668
- * Specifies whether the loader of the Grid will be displayed.
682
+ * Specifies whether the Grid shows its loader.
669
683
  * Defaults to `false`.
670
684
  */
671
685
  showLoader?: boolean;
672
686
  /**
673
687
  *
674
- * The boolean option is `Deprecated`. Use 'showLoader' instead.
688
+ * The `boolean` option is `Deprecated`. Use `showLoader` instead.
675
689
  *
676
- * Defines if the loader will be shown. Accepts a slot name, a `render` function, or a Vue component.
690
+ * Defines the loader of the Grid. Accepts a slot name, a `render` function, or a Vue component.
677
691
  */
678
692
  loader?: Object | Function | string;
679
693
  /**
680
- * Defines if the group descriptor columns are locked (frozen or sticky).
681
- * Locked columns are the columns that are visible at all times while the user scrolls the component horizontally.
694
+ * Defines whether the group descriptor columns are locked (frozen or sticky).
695
+ * Locked columns stay visible while the user scrolls the Grid horizontally.
682
696
  * Defaults to `false`.
683
697
  *
684
698
  * @example
@@ -688,18 +702,18 @@ export interface GridProps {
688
702
  */
689
703
  lockGroups?: boolean;
690
704
  /**
691
- * Defines the custom rendering of the pager. Accepts a slot name, a `render` function, or a Vue component.
705
+ * Defines the custom rendering of the pager. Accepts a slot name, a `render` function, or a Vue component.
692
706
  */
693
707
  pager?: Object | Function | string | boolean;
694
708
  /**
695
- * Enables virtualization of the columns. If virtualization is
696
- * enabled, the columns outside the view are not rendered.
709
+ * Enables the virtualization of the columns. When you enable it,
710
+ * the Grid does not render the columns outside the view.
697
711
  */
698
712
  columnVirtualization?: boolean;
699
713
  /**
700
- * Configures the context menu of the Grid. If set to `true`, the default context menu is rendered.
701
- * Can be a `GridContextMenuOptions` object to configure head/body items separately,
702
- * or a function that returns the configuration based on cell options.
714
+ * Configures the context menu of the Grid. When set to `true`, the Grid renders the default context menu.
715
+ * Pass a `GridContextMenuOptions` object to configure the header and body items separately,
716
+ * or a function that returns the configuration based on the cell options.
703
717
  *
704
718
  * @example
705
719
  * ```vue
@@ -708,7 +722,7 @@ export interface GridProps {
708
722
  */
709
723
  contextMenu?: boolean | GridContextMenuOptions | ((options: GridCellBaseOptions) => boolean | GridContextMenuOptions);
710
724
  /**
711
- * Fires when the context menu is activated on a cell.
725
+ * Fires when the user opens the context menu on a cell.
712
726
  *
713
727
  * @example
714
728
  * ```vue
@@ -717,7 +731,7 @@ export interface GridProps {
717
731
  */
718
732
  onContextmenu?: (event: GridContextMenuEvent) => void;
719
733
  /**
720
- * Fires when a context menu item is clicked.
734
+ * Fires when the user clicks a context menu item.
721
735
  *
722
736
  * @example
723
737
  * ```vue
@@ -726,7 +740,7 @@ export interface GridProps {
726
740
  */
727
741
  onContextmenuitemclick?: (event: GridContextMenuItemClickEvent) => void;
728
742
  /**
729
- * Enables clipboard copy, cut, and paste manipulations. Accepts `ClipboardSettings` or a boolean value.
743
+ * Enables the copy, cut, and paste clipboard actions. Accepts `ClipboardSettings` or a `boolean` value.
730
744
  *
731
745
  * @example
732
746
  * ```vue
@@ -735,8 +749,8 @@ export interface GridProps {
735
749
  */
736
750
  clipboard?: ClipboardSettings | boolean;
737
751
  /**
738
- * Fires when clipboard support is enabled, and one of the actions (e.g., copy) is triggered.
739
- * Accepts a `GridClipboardEvent` object.
752
+ * Fires when you enable clipboard support and the user triggers one of the actions, for example, copy.
753
+ * Receives a `GridClipboardEvent` object.
740
754
  *
741
755
  * @example
742
756
  * ```vue
@@ -748,12 +762,19 @@ export interface GridProps {
748
762
  */
749
763
  onClipboard?: (event: GridClipboardEvent) => void;
750
764
  /**
751
- * If set to `true`, the user can use dedicated shortcuts to interact with the Grid.
752
- * By default, navigation is disabled and the Grid content is accessible in the normal tab sequence.
765
+ * When set to `true`, the user can use dedicated keyboard shortcuts to interact with the Grid.
766
+ * By default, keyboard navigation is off and the Grid content follows the normal tab sequence.
767
+ *
768
+ * @default false
769
+ *
770
+ * @remarks
771
+ * This property is related to accessibility.
753
772
  */
754
773
  navigatable?: boolean;
755
774
  /**
756
775
  * Deprecated. Not needed any more.
776
+ *
777
+ * @default 0
757
778
  */
758
779
  topCacheCount?: number;
759
780
  /**
@@ -766,25 +787,27 @@ export interface GridProps {
766
787
  allGroupedItems?: DataResult | null;
767
788
  /**
768
789
  *
769
- *`Deprecated` Use 'groupExpand' instead.
790
+ *`Deprecated` Use `groupExpand` instead.
791
+ *
792
+ * Passes the collection of all collapsed groups for every group level.
770
793
  *
771
- * Passes the collection of all collapsed groups for every grouped level.
794
+ * @default []
772
795
  */
773
796
  collapsedGroups?: any[][];
774
797
  /**
775
- * Deprecated. Not needed any more. Use 'dataItemKey' instead.
798
+ * Deprecated. Not needed any more. Use `dataItemKey` instead.
776
799
  */
777
800
  uniqueField?: string;
778
801
  /**
779
- * Fires when Grid keyboard navigation position is changed.
802
+ * Fires when the keyboard navigation position of the Grid changes.
780
803
  */
781
804
  onNavigationaction?: (event: GridNavigationActionEvent) => void;
782
805
  /**
783
- * Fires when the user press keyboard key.
806
+ * Fires when the user presses a keyboard key.
784
807
  */
785
808
  onKeydown?: (event: GridKeyDownEvent) => void;
786
809
  /**
787
- * Enables CSV export functionality when set to `true` or provides CSV export configuration options.
810
+ * Enables the CSV export when set to `true`, or sets the CSV export options.
788
811
  *
789
812
  * @example
790
813
  * ```vue
@@ -798,10 +821,10 @@ export interface GridProps {
798
821
  */
799
822
  csv?: boolean | GridCSVExportOptions;
800
823
  /**
801
- * A callback that receives the **raw source data** (before sort, filter, and group operations)
802
- * and returns a transformed array. Use it to filter out rows or modify values before CSV generation.
803
- * The returned array is then processed through the Grid's data operations (sort, filter, group)
804
- * before being exported.
824
+ * A callback that receives the **raw source data** (before sorting, filtering, and grouping)
825
+ * and returns a transformed array. Use it to filter out rows or change values before the Grid creates the CSV file.
826
+ * The Grid then applies its data operations (sort, filter, group) to the returned array
827
+ * before the export.
805
828
  *
806
829
  * @example
807
830
  * ```vue