@progress/kendo-angular-grid 12.0.0-develop.9 → 12.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.
Files changed (172) hide show
  1. package/column-menu/column-chooser.component.d.ts +14 -19
  2. package/column-menu/column-menu-autosize-all.component.d.ts +12 -27
  3. package/column-menu/column-menu-autosize.component.d.ts +12 -26
  4. package/column-menu/column-menu-chooser.component.d.ts +11 -24
  5. package/column-menu/column-menu-expandable-item.interface.d.ts +0 -1
  6. package/column-menu/column-menu-filter.component.d.ts +12 -24
  7. package/column-menu/column-menu-item.component.d.ts +6 -21
  8. package/column-menu/column-menu-lock.component.d.ts +11 -25
  9. package/column-menu/column-menu-position.component.d.ts +12 -24
  10. package/column-menu/column-menu-settings.interface.d.ts +3 -24
  11. package/column-menu/column-menu-sort.component.d.ts +12 -25
  12. package/column-menu/column-menu-stick.component.d.ts +12 -24
  13. package/column-menu/column-menu.component.d.ts +9 -1
  14. package/column-menu/column-menu.service.d.ts +9 -21
  15. package/column-resizing/column-resize.interface.d.ts +1 -1
  16. package/columns/checkbox-column.component.d.ts +6 -57
  17. package/columns/column-base.d.ts +16 -369
  18. package/columns/column-group.component.d.ts +9 -48
  19. package/columns/column.component.d.ts +23 -109
  20. package/columns/command-column.component.d.ts +12 -60
  21. package/columns/reorder-column.component.d.ts +1 -1
  22. package/columns/sort-settings.d.ts +24 -12
  23. package/columns/span-column.component.d.ts +12 -123
  24. package/common/cell-click-event-args.interface.d.ts +1 -1
  25. package/common/fetch-data-callback.d.ts +1 -1
  26. package/common/preventable-event.d.ts +1 -1
  27. package/common/single-popup.service.d.ts +1 -1
  28. package/common/size-options.d.ts +1 -2
  29. package/data/change-event-args.interface.d.ts +2 -2
  30. package/data/data.collection.d.ts +1 -1
  31. package/data/grid-item.interface.d.ts +6 -3
  32. package/dragdrop/column-reorder-config.d.ts +1 -1
  33. package/editing/add-event-args.interface.d.ts +1 -1
  34. package/editing/cancel-event-args.interface.d.ts +1 -1
  35. package/editing/edit-event-args.interface.d.ts +1 -1
  36. package/editing/remove-event-args.interface.d.ts +1 -1
  37. package/editing/save-event-args.interface.d.ts +1 -1
  38. package/editing-directives/edit-service.interface.d.ts +1 -1
  39. package/esm2020/column-menu/column-chooser.component.mjs +14 -19
  40. package/esm2020/column-menu/column-menu-autosize-all.component.mjs +12 -27
  41. package/esm2020/column-menu/column-menu-autosize.component.mjs +12 -26
  42. package/esm2020/column-menu/column-menu-chooser.component.mjs +11 -24
  43. package/esm2020/column-menu/column-menu-filter.component.mjs +12 -24
  44. package/esm2020/column-menu/column-menu-item.component.mjs +6 -21
  45. package/esm2020/column-menu/column-menu-lock.component.mjs +11 -25
  46. package/esm2020/column-menu/column-menu-position.component.mjs +12 -24
  47. package/esm2020/column-menu/column-menu-sort.component.mjs +12 -25
  48. package/esm2020/column-menu/column-menu-stick.component.mjs +12 -24
  49. package/esm2020/column-menu/column-menu.component.mjs +9 -1
  50. package/esm2020/column-menu/column-menu.service.mjs +9 -21
  51. package/esm2020/columns/checkbox-column.component.mjs +6 -57
  52. package/esm2020/columns/column-base.mjs +7 -40
  53. package/esm2020/columns/column-group.component.mjs +9 -48
  54. package/esm2020/columns/column.component.mjs +22 -79
  55. package/esm2020/columns/command-column.component.mjs +12 -60
  56. package/esm2020/columns/reorder-column.component.mjs +1 -1
  57. package/esm2020/columns/span-column.component.mjs +12 -123
  58. package/esm2020/common/preventable-event.mjs +1 -1
  59. package/esm2020/common/single-popup.service.mjs +1 -1
  60. package/esm2020/excel/excel.module.mjs +5 -15
  61. package/esm2020/filtering/cell/boolean-filter-cell.component.mjs +11 -10
  62. package/esm2020/filtering/cell/date-filter-cell.component.mjs +26 -13
  63. package/esm2020/filtering/cell/filter-cell-operators.component.mjs +15 -0
  64. package/esm2020/filtering/cell/numeric-filter-cell.component.mjs +14 -11
  65. package/esm2020/filtering/cell/string-filter-cell.component.mjs +14 -15
  66. package/esm2020/filtering/date-filter.component.mjs +6 -2
  67. package/esm2020/filtering/menu/boolean-filter-menu.component.mjs +13 -13
  68. package/esm2020/filtering/menu/date-filter-menu.component.mjs +13 -13
  69. package/esm2020/filtering/menu/numeric-filter-menu.component.mjs +13 -13
  70. package/esm2020/filtering/menu/string-filter-menu.component.mjs +15 -2
  71. package/esm2020/filtering/numeric-filter.component.mjs +4 -1
  72. package/esm2020/filtering/operators/after-eq-filter-operator.component.mjs +3 -6
  73. package/esm2020/filtering/operators/after-filter-operator.component.mjs +3 -6
  74. package/esm2020/filtering/operators/before-eq-filter-operator.component.mjs +3 -6
  75. package/esm2020/filtering/operators/before-filter-operator.component.mjs +3 -6
  76. package/esm2020/filtering/operators/contains-filter-operator.component.mjs +2 -5
  77. package/esm2020/filtering/operators/ends-with-filter-operator.component.mjs +2 -4
  78. package/esm2020/filtering/operators/eq-filter-operator.component.mjs +2 -4
  79. package/esm2020/filtering/operators/gt-filter-operator.component.mjs +3 -6
  80. package/esm2020/filtering/operators/gte-filter-operator.component.mjs +2 -5
  81. package/esm2020/filtering/operators/is-empty-filter-operator.component.mjs +2 -4
  82. package/esm2020/filtering/operators/is-not-empty-filter-operator.component.mjs +2 -4
  83. package/esm2020/filtering/operators/is-not-null-filter-operator.component.mjs +2 -4
  84. package/esm2020/filtering/operators/isnull-filter-operator.component.mjs +2 -4
  85. package/esm2020/filtering/operators/lt-filter-operator.component.mjs +3 -5
  86. package/esm2020/filtering/operators/lte-filter-operator.component.mjs +3 -5
  87. package/esm2020/filtering/operators/neq-filter-operator.component.mjs +2 -4
  88. package/esm2020/filtering/operators/not-contains-filter-operator.component.mjs +2 -4
  89. package/esm2020/filtering/operators/starts-with-filter-operator.component.mjs +2 -4
  90. package/esm2020/filtering/string-filter.component.mjs +2 -1
  91. package/esm2020/grid.component.mjs +39 -325
  92. package/esm2020/grid.module.mjs +6 -16
  93. package/esm2020/layout/sizing-options.service.mjs +3 -0
  94. package/esm2020/localization/custom-messages.component.mjs +1 -1
  95. package/esm2020/package-metadata.mjs +2 -2
  96. package/esm2020/pager/pager-info.component.mjs +1 -1
  97. package/esm2020/pager/pager-input.component.mjs +1 -48
  98. package/esm2020/pager/pager-next-buttons.component.mjs +1 -1
  99. package/esm2020/pager/pager-numeric-buttons.component.mjs +1 -1
  100. package/esm2020/pager/pager-page-sizes.component.mjs +3 -92
  101. package/esm2020/pager/pager-prev-buttons.component.mjs +1 -1
  102. package/esm2020/pdf/pdf-margin.component.mjs +9 -0
  103. package/esm2020/pdf/pdf.module.mjs +7 -16
  104. package/esm2020/rendering/common/spacer.component.mjs +2 -1
  105. package/esm2020/rendering/toolbar/toolbar-position.mjs +17 -0
  106. package/esm2020/row-reordering/row-reorder.service.mjs +2 -1
  107. package/excel/excel.component.d.ts +2 -7
  108. package/excel/excel.module.d.ts +5 -15
  109. package/fesm2015/progress-kendo-angular-grid.mjs +476 -1372
  110. package/fesm2020/progress-kendo-angular-grid.mjs +476 -1372
  111. package/filtering/cell/boolean-filter-cell.component.d.ts +11 -10
  112. package/filtering/cell/date-filter-cell.component.d.ts +26 -13
  113. package/filtering/cell/filter-cell-operators.component.d.ts +15 -0
  114. package/filtering/cell/numeric-filter-cell.component.d.ts +14 -11
  115. package/filtering/cell/string-filter-cell.component.d.ts +14 -15
  116. package/filtering/date-filter.component.d.ts +8 -12
  117. package/filtering/filterable.d.ts +10 -0
  118. package/filtering/menu/boolean-filter-menu.component.d.ts +13 -13
  119. package/filtering/menu/date-filter-menu.component.d.ts +13 -13
  120. package/filtering/menu/numeric-filter-menu.component.d.ts +13 -13
  121. package/filtering/menu/string-filter-menu.component.d.ts +15 -2
  122. package/filtering/numeric-filter.component.d.ts +4 -1
  123. package/filtering/operators/after-eq-filter-operator.component.d.ts +4 -0
  124. package/filtering/operators/after-filter-operator.component.d.ts +4 -0
  125. package/filtering/operators/before-eq-filter-operator.component.d.ts +4 -0
  126. package/filtering/operators/before-filter-operator.component.d.ts +4 -0
  127. package/filtering/operators/contains-filter-operator.component.d.ts +2 -5
  128. package/filtering/operators/ends-with-filter-operator.component.d.ts +2 -4
  129. package/filtering/operators/eq-filter-operator.component.d.ts +2 -4
  130. package/filtering/operators/gt-filter-operator.component.d.ts +4 -0
  131. package/filtering/operators/gte-filter-operator.component.d.ts +2 -5
  132. package/filtering/operators/is-empty-filter-operator.component.d.ts +2 -4
  133. package/filtering/operators/is-not-empty-filter-operator.component.d.ts +2 -4
  134. package/filtering/operators/is-not-null-filter-operator.component.d.ts +2 -4
  135. package/filtering/operators/isnull-filter-operator.component.d.ts +2 -4
  136. package/filtering/operators/lt-filter-operator.component.d.ts +5 -0
  137. package/filtering/operators/lte-filter-operator.component.d.ts +5 -0
  138. package/filtering/operators/neq-filter-operator.component.d.ts +2 -4
  139. package/filtering/operators/not-contains-filter-operator.component.d.ts +2 -4
  140. package/filtering/operators/starts-with-filter-operator.component.d.ts +2 -4
  141. package/filtering/string-filter.component.d.ts +2 -1
  142. package/grid.component.d.ts +43 -327
  143. package/grid.module.d.ts +6 -16
  144. package/grouping/group-key.interface.d.ts +1 -13
  145. package/grouping/group-rows-args.interface.d.ts +1 -1
  146. package/layout/sizing-options.service.d.ts +3 -0
  147. package/localization/custom-messages.component.d.ts +1 -1
  148. package/localization/messages.d.ts +35 -98
  149. package/navigation/navigable-settings.d.ts +15 -1
  150. package/navigation/navigation-cell.interface.d.ts +2 -5
  151. package/navigation/navigation-row.interface.d.ts +2 -5
  152. package/package.json +19 -19
  153. package/pager/pager-info.component.d.ts +1 -1
  154. package/pager/pager-input.component.d.ts +1 -48
  155. package/pager/pager-next-buttons.component.d.ts +1 -1
  156. package/pager/pager-numeric-buttons.component.d.ts +1 -1
  157. package/pager/pager-page-sizes.component.d.ts +3 -92
  158. package/pager/pager-prev-buttons.component.d.ts +1 -1
  159. package/pager/pager-settings.d.ts +9 -38
  160. package/pdf/pdf-margin.component.d.ts +9 -0
  161. package/pdf/pdf-margin.interface.d.ts +0 -5
  162. package/pdf/pdf.module.d.ts +7 -16
  163. package/rendering/common/row-class.d.ts +4 -4
  164. package/rendering/common/spacer.component.d.ts +2 -1
  165. package/rendering/toolbar/toolbar-position.d.ts +18 -1
  166. package/row-reordering/row-reorder.service.d.ts +1 -0
  167. package/row-reordering/types.d.ts +1 -1
  168. package/schematics/ngAdd/index.js +2 -2
  169. package/scrolling/content-scroll-event.d.ts +1 -1
  170. package/scrolling/scroll-request.service.d.ts +2 -1
  171. package/scrolling/scrollmode.d.ts +4 -4
  172. package/selection/types.d.ts +31 -48
@@ -4,7 +4,7 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { GroupResult } from "@progress/kendo-data-query";
6
6
  /**
7
- * Represents a group row on a specific position in the Grid.
7
+ * Represents a group row on a specific position in the Grid. [See example](slug:groups_expanded_state_grid#toc-custom-group-key-format).
8
8
  */
9
9
  export interface GroupRowArgs {
10
10
  /**
@@ -5,6 +5,9 @@
5
5
  import { Subject } from 'rxjs';
6
6
  import { GridSize } from '../common/size-options';
7
7
  import * as i0 from "@angular/core";
8
+ /**
9
+ * @hidden
10
+ */
8
11
  export declare class SizingOptionsService {
9
12
  changes: Subject<GridSize>;
10
13
  static ɵfac: i0.ɵɵFactoryDeclaration<SizingOptionsService, never>;
@@ -7,7 +7,7 @@ import { GridMessages } from './messages';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
9
  * Custom component messages override default component messages
10
- * ([see example]({% slug globalization_grid %}#toc-localization)).
10
+ * ([see example](slug:globalization_grid#toc-custom-messages)).
11
11
  */
12
12
  export declare class CustomMessagesComponent extends GridMessages {
13
13
  protected service: LocalizationService;
@@ -17,25 +17,14 @@ export declare class GridMessages extends ComponentMessages {
17
17
  */
18
18
  noRecords: string;
19
19
  /**
20
- * The label of the pager. By default follows the pattern 'Page navigation, page {currentPage} of {totalPages}'.
21
- * The default label text when the current page is 1, and the total number of pages is 10 will be
22
- * 'Page navigation, page 1 of 10'.
20
+ * The label of the pager. Follows the pattern **Page {currentPage} of {totalPages}** by default.
21
+ * Тhe default label text when the current page is 1, and the total number of pages is 10 will be
22
+ * **Page navigation, page 1 of 10**.
23
23
  *
24
24
  * The message consists of several parts - the current page number, the total number of pages, and a localizable string.
25
25
  * To allow for reordering its parts, the `pagerLabel` input accepts a string with placeholders for the current page
26
- * and total number of pages. The '{currentPage}' and '{totalPages}' placeholders will be replaced
27
- * internally with the respective actual values.
28
- *
29
- * @example
30
- *
31
- * ```ts-no-run
32
- * <kendo-grid>
33
- * <kendo-grid-messages
34
- * pagerLabel="You are currently on page {currentPage} of {totalPages}"
35
- * >
36
- * </kendo-grid-messages>
37
- * </kendo-grid>
38
- * ```
26
+ * and total number of pages. The `{currentPage}` and `{totalPages}` placeholders will be replaced
27
+ * internally with the respective actual values. [See example](slug:globalization_grid#toc-custom-messages).
39
28
  */
40
29
  pagerLabel: string;
41
30
  /**
@@ -75,7 +64,7 @@ export declare class GridMessages extends ComponentMessages {
75
64
  */
76
65
  pagerPageNumberInputTitle: string;
77
66
  /**
78
- * The text of the title and aria-label attributes applied to the page chooser in the Grid Pager.
67
+ * The text of the title and `aria-label` attributes applied to the page chooser in the Grid Pager.
79
68
  */
80
69
  selectPage: string;
81
70
  /**
@@ -86,88 +75,48 @@ export declare class GridMessages extends ComponentMessages {
86
75
  * The label of the filter input.
87
76
  *
88
77
  * The filter input label consists of a two-part message - the name of the column and a localizable string.
89
- * For a column named 'Product Name', the default label will be 'Product Name Filter'.
90
- *
91
- * To allow reordering the column name and the localizable part, the filterInputLabel accepts a string with a
92
- * placeholder for the column name - e.g. 'filter for {columnName}'. The '{columnName}' placeholder will be replaced
93
- * internally with the current column name, and the resulting label will be rendered as 'filter for Product Name'.
94
- *
95
- * @example
78
+ * For a column named **Product Name**, the default label will be **Product Name Filter**.
96
79
  *
97
- * ```ts-no-run
98
- * <kendo-grid>
99
- * <kendo-grid-messages
100
- * filterInputLabel="filter for {columnName}"
101
- * >
102
- * </kendo-grid-messages>
103
- * </kendo-grid>
104
- * ```
80
+ * To allow reordering the column name and the localizable part, the `filterInputLabel` accepts a string with a
81
+ * placeholder for the column name, for example, **filter for {columnName}**. The `{columnName}` placeholder will be replaced
82
+ * internally with the current column name, and the resulting label will be rendered as **filter for Product Name**.
83
+ * [See example](slug:globalization_grid#toc-custom-messages).
105
84
  */
106
85
  filterInputLabel: string;
107
86
  /**
108
87
  * The title of the filter menu icon.
109
88
  *
110
89
  * The title consists of a two-part message - the name of the column and a localizable string.
111
- * For a column named 'Product Name', the default title will be 'Product Name Filter Menu'.
90
+ * For a column named **Product Name**, the default title will be **Product Name Filter Menu**.
112
91
  *
113
- * To allow reordering the column name and the localizable part, the filterMenuTitle accepts a string with a
114
- * placeholder for the column name - e.g. 'filter for {columnName}'. The '{columnName}' placeholder will be replaced
115
- * internally with the current column name, and the resulting title will be rendered as 'filter for Product Name'.
116
- *
117
- * @example
118
- *
119
- * ```ts-no-run
120
- * <kendo-grid>
121
- * <kendo-grid-messages
122
- * filterMenuTitle="filter for {columnName}"
123
- * >
124
- * </kendo-grid-messages>
125
- * </kendo-grid>
126
- * ```
92
+ * To allow reordering the column name and the localizable part, the `filterMenuTitle` accepts a string with a
93
+ * placeholder for the column name, for example, **filter for {columnName}**. The `{columnName}` placeholder will be replaced
94
+ * internally with the current column name, and the resulting title will be rendered as **filter for Product Name**.
95
+ * [See example](slug:globalization_grid#toc-custom-messages).
127
96
  */
128
97
  filterMenuTitle: string;
129
98
  /**
130
99
  * The label of the filter menu operators DropDownList.
131
100
  *
132
101
  * The label consists of a two-part message - the name of the column and a localizable string.
133
- * For a column named 'Product Name', the default label will be 'Product Name Filter Menu Operators'.
134
- *
135
- * To allow reordering the column name and the localizable part, the filterMenuOperatorsDropDownLabel accepts a string with a
136
- * placeholder for the column name - e.g. 'filter operators for {columnName}'. The '{columnName}' placeholder will be replaced
137
- * internally with the current column name, and the resulting label will be rendered as 'filter operators for Product Name'.
102
+ * For a column named **Product Name**, the default label will be **Product Name Filter Menu Operators**.
138
103
  *
139
- * @example
140
- *
141
- * ```ts-no-run
142
- * <kendo-grid>
143
- * <kendo-grid-messages
144
- * filterMenuOperatorsDropDownLabel="filter operators for {columnName}"
145
- * >
146
- * </kendo-grid-messages>
147
- * </kendo-grid>
148
- * ```
104
+ * To allow reordering the column name and the localizable part, the `filterMenuOperatorsDropDownLabel` accepts a string with a
105
+ * placeholder for the column name, for example, **filter operators for {columnName**'. The `{columnName}` placeholder will be replaced
106
+ * internally with the current column name, and the resulting label will be rendered as **filter operators for Product Name**.
107
+ * [See example](slug:globalization_grid#toc-custom-messages).
149
108
  */
150
109
  filterMenuOperatorsDropDownLabel: string;
151
110
  /**
152
111
  * The label of the filter menu logic DropDownList.
153
112
  *
154
113
  * The label consists of a two-part message - the name of the column and a localizable string.
155
- * For a column named 'Product Name', the default label will be 'Product Name Filter Menu Logic'.
156
- *
157
- * To allow reordering the column name and the localizable part, the filterMenuLogicDropDownLabel accepts a string with a
158
- * placeholder for the column name - e.g. 'filter logic for {columnName}'. The '{columnName}' placeholder will be replaced
159
- * internally with the current column name, and the resulting label will be rendered as 'filter logic for Product Name'.
160
- *
161
- * @example
114
+ * For a column named **Product Name**, the default label will be **Product Name Filter Menu Logic**.
162
115
  *
163
- * ```ts-no-run
164
- * <kendo-grid>
165
- * <kendo-grid-messages
166
- * filterMenuOperatorsDropDownLabel="filter operators for {columnName}"
167
- * >
168
- * </kendo-grid-messages>
169
- * </kendo-grid>
170
- * ```
116
+ * To allow reordering the column name and the localizable part, the `filterMenuLogicDropDownLabel` accepts a string with a
117
+ * placeholder for the column name, for example, **filter logic for {columnName}**. The `{columnName}` placeholder will be replaced
118
+ * internally with the current column name, and the resulting label will be rendered as **filter logic for Product Name**.
119
+ * [See example](slug:globalization_grid#toc-custom-messages).
171
120
  */
172
121
  filterMenuLogicDropDownLabel: string;
173
122
  /**
@@ -271,36 +220,24 @@ export declare class GridMessages extends ComponentMessages {
271
220
  */
272
221
  filterOrLogic: string;
273
222
  /**
274
- * The loading text.
275
- *
276
- * > The `loading` property is part of the accessibility support of the Grid.
223
+ * The loading text. The `loading` property is part of the accessibility support of the Grid.
277
224
  * Its value is detectable by screen readers and is not otherwise visible.
278
225
  */
279
226
  loading: string;
280
227
  /**
281
- * The text of the aria-label attribute placed on the Grid focusable element.
228
+ * The text of the `aria-label` attribute placed on the Grid focusable element.
282
229
  */
283
230
  gridLabel: string;
284
231
  /**
285
232
  * The title of the column menu icon.
286
233
  *
287
234
  * The title consists of a two-part message - the name of the column and a localizable string.
288
- * For a column named 'Product Name', the default title will be 'Product Name Column Menu'.
289
- *
290
- * To allow reordering the column name and the localizable part, the columnMenu accepts a string with a
291
- * placeholder for the column name - e.g. 'menu for {columnName}'. The '{columnName}' placeholder will be replaced
292
- * internally with the current column name, and the resulting title will be rendered as 'menu for Product Name'.
293
- *
294
- * @example
235
+ * For a column named **Product Name**, the default title will be **Product Name Column Menu**.
295
236
  *
296
- * ```ts-no-run
297
- * <kendo-grid>
298
- * <kendo-grid-messages
299
- * filterMenuTitle="filter for {columnName}"
300
- * >
301
- * </kendo-grid-messages>
302
- * </kendo-grid>
303
- * ```
237
+ * To allow reordering the column name and the localizable part, the `columnMenu` accepts a string with a
238
+ * placeholder for the column name, for example, **menu for {columnName}**. The `{columnName}` placeholder will be replaced
239
+ * internally with the current column name, and the resulting title will be rendered as **menu for Product Name**.
240
+ * [See example](slug:globalization_grid#toc-custom-messages).
304
241
  */
305
242
  columnMenu: string;
306
243
  /**
@@ -402,11 +339,11 @@ export declare class GridMessages extends ComponentMessages {
402
339
  */
403
340
  selectAllCheckboxLabel: string;
404
341
  /**
405
- * The text of the title and aria-label attributes applied to the collapse icon of group rows.
342
+ * The text of the title and `aria-label` attributes applied to the collapse icon of group rows.
406
343
  */
407
344
  groupCollapse: string;
408
345
  /**
409
- * The text of the title and aria-label attributes applied to the expand icon of group rows.
346
+ * The text of the title and `aria-label` attributes applied to the expand icon of group rows.
410
347
  */
411
348
  groupExpand: string;
412
349
  /**
@@ -4,9 +4,23 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
6
  * Represents the possible navigable sections of the Grid ([see example]({% slug keyboard_navigation_grid %}#toc-navigable-sections)).
7
+ *
8
+ * The available values are:
9
+ * * `pager`&mdash;Includes the Grid pager and its internal elements
10
+ * * `table`&mdash;Includes the Grid pager and its internal elements
11
+ * * `toolbar`&mdash;Includes the Grid toolbars and the group panel when the Grid is groupable.
12
+ *
13
+ * @xample
14
+ * ```html
15
+ * <kendo-grid [navigable]="['pager', 'toolbar']"> </kendo-grid>
16
+ * ```
7
17
  */
8
18
  export declare type GridNavigableSection = 'pager' | 'table' | 'toolbar';
9
19
  /**
10
- * Represents the type of the Grid [`navigable`]({% slug api_grid_gridcomponent %}#toc-navigable) option.
20
+ * Represents the type of the Grid [`navigable`]({% slug api_grid_gridcomponent %}#toc-navigable) property.
21
+ *
22
+ * The available values are:
23
+ * * `boolean`
24
+ * * [`GridNavigableSection`](slug:api_grid_gridnavigablesection)
11
25
  */
12
26
  export declare type GridNavigableSettings = boolean | GridNavigableSection[];
@@ -17,11 +17,8 @@ export interface NavigationCell {
17
17
  */
18
18
  colIndex: number;
19
19
  /**
20
- * The logical index of the row which contains this cell.
21
- *
22
- * * Header rows are included, starting at index 0.
23
- * * Group headers and footers are included.
24
- * * The row indexing is absolute and does not change with paging.
20
+ * The logical index of the row which contains this cell. The row indexing is absolute and does not change with paging.
21
+ * Group headers and footers are included. Header rows are included, starting at index 0.
25
22
  */
26
23
  rowIndex: number;
27
24
  /**
@@ -14,11 +14,8 @@ export interface NavigationRow {
14
14
  */
15
15
  uid: number;
16
16
  /**
17
- * The logical index of the focusable row.
18
- *
19
- * * Header rows are included, starting at index 0.
20
- * * Group headers and footers are included.
21
- * * The row indexing is absolute and does not change with paging.
17
+ * The logical index of the focusable row. The row indexing is absolute and does not change with paging.
18
+ * Group headers and footers are included. Header rows are included, starting at index 0.
22
19
  */
23
20
  index: number;
24
21
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@progress/kendo-angular-grid",
3
- "version": "12.0.0-develop.9",
3
+ "version": "12.0.1-develop.1",
4
4
  "description": "Kendo UI Grid for Angular - high performance data grid with paging, filtering, virtualization, CRUD, and more.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "author": "Progress",
@@ -25,31 +25,31 @@
25
25
  "friendlyName": "Grid"
26
26
  },
27
27
  "peerDependencies": {
28
- "@angular/animations": "13 - 15",
29
- "@angular/common": "13 - 15",
30
- "@angular/core": "13 - 15",
31
- "@angular/platform-browser": "13 - 15",
28
+ "@angular/animations": "13 - 16",
29
+ "@angular/common": "13 - 16",
30
+ "@angular/core": "13 - 16",
31
+ "@angular/platform-browser": "13 - 16",
32
32
  "@progress/kendo-data-query": "^1.0.0",
33
33
  "@progress/kendo-drawing": "^1.17.2",
34
34
  "@progress/kendo-licensing": "^1.0.2",
35
- "@progress/kendo-angular-buttons": "12.0.0-develop.9",
36
- "@progress/kendo-angular-common": "12.0.0-develop.9",
37
- "@progress/kendo-angular-dateinputs": "12.0.0-develop.9",
38
- "@progress/kendo-angular-dropdowns": "12.0.0-develop.9",
39
- "@progress/kendo-angular-excel-export": "12.0.0-develop.9",
40
- "@progress/kendo-angular-icons": "12.0.0-develop.9",
41
- "@progress/kendo-angular-inputs": "12.0.0-develop.9",
42
- "@progress/kendo-angular-intl": "12.0.0-develop.9",
43
- "@progress/kendo-angular-l10n": "12.0.0-develop.9",
44
- "@progress/kendo-angular-label": "12.0.0-develop.9",
45
- "@progress/kendo-angular-pdf-export": "12.0.0-develop.9",
46
- "@progress/kendo-angular-popup": "12.0.0-develop.9",
47
- "@progress/kendo-angular-utils": "12.0.0-develop.9",
35
+ "@progress/kendo-angular-buttons": "12.0.1-develop.1",
36
+ "@progress/kendo-angular-common": "12.0.1-develop.1",
37
+ "@progress/kendo-angular-dateinputs": "12.0.1-develop.1",
38
+ "@progress/kendo-angular-dropdowns": "12.0.1-develop.1",
39
+ "@progress/kendo-angular-excel-export": "12.0.1-develop.1",
40
+ "@progress/kendo-angular-icons": "12.0.1-develop.1",
41
+ "@progress/kendo-angular-inputs": "12.0.1-develop.1",
42
+ "@progress/kendo-angular-intl": "12.0.1-develop.1",
43
+ "@progress/kendo-angular-l10n": "12.0.1-develop.1",
44
+ "@progress/kendo-angular-label": "12.0.1-develop.1",
45
+ "@progress/kendo-angular-pdf-export": "12.0.1-develop.1",
46
+ "@progress/kendo-angular-popup": "12.0.1-develop.1",
47
+ "@progress/kendo-angular-utils": "12.0.1-develop.1",
48
48
  "rxjs": "^6.5.3 || ^7.0.0"
49
49
  },
50
50
  "dependencies": {
51
51
  "tslib": "^2.3.1",
52
- "@progress/kendo-angular-schematics": "12.0.0-develop.9",
52
+ "@progress/kendo-angular-schematics": "12.0.1-develop.1",
53
53
  "@progress/kendo-common": "^0.2.0",
54
54
  "@progress/kendo-file-saver": "^1.0.0"
55
55
  },
@@ -8,7 +8,7 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
8
8
  import { PagerContextService, PagerContextChanges } from "./pager-context.service";
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
- * Displays information about the current page and the total number of records ([see example]({% slug paging_grid %}#toc-pager-templates)).
11
+ * Displays information about the current page and the total number of records ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
12
12
  */
13
13
  export declare class PagerInfoComponent extends PagerElementComponent {
14
14
  protected pagerContext: PagerContextService;
@@ -10,54 +10,7 @@ import { LocalizationService } from "@progress/kendo-angular-l10n";
10
10
  import { PagerContextService, PagerContextChanges } from "./pager-context.service";
11
11
  import * as i0 from "@angular/core";
12
12
  /**
13
- * Displays an input element which allows the typing and rendering of page numbers.
14
- *
15
- * @example
16
- * ```ts-preview
17
- *
18
- * _@Component({
19
- * selector: 'my-app',
20
- * template: `
21
- * <kendo-grid
22
- * [kendoGridBinding]="gridData"
23
- * [pageSize]="1"
24
- * [pageable]="true"
25
- * >
26
- * <kendo-grid-column field="ProductID" title="ID" [width]="40">
27
- * </kendo-grid-column>
28
- * <kendo-grid-column field="ProductName" title="Name" [width]="250">
29
- * </kendo-grid-column>
30
- * <kendo-grid-column field="UnitPrice" title="Price" [width]="80" format="{0:c}">
31
- * </kendo-grid-column>
32
- *
33
- * <ng-template kendoPagerTemplate let-totalPages="totalPages" let-currentPage="currentPage">
34
- * <kendo-pager-prev-buttons></kendo-pager-prev-buttons>
35
- * <kendo-pager-numeric-buttons [buttonCount]="10"></kendo-pager-numeric-buttons>
36
- * <kendo-pager-next-buttons></kendo-pager-next-buttons>
37
- * <kendo-pager-input></kendo-pager-input>
38
- * <kendo-pager-info></kendo-pager-info>
39
- * </ng-template>
40
- *
41
- * </kendo-grid>
42
- * `
43
- * })
44
- *
45
- * class AppComponent {
46
- * public gridData = [{
47
- * "ProductID": 1,
48
- * "ProductName": "Chai",
49
- * "UnitPrice": 18.0000,
50
- * "Discontinued": false
51
- * }, {
52
- * "ProductID": 2,
53
- * "ProductName": "Chang",
54
- * "UnitPrice": 19.0000,
55
- * "Discontinued": true
56
- * }
57
- * ];
58
- * }
59
- *
60
- * ```
13
+ * Displays an input element which allows the typing and rendering of page numbers ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
61
14
  */
62
15
  export declare class PagerInputComponent extends PagerElementComponent {
63
16
  protected pagerContext: PagerContextService;
@@ -10,7 +10,7 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
10
10
  import { SVGIcon } from '@progress/kendo-svg-icons';
11
11
  import * as i0 from "@angular/core";
12
12
  /**
13
- * Displays buttons for navigating to the next and to the last page ([see example]({% slug paging_grid %}#toc-pager-template)).
13
+ * Displays buttons for navigating to the next and to the last page ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
14
14
  */
15
15
  export declare class PagerNextButtonsComponent extends PagerElementComponent {
16
16
  navigationService: NavigationService;
@@ -8,7 +8,7 @@ import { PagerContextChanges, PagerContextService } from './pager-context.servic
8
8
  import { PagerElementComponent } from './pager-element.component';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
- * Displays numeric buttons to enable navigation between the pages.
11
+ * Displays numeric buttons to enable navigation between the pages ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
12
12
  */
13
13
  export declare class PagerNumericButtonsComponent extends PagerElementComponent {
14
14
  protected pagerContext: PagerContextService;
@@ -10,103 +10,14 @@ import { PagerContextService, PagerContextChanges } from './pager-context.servic
10
10
  import { PageSizeItem } from './pagesize-item.interface';
11
11
  import * as i0 from "@angular/core";
12
12
  /**
13
- * Displays a drop-down list for the page size selection ([see example]({% slug paging_grid %}#toc-pager-templates)).
13
+ * Displays a drop-down list for the page size selection ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
14
14
  */
15
15
  export declare class PagerPageSizesComponent extends PagerElementComponent {
16
16
  protected pagerContext: PagerContextService;
17
17
  navigationService: NavigationService;
18
18
  /**
19
- * The page sizes collection. Can be an Array of numbers and/or PageSizeItem objects.
20
- *
21
- * @example
22
- * ```ts-preview
23
- * _@Component({
24
- * selector: 'my-app',
25
- * template: `
26
- * <kendo-grid [kendoGridBinding]="gridData" [height]="200"
27
- * [pageable]="true"
28
- * [pageSize]="pageSize">
29
- * <ng-template kendoPagerTemplate let-totalPages="totalPages" let-currentPage="currentPage">
30
- * <kendo-pager-page-sizes [pageSizes]="pagesizes"></kendo-pager-page-sizes>
31
- * </ng-template>
32
- * </kendo-grid>
33
- * `
34
- * })
35
- * class AppComponent {
36
- * public gridData: any[] = products;
37
- * public pageSize = 2;
38
- * public pagesizes = [{text: 'One', value: 1}, {text: 'Two', value: 2}, {text: 'All', value : 'all'}];
39
- * }
40
- *
41
- * const products = [{
42
- * 'ProductID' : 1,
43
- * 'ProductName' : "Chai",
44
- * 'SupplierID' : 1,
45
- * 'CategoryID' : 1,
46
- * 'QuantityPerUnit' : "10 boxes x 20 bags",
47
- * 'UnitPrice' : 18.0000,
48
- * 'UnitsInStock' : 39,
49
- * 'UnitsOnOrder' : 0,
50
- * 'ReorderLevel' : 10,
51
- * 'Discontinued' : false
52
- *
53
- * }, {
54
- * 'ProductID' : 2,
55
- * 'ProductName' : "Chang",
56
- * 'SupplierID' : 1,
57
- * 'CategoryID' : 1,
58
- * 'QuantityPerUnit' : "24 - 12 oz bottles",
59
- * 'UnitPrice' : 19.0000,
60
- * 'UnitsInStock' : 17,
61
- * 'UnitsOnOrder' : 40,
62
- * 'ReorderLevel' : 25,
63
- * 'Discontinued' : false
64
- * }, {
65
- * 'ProductID' : 3,
66
- * 'ProductName' : "Aniseed Syrup",
67
- * 'SupplierID' : 1,
68
- * 'CategoryID' : 2,
69
- * 'QuantityPerUnit' : "12 - 550 ml bottles",
70
- * 'UnitPrice' : 10.0000,
71
- * 'UnitsInStock' : 13,
72
- * 'UnitsOnOrder' : 70,
73
- * 'ReorderLevel' : 25,
74
- * 'Discontinued' : false
75
- * }, {
76
- * 'ProductID' : 4,
77
- * 'ProductName' : "Chef Anton\'s Cajun Seasoning",
78
- * 'SupplierID' : 2,
79
- * 'CategoryID' : 2,
80
- * 'QuantityPerUnit' : "48 - 6 oz jars",
81
- * 'UnitPrice' : 22.0000,
82
- * 'UnitsInStock' : 53,
83
- * 'UnitsOnOrder' : 0,
84
- * 'ReorderLevel' : 0,
85
- * 'Discontinued' : false
86
- * }, {
87
- * 'ProductID' : 5,
88
- * 'ProductName' : "Chef Anton\'s Gumbo Mix",
89
- * 'SupplierID' : 2,
90
- * 'CategoryID' : 2,
91
- * 'QuantityPerUnit' : "36 boxes",
92
- * 'UnitPrice' : 21.3500,
93
- * 'UnitsInStock' : 0,
94
- * 'UnitsOnOrder' : 0,
95
- * 'ReorderLevel' : 0,
96
- * 'Discontinued' : true
97
- * }, {
98
- * 'ProductID' : 6,
99
- * 'ProductName' : "Grandma\'s Boysenberry Spread",
100
- * 'SupplierID' : 3,
101
- * 'CategoryID' : 2,
102
- * 'QuantityPerUnit' : "12 - 8 oz jars",
103
- * 'UnitPrice' : 25.0000,
104
- * 'UnitsInStock' : 120,
105
- * 'UnitsOnOrder' : 0,
106
- * 'ReorderLevel' : 25,
107
- * 'Discontinued' : false
108
- * }];
109
- * ```
19
+ * The page sizes collection. Can be an Array of numbers and/or [`PageSizeItem`](slug:api_grid_pagesizeitem) objects
20
+ * ([see example]({% slug paging_grid %}#toc-pager-templates))
110
21
  */
111
22
  set pageSizes(pageSizes: Array<PageSizeItem | number>);
112
23
  get pageSizes(): Array<PageSizeItem | number>;
@@ -10,7 +10,7 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
10
10
  import { SVGIcon } from '@progress/kendo-svg-icons';
11
11
  import * as i0 from "@angular/core";
12
12
  /**
13
- * Displays buttons for navigating to the first and to the previous page ([see example]({% slug paging_grid %}#toc-pager-templates)).
13
+ * Displays buttons for navigating to the first and to the previous page ([see example](slug:pager_template_grid#toc-using-built-in-pager-components)).
14
14
  */
15
15
  export declare class PagerPrevButtonsComponent extends PagerElementComponent {
16
16
  navigationService: NavigationService;
@@ -10,12 +10,10 @@
10
10
  * * `input`&mdash;Input for typing the page number.
11
11
  *
12
12
  * @example
13
- * ```html-no-run
14
- *
15
- * <kendo-grid
16
- * [pageable]="{
17
- * type: 'numeric'
18
- * }">
13
+ * ```html
14
+ * <kendo-grid [pageable]="{ type: 'numeric' }">
15
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
16
+ * ...
19
17
  * </kendo-grid>
20
18
  * ```
21
19
  */
@@ -29,73 +27,46 @@ export declare type PagerType = 'numeric' | 'input';
29
27
  * * `both`&mdash;Two pagers are rendered - one above the Grid headers, and one - below the data table.
30
28
  *
31
29
  * @example
32
- * ```html-no-run
33
- *
34
- * <kendo-grid
35
- * [pageable]="{
36
- * position: 'both'
37
- * }">
30
+ * ```html
31
+ * <kendo-grid [pageable]="{ position: 'both' }">
32
+ * <kendo-grid-column field="ProductID"></kendo-grid-column>
33
+ * ...
38
34
  * </kendo-grid>
39
35
  * ```
40
36
  */
41
37
  export declare type PagerPosition = 'top' | 'bottom' | 'both';
42
38
  /**
43
- * The pager settings of the Grid ([see example]({% slug paging_grid %}#toc-pager-settings)).
44
- *
45
- * @example
46
- * ```html-no-run
47
- *
48
- * <kendo-grid
49
- * [pageable]="{
50
- * buttonCount: 2,
51
- * info: false
52
- * }">
53
- * </kendo-grid>
54
- * ```
39
+ * The pager settings of the Grid ([see example](slug:paging_grid_settings)).
55
40
  */
56
41
  export interface PagerSettings {
57
42
  /**
58
43
  * Sets the maximum numeric buttons count before the buttons are collapsed.
59
- *
60
- * @default 10
61
44
  */
62
45
  buttonCount?: number;
63
46
  /**
64
47
  * Toggles the information about the current page and the total number of records.
65
- *
66
- * @default true
67
48
  */
68
49
  info?: boolean;
69
50
  /**
70
51
  * Defines the type of the Grid pager.
71
- *
72
- * @default 'numeric'
73
52
  */
74
53
  type?: PagerType;
75
54
  /**
76
55
  * Shows a menu for selecting the page size.
77
- *
78
- * @default false
79
56
  */
80
57
  pageSizes?: boolean | Array<number>;
81
58
  /**
82
59
  * Toggles the **Previous** and **Next** buttons.
83
- *
84
- * @default true
85
60
  */
86
61
  previousNext?: boolean;
87
62
  /**
88
63
  * Toggles the built-in responsive behavior of the Pager.
89
64
  * Available in version `5.0.0` and above ([see example]({% slug paging_grid %}#toc-responsive-pager)).
90
- *
91
- * @default true
92
65
  */
93
66
  responsive?: boolean;
94
67
  /**
95
68
  * Defines the Pager position relative to the Grid data table.
96
69
  * The possible values are 'top', 'bottom', and 'both' ([see example]({% slug paging_grid %}#toc-pager-settings)).
97
- *
98
- * @default 'bottom'
99
70
  */
100
71
  position?: PagerPosition;
101
72
  }