@progress/kendo-vue-grid 11.0.0-develop.1 → 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.
package/Grid.d.ts CHANGED
@@ -366,7 +366,7 @@ declare const Grid: import('vue').DefineComponent<import('vue').ExtractPropTypes
366
366
  filterHiddenColumns(columns: GridColumnProps[]): GridColumnProps[];
367
367
  /**
368
368
  * A getter of the current columns. Gets the current column width or current columns,
369
- * or any other [`GridColumnProps`]({% slug api_grid_gridcolumnprops %}) for each defined column.
369
+ * or any other [`GridColumnProps`](slug:api_grid_gridcolumnprops) for each defined column.
370
370
  * Can be used on each Grid instance. To obtain the instance of the rendered Grid, use the `ref`
371
371
  * callback. The following example demonstrates how to reorder the columns by dragging their handlers
372
372
  * and check the properties afterwards. You can check the result in the browser console.
package/Grid.mjs CHANGED
@@ -611,7 +611,7 @@ const bi = /* @__PURE__ */ bt({
611
611
  },
612
612
  /**
613
613
  * A getter of the current columns. Gets the current column width or current columns,
614
- * or any other [`GridColumnProps`]({% slug api_grid_gridcolumnprops %}) for each defined column.
614
+ * or any other [`GridColumnProps`](slug:api_grid_gridcolumnprops) for each defined column.
615
615
  * Can be used on each Grid instance. To obtain the instance of the rendered Grid, use the `ref`
616
616
  * callback. The following example demonstrates how to reorder the columns by dragging their handlers
617
617
  * and check the properties afterwards. You can check the result in the browser console.
@@ -10,8 +10,8 @@ import { SVGIcon } from '@progress/kendo-vue-common';
10
10
  import { ButtonProps } from '@progress/kendo-vue-buttons';
11
11
  /**
12
12
  * Represents the props of the GridCsvExportButton component.
13
- * Extends the [ButtonProps]({% slug api_buttons_buttonprops %}) interface,
14
- * forwarding all Button props to the underlying Button component.
13
+ * Extends the [ButtonProps](slug:api_buttons_buttonprops) interface and passes
14
+ * all Button props to the inner Button component.
15
15
  */
16
16
  export interface GridCsvExportButtonProps extends ButtonProps {
17
17
  }
@@ -43,8 +43,13 @@ export declare const buttonPropsDefinition: {
43
43
  type: PropType<string>;
44
44
  };
45
45
  /**
46
- * Represents the GridCsvExportButton component.
47
- * Renders a button that triggers CSV export of the Grid data.
46
+ * Represents the KendoVue GridCsvExportButton component. It renders a button that exports the Grid data to CSV
47
+ * ([see example](slug:overview_csvexport_grid)).
48
+ *
49
+ * @example
50
+ * ```vue
51
+ * <GridCsvExportButton :theme-color="'primary'" />
52
+ * ```
48
53
  */
49
54
  declare const GridCsvExportButton: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
50
55
  themeColor: PropType<"base" | "primary" | "secondary" | "tertiary" | "info" | "success" | "warning" | "error" | "inverse">;
@@ -7,7 +7,7 @@
7
7
  */
8
8
  import { TextBoxChangeEvent, TextBoxProps } from '@progress/kendo-vue-inputs';
9
9
  /**
10
- * Represents the event object of the GridSearchBox `onChange` event.
10
+ * Represents the object of the `onChange` event of the GridSearchBox.
11
11
  */
12
12
  export interface GridSearchBoxChangeEvent extends TextBoxChangeEvent {
13
13
  }
@@ -16,12 +16,18 @@ export interface GridSearchBoxChangeEvent extends TextBoxChangeEvent {
16
16
  */
17
17
  export interface GridSearchBoxProps extends TextBoxProps {
18
18
  /**
19
- * Fires when the value of the search box is changed.
19
+ * Fires when the value of the search box changes.
20
20
  */
21
21
  onChange?: (event: GridSearchBoxChangeEvent) => void;
22
22
  }
23
23
  /**
24
- * Represents the properties of the KendoVue GridSearchBox component.
24
+ * Represents the KendoVue GridSearchBox component. Place it inside the GridToolbar to search the data of the Grid
25
+ * ([see example](slug:global-filtering_grid)).
26
+ *
27
+ * @example
28
+ * ```vue
29
+ * <GridSearchBox :placeholder="'Search products...'" />
30
+ * ```
25
31
  */
26
32
  export declare const GridSearchBox: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
27
33
  onChange: FunctionConstructor;
package/GridToolbar.d.ts CHANGED
@@ -7,8 +7,17 @@
7
7
  */
8
8
  import { PropType } from 'vue';
9
9
  /**
10
- * Represents the GridToolbar component.
10
+ * Represents the KendoVue GridToolbar component. Place it inside the Grid to render a toolbar above the Grid header.
11
11
  *
12
+ * @example
13
+ * ```vue
14
+ * <GridToolbar :size="'medium'">
15
+ * <GridSearchBox />
16
+ * </GridToolbar>
17
+ * ```
18
+ *
19
+ * @remarks
20
+ * Supported children components are: {@link GridSearchBox}, {@link GridCsvExportButton}.
12
21
  */
13
22
  declare const GridToolbar: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
14
23
  size: {
package/NOTICE.txt CHANGED
@@ -1,18 +1,18 @@
1
1
 
2
- Progress Kendo UI for Vue 2026 Updated August 2026
2
+ Progress Kendo UI for Vue 2026 Updated November 2026
3
3
 
4
4
  ----------------------------------------------------------------------------------------------------------------------------
5
5
  NOTICES REPORT
6
6
  ----------------------------------------------------------------------------------------------------------------------------
7
7
 
8
8
  Portions of the Products include certain open source and commercial third-party components listed below ("Third-Party
9
- Components"). The authors of the Third-Party Components require Progress Software Corporation ("PSC") to include the
10
- following notices and additional licensing terms as a condition of PSC's use of such Third-Party Components. You
11
- acknowledge that the authors of the Third-Party Components have no obligation to provide support to you for the Third-Party
12
- Components or the Product. You hereby undertake to comply with all licenses related to the applicable Third-Party
9
+ Components"). The authors of the Third-Party Components require Progress Software Corporation ("PSC") to include
10
+ the following notices and additional licensing terms as a condition of PSC's use of such Third-Party Components. You
11
+ acknowledge that the authors of the Third-Party Components have no obligation to provide support to you for the Third-
12
+ Party Components or the Product. You hereby undertake to comply with all licenses related to the applicable Third-Party
13
13
  Components. Notwithstanding anything to the contrary, to the extent that any of the terms and conditions of the Progress
14
- Agreement conflict, vary, or are in addition to the terms and conditions of the aforementioned third-party licenses for these
15
- technologies, such terms and conditions are offered by PSC alone and not by any other party.
14
+ Agreement conflict, vary, or are in addition to the terms and conditions of the aforementioned third-party licenses for
15
+ these technologies, such terms and conditions are offered by PSC alone and not by any other party.
16
16
 
17
17
  ----------------------------------------------------------------------------------------------------------------------------
18
18
  Report Content
@@ -28,8 +28,8 @@
28
28
  GENERATIVE ARTIFICIAL INTELLIGENCE INTEGRATION
29
29
  If the Software documentation specifies integration with some form of generative artificial intelligence (AI), then the
30
30
  Software will include a configuration to connect to AI. You acknowledge that a separate license or subscription access
31
- to AI governed by the terms and conditions of a license agreement from AI licensor will be required for use and access of
32
- AI capabilities integrated with the Software. You will be responsible to comply with the terms of such license agreement
31
+ to AI governed by the terms and conditions of a license agreement from AI licensor will be required for use and access
32
+ of AI capabilities integrated with the Software. You will be responsible to comply with the terms of such license agreement
33
33
  for a valid use of AI. You acknowledge and accept that Progress is not a party to the license agreement between You
34
34
  and AI licensor for AI use, and as a result Progress does not have any control over AI and its availability, and Progress
35
35
  disclaims any and all liabilities for any output, error, damages, loss, etc., or any other result of Your use of AI
@@ -37,8 +37,8 @@
37
37
 
38
38
  ----------------------------------------------------------------------------------------------------------------------------
39
39
 
40
- NOTICE FROM PROGRESS SOFTWARE CORPORATION: Additional notices may be included in the release notes or other
41
- documentation that accompanies updates received in connection with support of the Product.
40
+ NOTICE FROM PROGRESS SOFTWARE CORPORATION: Additional notices may be included in the release notes or
41
+ other documentation that accompanies updates received in connection with support of the Product.
42
42
 
43
43
  ----------------------------------------------------------------------------------------------------------------------------
44
44
 
@@ -52,9 +52,9 @@ Components:
52
52
  | | readme | |
53
53
  | @progress/pako-esm 1.0.1 | https://github.com/telerik/pako-esm#r | MIT License |
54
54
  | | eadme | |
55
- | prosemirror-commands 1.7.1 | https://github.com/prosemirror/prosem | MIT License |
55
+ | prosemirror-commands 1.7.2 | https://github.com/prosemirror/prosem | MIT License |
56
56
  | | irror-commands#readme | |
57
- | prosemirror-dropcursor 1.8.2 | https://github.com/prosemirror/prosem | MIT License |
57
+ | prosemirror-dropcursor 1.8.3 | https://github.com/prosemirror/prosem | MIT License |
58
58
  | | irror-dropcursor#readme | |
59
59
  | prosemirror-gapcursor 1.4.1 | https://github.com/prosemirror/prosem | MIT License |
60
60
  | | irror-gapcursor#readme | |
@@ -64,7 +64,7 @@ Components:
64
64
  | | irror-inputrules#readme | |
65
65
  | prosemirror-keymap 1.2.3 | https://github.com/prosemirror/prosem | MIT License |
66
66
  | | irror-keymap#readme | |
67
- | prosemirror-model 1.25.9 | https://github.com/prosemirror/prosem | MIT License |
67
+ | prosemirror-model 1.25.12 | https://github.com/prosemirror/prosem | MIT License |
68
68
  | | irror-model#readme | |
69
69
  | prosemirror-schema-list 1.5.1 | https://github.com/prosemirror/prosem | MIT License |
70
70
  | | irror-schema-list#readme | |
@@ -72,9 +72,9 @@ Components:
72
72
  | | irror-state#readme | |
73
73
  | prosemirror-tables 1.8.5 | https://github.com/prosemirror/prosem | MIT License |
74
74
  | | irror-tables#readme | |
75
- | prosemirror-transform 1.10.5 | https://github.com/prosemirror/prosem | MIT License |
75
+ | prosemirror-transform 1.12.1 | https://github.com/prosemirror/prosem | MIT License |
76
76
  | | irror-transform#readme | |
77
- | prosemirror-view 1.41.6 | https://github.com/prosemirror/prosem | MIT License |
77
+ | prosemirror-view 1.42.5 | https://github.com/prosemirror/prosem | MIT License |
78
78
  | | irror-view#readme | |
79
79
  | -------------------------------------- | ------------------------------------- | ---------------------------------------- |
80
80
 
@@ -269,7 +269,7 @@ third-party archives.
269
269
  ---
270
270
 
271
271
  MIT License
272
- (@progress/jszip-esm 1.0.4, @progress/pako-esm 1.0.1, prosemirror-commands 1.7.1, prosemirror-dropcursor 1.8.2, prosemirror-gapcursor 1.4.1, prosemirror-history 1.5.0, prosemirror-inputrules 1.5.1, prosemirror-keymap 1.2.3, prosemirror-model 1.25.9, prosemirror-schema-list 1.5.1, prosemirror-state 1.4.4, prosemirror-tables 1.8.5, prosemirror-transform 1.10.5, prosemirror-view 1.41.6)
272
+ (@progress/jszip-esm 1.0.4, @progress/pako-esm 1.0.1, prosemirror-commands 1.7.2, prosemirror-dropcursor 1.8.3, prosemirror-gapcursor 1.4.1, prosemirror-history 1.5.0, prosemirror-inputrules 1.5.1, prosemirror-keymap 1.2.3, prosemirror-model 1.25.12, prosemirror-schema-list 1.5.1, prosemirror-state 1.4.4, prosemirror-tables 1.8.5, prosemirror-transform 1.12.1, prosemirror-view 1.42.5)
273
273
 
274
274
  The MIT License
275
275
  ===============
package/RootGrid.d.ts CHANGED
@@ -8,7 +8,7 @@
8
8
  import { GridProps } from './interfaces/GridProps';
9
9
  import { GridColumnProps } from './interfaces/GridColumnProps';
10
10
  /**
11
- * Represent the `ref` of the Grid component.
11
+ * Represents the `ref` of the Grid component.
12
12
  */
13
13
  export interface GridHandle {
14
14
  /**
@@ -16,44 +16,46 @@ export interface GridHandle {
16
16
  */
17
17
  element: HTMLDivElement | null;
18
18
  /**
19
- * The props values of the Grid.
19
+ * The values of the Grid props.
20
20
  */
21
21
  props: GridProps;
22
22
  /**
23
- * A getter of the current columns. Gets the current column width or current columns, or any other [`GridColumnProps`]({% slug api_grid_gridcolumnprops %}) for each defined column. Can be used on each Grid instance. To obtain the instance of the rendered Grid, use the `ref` callback. The following example demonstrates how to reorder the columns by dragging their handlers and check the properties afterwards. You can check the result in the browser console.
24
- *
23
+ * Gets the current columns of the Grid. Use it to read the current column width, the current columns, or any other [`GridColumnProps`](slug:api_grid_gridcolumnprops) of each defined column. You can use it on each Grid instance. To get the instance of the rendered Grid, use the `ref` callback. For example, reorder the columns by dragging their headers, and then check the column properties in the browser console.
25
24
  */
26
25
  columns: GridColumnProps[];
27
26
  /**
28
- * Method to allow the scroll to be set to a specific row index when the Grid is scrollable. It is zero based.
27
+ * Scrolls the Grid to a specific row index when the Grid is scrollable. The index is zero-based.
29
28
  *
30
- * @param options - Object, containing the rowIndex to which is going to be scrolled.
29
+ * @param options An object that contains the `rowIndex` to scroll to.
31
30
  */
32
31
  scrollIntoView: (options: {
33
32
  rowIndex: number;
34
33
  }) => void;
35
34
  /**
36
- * Method to fit columns according to their content.
35
+ * Fits the columns to their content.
37
36
  *
38
- * @param columnIds - Array of column ids to be fitted.
37
+ * @param columnIds The IDs of the columns to fit.
39
38
  */
40
39
  fitColumns: (columnIds: string[]) => void;
41
40
  }
42
41
  /**
43
- * Represents the [KendoVue Grid component]({% slug overview_grid %}).
44
- *
45
- * @remarks
46
- * Supported children components are: {@link GridColumn}, {@link GridToolbar}, {@link GridNoRecords}, {@link StatusBar}.
42
+ * Represents the [KendoVue Grid component](slug:overview_grid).
43
+ * Use the Grid to show data in a table and to sort, filter, group, page, and edit it.
47
44
  *
48
- * @hidden
45
+ * @example
46
+ * ```vue
47
+ * <Grid :data-items="products" :columns="columns" :sortable="true" :pageable="true" />
48
+ * ```
49
49
  *
50
+ * @remarks
51
+ * Supported children components are: {@link GridToolbar}, {@link GridNoRecords}, {@link StatusBar}.
50
52
  */
51
53
  export declare const RootGrid: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
52
54
  id: import('vue').PropType<string>;
53
55
  autoProcessData: import('vue').PropType<boolean | import('./utils/dataProcessing').AutoProcessDataConfig>;
54
56
  topCacheCount: {
55
57
  type: import('vue').PropType<number>; /**
56
- * Represent the `ref` of the Grid component.
58
+ * Represents the `ref` of the Grid component.
57
59
  */
58
60
  default: number;
59
61
  };
@@ -70,7 +72,11 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
70
72
  type: import('vue').PropType<import('.').GridColumnState[]>;
71
73
  default: () => any;
72
74
  };
73
- cells: import('vue').PropType<import('.').GridCellsSettings>;
75
+ cells: import('vue').PropType<import('.').GridCellsSettings>; /**
76
+ * Scrolls the Grid to a specific row index when the Grid is scrollable. The index is zero-based.
77
+ *
78
+ * @param options An object that contains the `rowIndex` to scroll to.
79
+ */
74
80
  contextMenu: import('vue').PropType<boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions)>;
75
81
  rows: import('vue').PropType<import('./interfaces/GridRowsSettings').GridRowsSettings>;
76
82
  defaultColumnsState: {
@@ -261,7 +267,7 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
261
267
  autoProcessData: import('vue').PropType<boolean | import('./utils/dataProcessing').AutoProcessDataConfig>;
262
268
  topCacheCount: {
263
269
  type: import('vue').PropType<number>; /**
264
- * Represent the `ref` of the Grid component.
270
+ * Represents the `ref` of the Grid component.
265
271
  */
266
272
  default: number;
267
273
  };
@@ -278,7 +284,11 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
278
284
  type: import('vue').PropType<import('.').GridColumnState[]>;
279
285
  default: () => any;
280
286
  };
281
- cells: import('vue').PropType<import('.').GridCellsSettings>;
287
+ cells: import('vue').PropType<import('.').GridCellsSettings>; /**
288
+ * Scrolls the Grid to a specific row index when the Grid is scrollable. The index is zero-based.
289
+ *
290
+ * @param options An object that contains the `rowIndex` to scroll to.
291
+ */
282
292
  contextMenu: import('vue').PropType<boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions)>;
283
293
  rows: import('vue').PropType<import('./interfaces/GridRowsSettings').GridRowsSettings>;
284
294
  defaultColumnsState: {
@@ -711,7 +721,7 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
711
721
  autoProcessData: import('vue').PropType<boolean | import('./utils/dataProcessing').AutoProcessDataConfig>;
712
722
  topCacheCount: {
713
723
  type: import('vue').PropType<number>; /**
714
- * Represent the `ref` of the Grid component.
724
+ * Represents the `ref` of the Grid component.
715
725
  */
716
726
  default: number;
717
727
  };
@@ -728,7 +738,11 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
728
738
  type: import('vue').PropType<import('.').GridColumnState[]>;
729
739
  default: () => any;
730
740
  };
731
- cells: import('vue').PropType<import('.').GridCellsSettings>;
741
+ cells: import('vue').PropType<import('.').GridCellsSettings>; /**
742
+ * Scrolls the Grid to a specific row index when the Grid is scrollable. The index is zero-based.
743
+ *
744
+ * @param options An object that contains the `rowIndex` to scroll to.
745
+ */
732
746
  contextMenu: import('vue').PropType<boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions)>;
733
747
  rows: import('vue').PropType<import('./interfaces/GridRowsSettings').GridRowsSettings>;
734
748
  defaultColumnsState: {
@@ -1154,7 +1168,7 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
1154
1168
  autoProcessData: import('vue').PropType<boolean | import('./utils/dataProcessing').AutoProcessDataConfig>;
1155
1169
  topCacheCount: {
1156
1170
  type: import('vue').PropType<number>; /**
1157
- * Represent the `ref` of the Grid component.
1171
+ * Represents the `ref` of the Grid component.
1158
1172
  */
1159
1173
  default: number;
1160
1174
  };
@@ -1171,7 +1185,11 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
1171
1185
  type: import('vue').PropType<import('.').GridColumnState[]>;
1172
1186
  default: () => any;
1173
1187
  };
1174
- cells: import('vue').PropType<import('.').GridCellsSettings>;
1188
+ cells: import('vue').PropType<import('.').GridCellsSettings>; /**
1189
+ * Scrolls the Grid to a specific row index when the Grid is scrollable. The index is zero-based.
1190
+ *
1191
+ * @param options An object that contains the `rowIndex` to scroll to.
1192
+ */
1175
1193
  contextMenu: import('vue').PropType<boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions)>;
1176
1194
  rows: import('vue').PropType<import('./interfaces/GridRowsSettings').GridRowsSettings>;
1177
1195
  defaultColumnsState: {
@@ -1604,7 +1622,7 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
1604
1622
  autoProcessData: import('vue').PropType<boolean | import('./utils/dataProcessing').AutoProcessDataConfig>;
1605
1623
  topCacheCount: {
1606
1624
  type: import('vue').PropType<number>; /**
1607
- * Represent the `ref` of the Grid component.
1625
+ * Represents the `ref` of the Grid component.
1608
1626
  */
1609
1627
  default: number;
1610
1628
  };
@@ -1621,7 +1639,11 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
1621
1639
  type: import('vue').PropType<import('.').GridColumnState[]>;
1622
1640
  default: () => any;
1623
1641
  };
1624
- cells: import('vue').PropType<import('.').GridCellsSettings>;
1642
+ cells: import('vue').PropType<import('.').GridCellsSettings>; /**
1643
+ * Scrolls the Grid to a specific row index when the Grid is scrollable. The index is zero-based.
1644
+ *
1645
+ * @param options An object that contains the `rowIndex` to scroll to.
1646
+ */
1625
1647
  contextMenu: import('vue').PropType<boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions)>;
1626
1648
  rows: import('vue').PropType<import('./interfaces/GridRowsSettings').GridRowsSettings>;
1627
1649
  defaultColumnsState: {
@@ -2076,7 +2098,7 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
2076
2098
  autoProcessData: import('vue').PropType<boolean | import('./utils/dataProcessing').AutoProcessDataConfig>;
2077
2099
  topCacheCount: {
2078
2100
  type: import('vue').PropType<number>; /**
2079
- * Represent the `ref` of the Grid component.
2101
+ * Represents the `ref` of the Grid component.
2080
2102
  */
2081
2103
  default: number;
2082
2104
  };
@@ -2093,7 +2115,11 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
2093
2115
  type: import('vue').PropType<import('.').GridColumnState[]>;
2094
2116
  default: () => any;
2095
2117
  };
2096
- cells: import('vue').PropType<import('.').GridCellsSettings>;
2118
+ cells: import('vue').PropType<import('.').GridCellsSettings>; /**
2119
+ * Scrolls the Grid to a specific row index when the Grid is scrollable. The index is zero-based.
2120
+ *
2121
+ * @param options An object that contains the `rowIndex` to scroll to.
2122
+ */
2097
2123
  contextMenu: import('vue').PropType<boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions)>;
2098
2124
  rows: import('vue').PropType<import('./interfaces/GridRowsSettings').GridRowsSettings>;
2099
2125
  defaultColumnsState: {
package/StatusBar.d.ts CHANGED
@@ -41,9 +41,13 @@ interface StatusBarProps {
41
41
  data: StatusItem[];
42
42
  }
43
43
  /**
44
- * Represents the Kendo UI for Vue Grid's StatusBar component.
44
+ * Represents the KendoVue StatusBar component of the Grid. It shows the aggregates of the selected Grid cells
45
+ * ([see example](slug:aggregates_selection_grid)).
45
46
  *
46
- * @hidden
47
+ * @example
48
+ * ```vue
49
+ * <StatusBar :data="statusData" />
50
+ * ```
47
51
  */
48
52
  declare const StatusBar: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
49
53
  data: {
@@ -71,7 +75,7 @@ type StatusDataArgs = Pick<GridSelectionChangeEvent, 'dataItems' | 'target' | 's
71
75
  dataItemKey: Required<GridProps>['dataItemKey'];
72
76
  };
73
77
  /**
74
- * Calculates the status data.
78
+ * Calculates the aggregates of the selected Grid cells that the StatusBar shows.
75
79
  *
76
80
  * @param args StatusDataArgs
77
81
  * @returns StatusItem[]
@@ -6,7 +6,7 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  "use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const t=require("@progress/kendo-vue-common/codemods"),o=require("@progress/kendo-vue-common/codemods/detect"),s=require("./utils.js"),r=`getColumns() is no longer available on the Grid template ref. The columns property (a property, not a function call) is its replacement. The codemod already rewrote the calls on refs that it could prove to be Grid refs; the remaining getColumns() calls must be migrated manually, including template expressions (@click="gridRef.getColumns()", {{ gridRef.getColumns() }}) and refs that the codemod could not prove to be Grid refs.
9
- The Grid ref exposes only element, props, columns, scrollIntoView, fitColumns and exportAsPdf (the GridHandle interface), plus the standard Vue instance properties such as $el and $props. The other methods and data of the previous Grid instance are no longer reachable through the ref.
9
+ The Grid ref exposes only element, props, columns, scrollIntoView and fitColumns (the GridHandle interface), plus the standard Vue instance properties such as $el and $props. The other methods and data of the previous Grid instance are no longer reachable through the ref.
10
10
  Before: gridRef.value.getColumns() returned the current columns with their widths and any other GridColumnProps.
11
11
  After: gridRef.value.columns (gridRef.value.getColumns is undefined).
12
12
  Replace the remaining getColumns() calls on Grid refs with the columns property, and check any other member that the code reads from the Grid ref against the list above.`,a={gatedPatterns:[new RegExp("(?<!\\bthis)\\.getColumns\\s*\\(")]};function i(e,n){return t.isRenderingChangeTarget(e.path)&&o.detectChange(e,n,s.GRID_PACKAGE,a)&&t.writeInstructionMarker(r,__filename,e.path),e.source}exports.aiInstructions=r;exports.default=i;
@@ -13,7 +13,7 @@ import { PropType } from 'vue';
13
13
  */
14
14
  export declare const rootFilterOrDefault: (rootFilter: CompositeFilterDescriptor | undefined) => CompositeFilterDescriptor;
15
15
  /**
16
- * Can be used to check if filtering is applied to a specific field ([see example]({% slug column_menu_grid %}#toc-styling-the-column-menu-icon)). Useful for creating active filter indicators.
16
+ * Can be used to check if filtering is applied to a specific field ([see example](slug:column_menu_grid#toc-styling-the-column-menu-icon)). Useful for creating active filter indicators.
17
17
  */
18
18
  export declare const filterGroupByField: (field: string, filter: CompositeFilterDescriptor | undefined) => CompositeFilterDescriptor | null;
19
19
  /**
@@ -6,8 +6,13 @@
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
8
  /**
9
- * Represents the GridNoRecords component which is rendered
10
- * when the `data` property of the Grid is empty or `null`.
9
+ * Represents the KendoVue GridNoRecords component. The Grid renders it
10
+ * when the `dataItems` of the Grid are empty or `null`.
11
+ *
12
+ * @example
13
+ * ```vue
14
+ * <GridNoRecords>There are no orders to show.</GridNoRecords>
15
+ * ```
11
16
  */
12
17
  declare const GridNoRecords: import('vue').DefineComponent<{}, {
13
18
  kendoLocalizationService: {};