@progress/kendo-vue-grid 11.0.0 → 11.1.0-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.
@@ -19,6 +19,9 @@ export interface BasePDFExportMethods {
19
19
  target: HTMLDivElement | null;
20
20
  }) => Promise<void>;
21
21
  }
22
+ /**
23
+ * @hidden
24
+ */
22
25
  declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
23
26
  gridProps: {
24
27
  type: PropType<Record<string, any>>;
package/Grid.d.ts CHANGED
@@ -20,7 +20,16 @@ import { BaseCSVExportMethods } from './BaseCSVExport';
20
20
  import { GridContextMenuOptions } from './contextMenu/GridContextMenu';
21
21
  import { GridContextMenuItemNames } from './contextMenu/enums';
22
22
  /**
23
- * @hidden
23
+ * Represents the [Kendo UI for Vue Grid component](slug:overview_grid).
24
+ * Use the Grid to show data in a table and to sort, filter, group, page, and edit it.
25
+ *
26
+ * @example
27
+ * ```vue
28
+ * <Grid :data-items="products" :columns="columns" :sortable="true" :pageable="true" />
29
+ * ```
30
+ *
31
+ * @remarks
32
+ * Supported children components are: {@link GridToolbar}, {@link GridNoRecords}, {@link StatusBar}.
24
33
  */
25
34
  declare const Grid: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
26
35
  toolbar: {
@@ -366,7 +375,7 @@ declare const Grid: import('vue').DefineComponent<import('vue').ExtractPropTypes
366
375
  filterHiddenColumns(columns: GridColumnProps[]): GridColumnProps[];
367
376
  /**
368
377
  * 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.
378
+ * or any other [`GridColumnProps`](slug:api_grid_gridcolumnprops) for each defined column.
370
379
  * Can be used on each Grid instance. To obtain the instance of the rendered Grid, use the `ref`
371
380
  * callback. The following example demonstrates how to reorder the columns by dragging their handlers
372
381
  * 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 Kendo UI for Vue 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 Kendo UI for Vue 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 Kendo UI for Vue 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/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,43 @@ 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 %}).
42
+ * Represents the [Kendo UI for Vue Grid component](slug:overview_grid).
43
+ * Use the Grid to show data in a table and to sort, filter, group, page, and edit it.
44
44
  *
45
45
  * @remarks
46
- * Supported children components are: {@link GridColumn}, {@link GridToolbar}, {@link GridNoRecords}, {@link StatusBar}.
46
+ * Supported children components are: {@link GridToolbar}, {@link GridNoRecords}, {@link StatusBar}.
47
47
  *
48
48
  * @hidden
49
- *
50
49
  */
51
50
  export declare const RootGrid: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
52
51
  id: import('vue').PropType<string>;
53
52
  autoProcessData: import('vue').PropType<boolean | import('./utils/dataProcessing').AutoProcessDataConfig>;
54
53
  topCacheCount: {
55
54
  type: import('vue').PropType<number>; /**
56
- * Represent the `ref` of the Grid component.
55
+ * Represents the `ref` of the Grid component.
57
56
  */
58
57
  default: number;
59
58
  };
@@ -70,7 +69,11 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
70
69
  type: import('vue').PropType<import('.').GridColumnState[]>;
71
70
  default: () => any;
72
71
  };
73
- cells: import('vue').PropType<import('.').GridCellsSettings>;
72
+ cells: import('vue').PropType<import('.').GridCellsSettings>; /**
73
+ * Scrolls the Grid to a specific row index when the Grid is scrollable. The index is zero-based.
74
+ *
75
+ * @param options An object that contains the `rowIndex` to scroll to.
76
+ */
74
77
  contextMenu: import('vue').PropType<boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions)>;
75
78
  rows: import('vue').PropType<import('./interfaces/GridRowsSettings').GridRowsSettings>;
76
79
  defaultColumnsState: {
@@ -261,7 +264,7 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
261
264
  autoProcessData: import('vue').PropType<boolean | import('./utils/dataProcessing').AutoProcessDataConfig>;
262
265
  topCacheCount: {
263
266
  type: import('vue').PropType<number>; /**
264
- * Represent the `ref` of the Grid component.
267
+ * Represents the `ref` of the Grid component.
265
268
  */
266
269
  default: number;
267
270
  };
@@ -278,7 +281,11 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
278
281
  type: import('vue').PropType<import('.').GridColumnState[]>;
279
282
  default: () => any;
280
283
  };
281
- cells: import('vue').PropType<import('.').GridCellsSettings>;
284
+ cells: import('vue').PropType<import('.').GridCellsSettings>; /**
285
+ * Scrolls the Grid to a specific row index when the Grid is scrollable. The index is zero-based.
286
+ *
287
+ * @param options An object that contains the `rowIndex` to scroll to.
288
+ */
282
289
  contextMenu: import('vue').PropType<boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions)>;
283
290
  rows: import('vue').PropType<import('./interfaces/GridRowsSettings').GridRowsSettings>;
284
291
  defaultColumnsState: {
@@ -711,7 +718,7 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
711
718
  autoProcessData: import('vue').PropType<boolean | import('./utils/dataProcessing').AutoProcessDataConfig>;
712
719
  topCacheCount: {
713
720
  type: import('vue').PropType<number>; /**
714
- * Represent the `ref` of the Grid component.
721
+ * Represents the `ref` of the Grid component.
715
722
  */
716
723
  default: number;
717
724
  };
@@ -728,7 +735,11 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
728
735
  type: import('vue').PropType<import('.').GridColumnState[]>;
729
736
  default: () => any;
730
737
  };
731
- cells: import('vue').PropType<import('.').GridCellsSettings>;
738
+ cells: import('vue').PropType<import('.').GridCellsSettings>; /**
739
+ * Scrolls the Grid to a specific row index when the Grid is scrollable. The index is zero-based.
740
+ *
741
+ * @param options An object that contains the `rowIndex` to scroll to.
742
+ */
732
743
  contextMenu: import('vue').PropType<boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions)>;
733
744
  rows: import('vue').PropType<import('./interfaces/GridRowsSettings').GridRowsSettings>;
734
745
  defaultColumnsState: {
@@ -1154,7 +1165,7 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
1154
1165
  autoProcessData: import('vue').PropType<boolean | import('./utils/dataProcessing').AutoProcessDataConfig>;
1155
1166
  topCacheCount: {
1156
1167
  type: import('vue').PropType<number>; /**
1157
- * Represent the `ref` of the Grid component.
1168
+ * Represents the `ref` of the Grid component.
1158
1169
  */
1159
1170
  default: number;
1160
1171
  };
@@ -1171,7 +1182,11 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
1171
1182
  type: import('vue').PropType<import('.').GridColumnState[]>;
1172
1183
  default: () => any;
1173
1184
  };
1174
- cells: import('vue').PropType<import('.').GridCellsSettings>;
1185
+ cells: import('vue').PropType<import('.').GridCellsSettings>; /**
1186
+ * Scrolls the Grid to a specific row index when the Grid is scrollable. The index is zero-based.
1187
+ *
1188
+ * @param options An object that contains the `rowIndex` to scroll to.
1189
+ */
1175
1190
  contextMenu: import('vue').PropType<boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions)>;
1176
1191
  rows: import('vue').PropType<import('./interfaces/GridRowsSettings').GridRowsSettings>;
1177
1192
  defaultColumnsState: {
@@ -1604,7 +1619,7 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
1604
1619
  autoProcessData: import('vue').PropType<boolean | import('./utils/dataProcessing').AutoProcessDataConfig>;
1605
1620
  topCacheCount: {
1606
1621
  type: import('vue').PropType<number>; /**
1607
- * Represent the `ref` of the Grid component.
1622
+ * Represents the `ref` of the Grid component.
1608
1623
  */
1609
1624
  default: number;
1610
1625
  };
@@ -1621,7 +1636,11 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
1621
1636
  type: import('vue').PropType<import('.').GridColumnState[]>;
1622
1637
  default: () => any;
1623
1638
  };
1624
- cells: import('vue').PropType<import('.').GridCellsSettings>;
1639
+ cells: import('vue').PropType<import('.').GridCellsSettings>; /**
1640
+ * Scrolls the Grid to a specific row index when the Grid is scrollable. The index is zero-based.
1641
+ *
1642
+ * @param options An object that contains the `rowIndex` to scroll to.
1643
+ */
1625
1644
  contextMenu: import('vue').PropType<boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions)>;
1626
1645
  rows: import('vue').PropType<import('./interfaces/GridRowsSettings').GridRowsSettings>;
1627
1646
  defaultColumnsState: {
@@ -2076,7 +2095,7 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
2076
2095
  autoProcessData: import('vue').PropType<boolean | import('./utils/dataProcessing').AutoProcessDataConfig>;
2077
2096
  topCacheCount: {
2078
2097
  type: import('vue').PropType<number>; /**
2079
- * Represent the `ref` of the Grid component.
2098
+ * Represents the `ref` of the Grid component.
2080
2099
  */
2081
2100
  default: number;
2082
2101
  };
@@ -2093,7 +2112,11 @@ export declare const RootGrid: import('vue').DefineComponent<import('vue').Extra
2093
2112
  type: import('vue').PropType<import('.').GridColumnState[]>;
2094
2113
  default: () => any;
2095
2114
  };
2096
- cells: import('vue').PropType<import('.').GridCellsSettings>;
2115
+ cells: import('vue').PropType<import('.').GridCellsSettings>; /**
2116
+ * Scrolls the Grid to a specific row index when the Grid is scrollable. The index is zero-based.
2117
+ *
2118
+ * @param options An object that contains the `rowIndex` to scroll to.
2119
+ */
2097
2120
  contextMenu: import('vue').PropType<boolean | import('.').GridContextMenuOptions | ((options: import('.').GridCellBaseOptions) => boolean | import('.').GridContextMenuOptions)>;
2098
2121
  rows: import('vue').PropType<import('./interfaces/GridRowsSettings').GridRowsSettings>;
2099
2122
  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 Kendo UI for Vue 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
  /**
@@ -32,6 +32,10 @@ export interface GridColumnMenuFilterProps extends GridColumnMenuFilterBaseProps
32
32
  * If set to `false`, the second filter operator and the input will be hidden.
33
33
  */
34
34
  hideSecondFilter?: boolean;
35
+ /**
36
+ * Specifies a Vue component that will be cloned and rendered inside the UI of the column-menu filter component
37
+ * ([see example](slug:column_menu_grid#toc-customizing-the-filter-component)).
38
+ */
35
39
  filterUI?: any;
36
40
  /**
37
41
  * Triggers when a filter is focused.
@@ -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 Kendo UI for Vue 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: {};