@progress/kendo-angular-grid 19.1.2-develop.3 → 19.1.2-develop.5

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 (322) hide show
  1. package/adaptiveness/adaptive-mode.d.ts +1 -5
  2. package/aggregates/aggregate-types.d.ts +6 -6
  3. package/aggregates/status-bar-template.directive.d.ts +6 -4
  4. package/column-menu/column-locked-change-event.d.ts +1 -1
  5. package/column-menu/column-menu-autosize-all.component.d.ts +11 -2
  6. package/column-menu/column-menu-autosize.component.d.ts +14 -6
  7. package/column-menu/column-menu-chooser.component.d.ts +13 -5
  8. package/column-menu/column-menu-expandable-item.interface.d.ts +3 -3
  9. package/column-menu/column-menu-filter.component.d.ts +18 -5
  10. package/column-menu/column-menu-item-base.d.ts +2 -2
  11. package/column-menu/column-menu-item-content-template.directive.d.ts +4 -4
  12. package/column-menu/column-menu-item.component.d.ts +14 -7
  13. package/column-menu/column-menu-item.directive.d.ts +29 -1
  14. package/column-menu/column-menu-lock.component.d.ts +11 -3
  15. package/column-menu/column-menu-position.component.d.ts +16 -8
  16. package/column-menu/column-menu-settings.interface.d.ts +5 -4
  17. package/column-menu/column-menu-sort.component.d.ts +11 -9
  18. package/column-menu/column-menu-stick.component.d.ts +13 -5
  19. package/column-menu/column-menu-template.directive.d.ts +5 -7
  20. package/column-menu/column-menu.component.d.ts +17 -7
  21. package/column-menu/column-menu.service.d.ts +8 -9
  22. package/column-resizing/column-resize.interface.d.ts +9 -8
  23. package/columns/cell-rowspan.d.ts +5 -1
  24. package/columns/checkbox-column.component.d.ts +7 -5
  25. package/columns/column-base.d.ts +38 -52
  26. package/columns/column-group.component.d.ts +3 -2
  27. package/columns/column.component.d.ts +17 -12
  28. package/columns/command-column.component.d.ts +6 -7
  29. package/columns/reorder-column.component.d.ts +10 -2
  30. package/columns/sort-settings.d.ts +15 -18
  31. package/columns/span-column.component.d.ts +11 -11
  32. package/common/adaptiveness.service.d.ts +2 -2
  33. package/common/cell-click-event-args.interface.d.ts +8 -6
  34. package/common/clipboard-types.d.ts +27 -31
  35. package/common/clipboard.directive.d.ts +12 -8
  36. package/common/create-form-group.d.ts +3 -1
  37. package/common/fetch-data-callback.d.ts +4 -2
  38. package/common/field-datatype.d.ts +2 -2
  39. package/common/pager-settings.d.ts +36 -20
  40. package/common/preventable-event.d.ts +3 -7
  41. package/common/remove-confirmation.d.ts +12 -0
  42. package/common/resizable-settings.d.ts +6 -5
  43. package/common/single-popup.service.d.ts +7 -4
  44. package/common/size-options.d.ts +2 -1
  45. package/data/change-event-args.interface.d.ts +7 -7
  46. package/data/data-item.interface.d.ts +6 -6
  47. package/data/data.collection.d.ts +1 -1
  48. package/data/grid-item.interface.d.ts +1 -1
  49. package/data/group-footer-item.interface.d.ts +6 -6
  50. package/data/group-item.interface.d.ts +5 -5
  51. package/databinding.directive.d.ts +20 -10
  52. package/directives.d.ts +10 -1
  53. package/dragdrop/column-reorder-config.d.ts +2 -2
  54. package/dragdrop/column-reorder-event.d.ts +4 -6
  55. package/editing/add-command-tool.directive.d.ts +5 -7
  56. package/editing/add-command.directive.d.ts +3 -8
  57. package/editing/add-event-args.interface.d.ts +1 -1
  58. package/editing/cancel-command-tool.directive.d.ts +5 -5
  59. package/editing/cancel-command.directive.d.ts +6 -5
  60. package/editing/cancel-event-args.interface.d.ts +7 -1
  61. package/editing/cell-close-event.d.ts +9 -6
  62. package/editing/edit-command-tool.directive.d.ts +10 -9
  63. package/editing/edit-command.directive.d.ts +1 -1
  64. package/editing/edit-event-args.interface.d.ts +3 -3
  65. package/editing/edit-row-options.interface.d.ts +10 -4
  66. package/editing/edit-template.directive.d.ts +17 -9
  67. package/editing/form/models.d.ts +55 -48
  68. package/editing/remove-command-tool.directive.d.ts +10 -9
  69. package/editing/remove-command.directive.d.ts +4 -5
  70. package/editing/remove-event-args.interface.d.ts +2 -1
  71. package/editing/save-command-tool.directive.d.ts +7 -6
  72. package/editing/save-command.directive.d.ts +5 -5
  73. package/editing/save-event-args.interface.d.ts +2 -1
  74. package/editing-directives/create-form-group-args.interface.d.ts +1 -1
  75. package/editing-directives/edit-service.interface.d.ts +13 -6
  76. package/editing-directives/external-editing.directive.d.ts +11 -4
  77. package/editing-directives/in-cell-editing.directive.d.ts +9 -3
  78. package/editing-directives/reactive-editing.directive.d.ts +9 -3
  79. package/editing-directives/template-editing.directive.d.ts +9 -3
  80. package/esm2022/aggregates/status-bar-template.directive.mjs +6 -4
  81. package/esm2022/column-menu/column-locked-change-event.mjs +1 -1
  82. package/esm2022/column-menu/column-menu-autosize-all.component.mjs +11 -2
  83. package/esm2022/column-menu/column-menu-autosize.component.mjs +14 -6
  84. package/esm2022/column-menu/column-menu-chooser.component.mjs +13 -5
  85. package/esm2022/column-menu/column-menu-filter.component.mjs +18 -5
  86. package/esm2022/column-menu/column-menu-item-base.mjs +2 -2
  87. package/esm2022/column-menu/column-menu-item-content-template.directive.mjs +4 -4
  88. package/esm2022/column-menu/column-menu-item.component.mjs +14 -7
  89. package/esm2022/column-menu/column-menu-item.directive.mjs +29 -1
  90. package/esm2022/column-menu/column-menu-lock.component.mjs +11 -3
  91. package/esm2022/column-menu/column-menu-position.component.mjs +16 -8
  92. package/esm2022/column-menu/column-menu-sort.component.mjs +11 -9
  93. package/esm2022/column-menu/column-menu-stick.component.mjs +13 -5
  94. package/esm2022/column-menu/column-menu-template.directive.mjs +5 -7
  95. package/esm2022/column-menu/column-menu.component.mjs +17 -7
  96. package/esm2022/column-menu/column-menu.service.mjs +8 -9
  97. package/esm2022/columns/checkbox-column.component.mjs +7 -5
  98. package/esm2022/columns/column-base.mjs +38 -52
  99. package/esm2022/columns/column-group.component.mjs +3 -2
  100. package/esm2022/columns/column.component.mjs +17 -12
  101. package/esm2022/columns/command-column.component.mjs +6 -7
  102. package/esm2022/columns/reorder-column.component.mjs +10 -2
  103. package/esm2022/columns/span-column.component.mjs +11 -11
  104. package/esm2022/common/adaptiveness.service.mjs +2 -2
  105. package/esm2022/common/clipboard.directive.mjs +12 -8
  106. package/esm2022/common/preventable-event.mjs +3 -7
  107. package/esm2022/common/resizable-settings.mjs +2 -1
  108. package/esm2022/common/single-popup.service.mjs +7 -4
  109. package/esm2022/databinding.directive.mjs +20 -10
  110. package/esm2022/directives.mjs +10 -1
  111. package/esm2022/dragdrop/column-reorder-event.mjs +4 -6
  112. package/esm2022/editing/add-command-tool.directive.mjs +5 -7
  113. package/esm2022/editing/add-command.directive.mjs +3 -8
  114. package/esm2022/editing/cancel-command-tool.directive.mjs +5 -5
  115. package/esm2022/editing/cancel-command.directive.mjs +6 -5
  116. package/esm2022/editing/cell-close-event.mjs +7 -4
  117. package/esm2022/editing/edit-command-tool.directive.mjs +10 -9
  118. package/esm2022/editing/edit-command.directive.mjs +1 -1
  119. package/esm2022/editing/edit-template.directive.mjs +17 -9
  120. package/esm2022/editing/remove-command-tool.directive.mjs +10 -9
  121. package/esm2022/editing/remove-command.directive.mjs +4 -5
  122. package/esm2022/editing/save-command-tool.directive.mjs +7 -6
  123. package/esm2022/editing/save-command.directive.mjs +5 -5
  124. package/esm2022/editing-directives/external-editing.directive.mjs +11 -4
  125. package/esm2022/editing-directives/in-cell-editing.directive.mjs +9 -3
  126. package/esm2022/editing-directives/reactive-editing.directive.mjs +9 -3
  127. package/esm2022/editing-directives/template-editing.directive.mjs +9 -3
  128. package/esm2022/excel/excel-command-tool.directive.mjs +10 -13
  129. package/esm2022/excel/excel-command.directive.mjs +7 -11
  130. package/esm2022/excel/excel-export-event.mjs +4 -1
  131. package/esm2022/excel/excel.component.mjs +24 -25
  132. package/esm2022/excel/excel.module.mjs +4 -7
  133. package/esm2022/filtering/boolean-filter.component.mjs +3 -3
  134. package/esm2022/filtering/cell/boolean-filter-cell.component.mjs +1 -2
  135. package/esm2022/filtering/cell/date-filter-cell.component.mjs +5 -2
  136. package/esm2022/filtering/cell/filter-cell-operators.component.mjs +10 -7
  137. package/esm2022/filtering/cell/filter-cell-template.directive.mjs +4 -2
  138. package/esm2022/filtering/cell/numeric-filter-cell.component.mjs +10 -9
  139. package/esm2022/filtering/cell/string-filter-cell.component.mjs +7 -5
  140. package/esm2022/filtering/date-filter.component.mjs +17 -19
  141. package/esm2022/filtering/filter.service.mjs +4 -4
  142. package/esm2022/filtering/menu/boolean-filter-menu.component.mjs +3 -3
  143. package/esm2022/filtering/menu/date-filter-menu.component.mjs +5 -3
  144. package/esm2022/filtering/menu/filter-menu-template.directive.mjs +9 -7
  145. package/esm2022/filtering/menu/numeric-filter-menu-input.component.mjs +8 -8
  146. package/esm2022/filtering/menu/numeric-filter-menu.component.mjs +10 -6
  147. package/esm2022/filtering/menu/string-filter-menu.component.mjs +10 -5
  148. package/esm2022/filtering/numeric-filter.component.mjs +13 -13
  149. package/esm2022/filtering/operators/after-eq-filter-operator.component.mjs +26 -0
  150. package/esm2022/filtering/operators/after-filter-operator.component.mjs +26 -0
  151. package/esm2022/filtering/operators/before-eq-filter-operator.component.mjs +26 -0
  152. package/esm2022/filtering/operators/before-filter-operator.component.mjs +26 -0
  153. package/esm2022/filtering/operators/contains-filter-operator.component.mjs +27 -1
  154. package/esm2022/filtering/operators/ends-with-filter-operator.component.mjs +26 -1
  155. package/esm2022/filtering/operators/eq-filter-operator.component.mjs +74 -1
  156. package/esm2022/filtering/operators/gt-filter-operator.component.mjs +26 -0
  157. package/esm2022/filtering/operators/gte-filter-operator.component.mjs +26 -0
  158. package/esm2022/filtering/operators/is-empty-filter-operator.component.mjs +26 -1
  159. package/esm2022/filtering/operators/is-not-empty-filter-operator.component.mjs +26 -1
  160. package/esm2022/filtering/operators/is-not-null-filter-operator.component.mjs +73 -1
  161. package/esm2022/filtering/operators/isnull-filter-operator.component.mjs +73 -1
  162. package/esm2022/filtering/operators/lt-filter-operator.component.mjs +26 -1
  163. package/esm2022/filtering/operators/lte-filter-operator.component.mjs +26 -1
  164. package/esm2022/filtering/operators/neq-filter-operator.component.mjs +73 -1
  165. package/esm2022/filtering/operators/not-contains-filter-operator.component.mjs +26 -1
  166. package/esm2022/filtering/operators/starts-with-filter-operator.component.mjs +26 -1
  167. package/esm2022/filtering/string-filter.component.mjs +5 -4
  168. package/esm2022/grid.component.mjs +159 -173
  169. package/esm2022/grid.module.mjs +3 -2
  170. package/esm2022/grouping/group-footer-template.directive.mjs +5 -6
  171. package/esm2022/grouping/group-header-column-template.directive.mjs +5 -5
  172. package/esm2022/grouping/group-header-template.directive.mjs +5 -6
  173. package/esm2022/grouping/group-scroll-binding.directive.mjs +2 -0
  174. package/esm2022/localization/custom-messages.component.mjs +12 -2
  175. package/esm2022/localization/messages.mjs +154 -165
  176. package/esm2022/navigation/focus-group.mjs +2 -2
  177. package/esm2022/navigation/focusable.directive.mjs +5 -3
  178. package/esm2022/package-metadata.mjs +2 -2
  179. package/esm2022/pdf/pdf-command-tool.directive.mjs +8 -11
  180. package/esm2022/pdf/pdf-command.directive.mjs +5 -9
  181. package/esm2022/pdf/pdf-export-event.mjs +1 -1
  182. package/esm2022/pdf/pdf-margin.component.mjs +16 -6
  183. package/esm2022/pdf/pdf-template.directive.mjs +5 -5
  184. package/esm2022/pdf/pdf.component.mjs +15 -5
  185. package/esm2022/pdf/pdf.module.mjs +3 -6
  186. package/esm2022/rendering/cell-loading.template.directive.mjs +4 -7
  187. package/esm2022/rendering/cell-template.directive.mjs +7 -8
  188. package/esm2022/rendering/common/spacer.component.mjs +14 -3
  189. package/esm2022/rendering/details/detail-collapse-event.mjs +8 -3
  190. package/esm2022/rendering/details/detail-expand-event.mjs +8 -3
  191. package/esm2022/rendering/details/detail-template.directive.mjs +3 -2
  192. package/esm2022/rendering/details-expand.directive.mjs +18 -8
  193. package/esm2022/rendering/footer/footer-template.directive.mjs +7 -7
  194. package/esm2022/rendering/groups-expand.directive.mjs +15 -5
  195. package/esm2022/rendering/header/header-template.directive.mjs +11 -11
  196. package/esm2022/rendering/loading-template.directive.mjs +14 -3
  197. package/esm2022/rendering/no-records-template.directive.mjs +3 -5
  198. package/esm2022/rendering/table-body.component.mjs +3 -1
  199. package/esm2022/rendering/toolbar/toolbar-focusable.directive.mjs +10 -2
  200. package/esm2022/rendering/toolbar/toolbar-position.mjs +0 -17
  201. package/esm2022/rendering/toolbar/toolbar-template.directive.mjs +3 -3
  202. package/esm2022/rendering/toolbar/tools/column-chooser-tool.directive.mjs +6 -5
  203. package/esm2022/rendering/toolbar/tools/filter-command-tool.directive.mjs +5 -5
  204. package/esm2022/rendering/toolbar/tools/group-command-tool.directive.mjs +5 -3
  205. package/esm2022/rendering/toolbar/tools/sort-command-tool.directive.mjs +4 -4
  206. package/esm2022/row-reordering/drag-handle-template.directive.mjs +5 -6
  207. package/esm2022/row-reordering/drag-hint-template.directive.mjs +3 -5
  208. package/esm2022/selection/selectall-checkbox.directive.mjs +2 -2
  209. package/esm2022/selection/selection-checkbox.directive.mjs +9 -8
  210. package/esm2022/selection/selection-default.mjs +9 -8
  211. package/esm2022/selection/selection.directive.mjs +10 -1
  212. package/esm2022/state-management/grid-state.models.mjs +3 -3
  213. package/esm2022/state-management/redo-command-tool.mjs +17 -9
  214. package/esm2022/state-management/undo-command-tool.mjs +17 -9
  215. package/esm2022/state-management/undo-redo.directive.mjs +17 -6
  216. package/excel/excel-command-tool.directive.d.ts +10 -13
  217. package/excel/excel-command.directive.d.ts +7 -11
  218. package/excel/excel-export-event.d.ts +4 -1
  219. package/excel/excel.component.d.ts +24 -25
  220. package/excel/excel.module.d.ts +4 -7
  221. package/fesm2022/progress-kendo-angular-grid.mjs +1939 -1025
  222. package/filtering/boolean-filter.component.d.ts +3 -3
  223. package/filtering/cell/boolean-filter-cell.component.d.ts +1 -2
  224. package/filtering/cell/date-filter-cell.component.d.ts +5 -2
  225. package/filtering/cell/filter-cell-operators.component.d.ts +10 -7
  226. package/filtering/cell/filter-cell-template.directive.d.ts +4 -2
  227. package/filtering/cell/numeric-filter-cell.component.d.ts +10 -9
  228. package/filtering/cell/string-filter-cell.component.d.ts +7 -5
  229. package/filtering/date-filter.component.d.ts +17 -19
  230. package/filtering/filter.service.d.ts +4 -4
  231. package/filtering/filterable.d.ts +5 -5
  232. package/filtering/menu/boolean-filter-menu.component.d.ts +3 -3
  233. package/filtering/menu/date-filter-menu.component.d.ts +5 -3
  234. package/filtering/menu/filter-menu-template.directive.d.ts +9 -7
  235. package/filtering/menu/numeric-filter-menu-input.component.d.ts +8 -8
  236. package/filtering/menu/numeric-filter-menu.component.d.ts +10 -6
  237. package/filtering/menu/string-filter-menu.component.d.ts +10 -5
  238. package/filtering/numeric-filter.component.d.ts +13 -13
  239. package/filtering/operators/after-eq-filter-operator.component.d.ts +26 -0
  240. package/filtering/operators/after-filter-operator.component.d.ts +26 -0
  241. package/filtering/operators/before-eq-filter-operator.component.d.ts +26 -0
  242. package/filtering/operators/before-filter-operator.component.d.ts +26 -0
  243. package/filtering/operators/contains-filter-operator.component.d.ts +27 -1
  244. package/filtering/operators/ends-with-filter-operator.component.d.ts +26 -1
  245. package/filtering/operators/eq-filter-operator.component.d.ts +74 -1
  246. package/filtering/operators/gt-filter-operator.component.d.ts +26 -0
  247. package/filtering/operators/gte-filter-operator.component.d.ts +26 -0
  248. package/filtering/operators/is-empty-filter-operator.component.d.ts +26 -1
  249. package/filtering/operators/is-not-empty-filter-operator.component.d.ts +26 -1
  250. package/filtering/operators/is-not-null-filter-operator.component.d.ts +73 -1
  251. package/filtering/operators/isnull-filter-operator.component.d.ts +73 -1
  252. package/filtering/operators/lt-filter-operator.component.d.ts +26 -1
  253. package/filtering/operators/lte-filter-operator.component.d.ts +26 -1
  254. package/filtering/operators/neq-filter-operator.component.d.ts +73 -1
  255. package/filtering/operators/not-contains-filter-operator.component.d.ts +26 -1
  256. package/filtering/operators/starts-with-filter-operator.component.d.ts +26 -1
  257. package/filtering/string-filter.component.d.ts +5 -4
  258. package/grid.component.d.ts +159 -173
  259. package/grid.module.d.ts +3 -2
  260. package/grouping/group-footer-template.directive.d.ts +5 -6
  261. package/grouping/group-header-column-template.directive.d.ts +5 -5
  262. package/grouping/group-header-template.directive.d.ts +5 -6
  263. package/grouping/group-key.interface.d.ts +7 -7
  264. package/grouping/group-rows-args.interface.d.ts +5 -5
  265. package/grouping/group-scroll-binding.directive.d.ts +2 -0
  266. package/grouping/group-settings.d.ts +7 -7
  267. package/grouping/virtual-group-result.interface.d.ts +3 -3
  268. package/localization/custom-messages.component.d.ts +12 -2
  269. package/localization/messages.d.ts +154 -165
  270. package/navigation/focus-group.d.ts +2 -2
  271. package/navigation/focusable-element.interface.d.ts +8 -9
  272. package/navigation/focusable.directive.d.ts +5 -3
  273. package/navigation/navigable-settings.d.ts +10 -5
  274. package/navigation/navigation-cell.interface.d.ts +8 -8
  275. package/navigation/navigation-row.interface.d.ts +6 -7
  276. package/package.json +20 -20
  277. package/pdf/pdf-command-tool.directive.d.ts +8 -11
  278. package/pdf/pdf-command.directive.d.ts +5 -9
  279. package/pdf/pdf-export-event.d.ts +1 -1
  280. package/pdf/pdf-margin.component.d.ts +16 -6
  281. package/pdf/pdf-margin.interface.d.ts +2 -2
  282. package/pdf/pdf-template.directive.d.ts +5 -5
  283. package/pdf/pdf.component.d.ts +15 -5
  284. package/pdf/pdf.module.d.ts +3 -6
  285. package/rendering/cell-loading.template.directive.d.ts +4 -7
  286. package/rendering/cell-template.directive.d.ts +7 -8
  287. package/rendering/common/row-args.d.ts +2 -0
  288. package/rendering/common/row-class.d.ts +20 -21
  289. package/rendering/common/spacer.component.d.ts +14 -3
  290. package/rendering/details/detail-collapse-event.d.ts +8 -3
  291. package/rendering/details/detail-expand-event.d.ts +8 -3
  292. package/rendering/details/detail-template.directive.d.ts +8 -7
  293. package/rendering/details-expand.directive.d.ts +18 -8
  294. package/rendering/footer/footer-template.directive.d.ts +7 -7
  295. package/rendering/groups-expand.directive.d.ts +15 -5
  296. package/rendering/header/header-template.directive.d.ts +11 -11
  297. package/rendering/loading-template.directive.d.ts +14 -3
  298. package/rendering/no-records-template.directive.d.ts +3 -5
  299. package/rendering/toolbar/toolbar-focusable.directive.d.ts +10 -2
  300. package/rendering/toolbar/toolbar-position.d.ts +5 -5
  301. package/rendering/toolbar/toolbar-template.directive.d.ts +3 -3
  302. package/rendering/toolbar/tools/column-chooser-tool.directive.d.ts +6 -5
  303. package/rendering/toolbar/tools/filter-command-tool.directive.d.ts +5 -5
  304. package/rendering/toolbar/tools/group-command-tool.directive.d.ts +5 -3
  305. package/rendering/toolbar/tools/sort-command-tool.directive.d.ts +4 -4
  306. package/row-reordering/drag-handle-template.directive.d.ts +5 -6
  307. package/row-reordering/drag-hint-template.directive.d.ts +3 -5
  308. package/row-reordering/types.d.ts +10 -10
  309. package/schematics/ngAdd/index.js +4 -4
  310. package/scrolling/content-scroll-event.d.ts +11 -11
  311. package/scrolling/scroll-bottom-event.d.ts +2 -2
  312. package/scrolling/scroll-request.service.d.ts +6 -6
  313. package/scrolling/scrollmode.d.ts +3 -3
  314. package/selection/selectall-checkbox.directive.d.ts +2 -2
  315. package/selection/selection-checkbox.directive.d.ts +9 -8
  316. package/selection/selection-default.d.ts +9 -8
  317. package/selection/selection.directive.d.ts +10 -1
  318. package/selection/types.d.ts +41 -35
  319. package/state-management/grid-state.models.d.ts +16 -7
  320. package/state-management/redo-command-tool.d.ts +14 -6
  321. package/state-management/undo-command-tool.d.ts +14 -6
  322. package/state-management/undo-redo.directive.d.ts +17 -6
@@ -26,135 +26,142 @@ export interface FormControlSettings {
26
26
  templateContext?: any;
27
27
  }
28
28
  /**
29
- * The configurable settings of the built-in external editing form.
29
+ * Configures the built-in external editing form.
30
+ *
31
+ * @example
32
+ * ```typescript
33
+ * const settings: FormSettings = {
34
+ * orientation: 'vertical',
35
+ * showErrors: true,
36
+ * floatingLabels: false,
37
+ * fields: {
38
+ * name: { label: 'Name', hint: 'Enter a name.' }
39
+ * }
40
+ * };
41
+ * ```
30
42
  */
31
43
  export interface FormSettings {
32
44
  /**
33
- * Allows customizing the label, hint, and error messages for each form control.
45
+ * Customizes the label, hint, and error messages for each form control.
34
46
  */
35
47
  fields?: {
36
48
  [key: string]: FormFieldSettings;
37
49
  };
38
50
  /**
39
- * Sets the orientation of the elements within the form.
51
+ * Sets the orientation of the elements in the form.
40
52
  *
41
- * @default 'vertical'
42
53
  */
43
54
  orientation?: Orientation;
44
55
  /**
45
- * Determines whether to display validation errors for each form control.
56
+ * Shows validation errors for each form control.
46
57
  *
47
- * @default true
48
58
  */
49
59
  showErrors?: boolean;
50
60
  /**
51
- * Determines whether to render `FloatingLabel` components instead of the default `Label` components.
61
+ * Renders FloatingLabel components instead of the default Label components.
52
62
  *
53
- * @default false
54
63
  */
55
64
  floatingLabels?: boolean;
56
65
  }
57
66
  /**
58
- * The configurable settings of the form fields in the built-in external editing form.
67
+ * Configures the form fields in the built-in external editing form.
68
+ *
69
+ * @example
70
+ * ```typescript
71
+ * const fieldSettings: FormFieldSettings = {
72
+ * label: 'Email',
73
+ * hint: 'Enter a valid email address.',
74
+ * errors: { required: 'Email is required.' }
75
+ * };
76
+ * ```
59
77
  */
60
78
  export interface FormFieldSettings {
61
79
  /**
62
- * Use this option to pass custom error messages as key-value pairs where the key is the name of the error in
63
- * the `FormControl` validators, and the value is the desired error message to be displayed in the form when the control is invalid.
80
+ * Passes custom error messages as key-value pairs. The key is the error name in the `FormControl` validators, and the value is the error message shown when the control is invalid.
64
81
  *
65
- * The default error message will follow the pattern `The "{fieldName}" field has "{errorName}" validation error`.
82
+ * The default error message is `The "{fieldName}" field has "{errorName}" validation error.`
66
83
  */
67
84
  errors?: {
68
85
  [key: string]: string;
69
86
  };
70
87
  /**
71
- * Use this option to provide custom hint text. By default, no hint message will be displayed.
88
+ * Provides custom hint text. By default, no hint message appears.
72
89
  */
73
90
  hint?: string;
74
91
  /**
75
- * Use this option to provide custom label for the respective form control.
76
- * By default, the column `title` (or `field` when there is no `title` set) will be displayed.
92
+ * Provides a custom label for the form control. By default, the column `title` or `field` appears.
77
93
  */
78
94
  label?: string;
79
95
  }
80
96
  /**
81
- * The settings of the external editing Dialog.
97
+ * Configures the external editing Dialog.
98
+ *
99
+ * @example
100
+ * ```typescript
101
+ * const dialogSettings: FormDialogSettings = {
102
+ * title: 'Edit Item',
103
+ * width: 400,
104
+ * themeColor: 'primary'
105
+ * };
106
+ * ```
82
107
  */
83
108
  export interface FormDialogSettings {
84
109
  /**
85
- * Sets the title of the Dialog. If `title` is omitted,
86
- * the Dialog will not render a **Close** button.
110
+ * Sets the title of the Dialog. If the title is omitted, the Dialog does not render a **Close** button.
87
111
  */
88
112
  title?: string;
89
113
  /**
90
- * Sets the CSS classes that will be rendered on the Dialog wrapper element.
91
- * Supports the union type of values that [ngClass](link:site.data.urls.angular['ngclassapi']) accepts.
114
+ * Sets the CSS classes for the Dialog wrapper element. Supports the union type of values that [`ngClass`](link:site.data.urls.angular['ngclassapi']) accepts.
92
115
  */
93
116
  cssClass?: any;
94
117
  /**
95
- * Configures the Dialog opening animation ([see example]({% slug animations_dialog %})).
96
- * By default the animation type is set to `translate` and its duration is `300ms`.
118
+ * Configures the Dialog opening animation ([see example]({% slug animations_dialog %})). By default, the animation type is `translate` and its duration is `300ms`.
97
119
  */
98
120
  animation?: boolean | DialogAnimation;
99
121
  /**
100
- * Sets the HTML attributes of the Dialog wrapper element.
101
- * The property accepts string key-value based pairs.
122
+ * Sets the HTML attributes of the Dialog wrapper element. Accepts string key-value pairs.
102
123
  */
103
124
  htmlAttributes?: {
104
125
  [key: string]: string;
105
126
  };
106
127
  /**
107
- * Specifies the width of the Dialog.
108
- * A numeric value sets the width in pixels.
109
- * A string value sets the width in arbitrary units—for example, `50%`.
128
+ * Sets the width of the Dialog. A number sets the width in pixels. A string sets the width in arbitrary units, for example, `50%`.
110
129
  */
111
130
  width?: number | string;
112
131
  /**
113
- * Specifies the minimum width of the Dialog.
114
- * A numeric value sets the minimum width in pixels.
115
- * A string value sets the minimum width in arbitrary units—for example, `50%`.
132
+ * Sets the minimum width of the Dialog. A number sets the minimum width in pixels. A string sets the minimum width in arbitrary units, for example, `50%`.
116
133
  */
117
134
  minWidth?: number | string;
118
135
  /**
119
- * Specifies the maximum width of the Dialog.
120
- * A numeric value sets the maximum width in pixels.
121
- * A string value sets the maximum width in arbitrary units—for example, `50%`.
136
+ * Sets the maximum width of the Dialog. A number sets the maximum width in pixels. A string sets the maximum width in arbitrary units, for example, `50%`.
122
137
  */
123
138
  maxWidth?: number | string;
124
139
  /**
125
- * Specifies the height of the Dialog.
126
- * A numeric value sets the height in pixels.
127
- * A string value sets the height in arbitrary units—for example, `50%`.
140
+ * Sets the height of the Dialog. A number sets the height in pixels. A string sets the height in arbitrary units, for example, `50%`.
128
141
  */
129
142
  height?: number | string;
130
143
  /**
131
- * Specifies the minimum height of the Dialog.
132
- * A numeric value sets the minimum height in pixels.
133
- * A string value sets the minimum height in arbitrary units—for example, `50%`.
144
+ * Sets the minimum height of the Dialog. A number sets the minimum height in pixels. A string sets the minimum height in arbitrary units, for example, `50%`.
134
145
  */
135
146
  minHeight?: number | string;
136
147
  /**
137
- * Specifies the maximum height of the Dialog.
138
- * A numeric value sets the maximum height in pixels.
139
- * A string value sets the maximum height in arbitrary units—for example, `50%`.
148
+ * Sets the maximum height of the Dialog. A number sets the maximum height in pixels. A string sets the maximum height in arbitrary units, for example, `50%`.
140
149
  */
141
150
  maxHeight?: number | string;
142
151
  /**
143
- * Defines the container in which the Dialog will be inserted.
144
- * Specifying this option changes the place in the page hierarchy where the Dialog will be inserted.
145
- * The styling of the Dialog will remain the same.
152
+ * Defines the container for the Dialog. Setting this option changes where the Dialog appears in the page hierarchy. The Dialog styling stays the same.
146
153
  */
147
154
  appendTo?: ViewContainerRef;
148
155
  /**
149
- * Specifies the title of the close button.
156
+ * Sets the title of the close button.
150
157
  */
151
158
  closeTitle?: string;
152
159
  /**
153
- * Specifies the layout of the action buttons in the Dialog.
160
+ * Sets the layout of the action buttons in the Dialog.
154
161
  */
155
162
  actionsLayout?: ActionsLayout;
156
163
  /**
157
- * Specifies the theme color of the Dialog.
164
+ * Sets the theme color of the Dialog.
158
165
  */
159
166
  themeColor?: DialogThemeColor;
160
167
  }
@@ -10,21 +10,22 @@ import { ContextService } from '../common/provider.service';
10
10
  import { ToolbarEditingToolBase } from './toolbar-editing-tool-base.directive';
11
11
  import * as i0 from "@angular/core";
12
12
  /**
13
- * Represents the `remove` command in the Grid.
14
- * You can apply this directive to any `kendo-toolbar-button` element inside a
15
- * ToolbarComponent used in the Grid.
13
+ * Represents the `remove` command in the Grid. Apply this directive to any `kendo-toolbar-button`
14
+ * element inside a ToolbarComponent used in the Grid.
16
15
  *
17
- * When the user clicks the toolbar button that is associated with the directive, the
18
- * [remove]({% slug api_grid_gridcomponent %}#toc-remove) event is triggered.
16
+ * When you click the toolbar button with this directive, the
17
+ * [`remove`]({% slug api_grid_gridcomponent %}#toc-remove) event fires.
19
18
  *
20
19
  * @example
21
- * ```html-no-run
20
+ * ```html
22
21
  * <kendo-grid>
23
- * <kendo-toolbar>
24
- * <kendo-toolbar-button text="Remove row" kendoGridRemoveTool></kendo-toolbar-button>
25
- * </kendo-toolbar>
22
+ * <kendo-toolbar>
23
+ * <kendo-toolbar-button text="Remove row" kendoGridRemoveTool></kendo-toolbar-button>
24
+ * </kendo-toolbar>
26
25
  * </kendo-grid>
27
26
  * ```
27
+ * @remarks
28
+ * Applied to: {@link ToolBarButtonComponent}.
28
29
  */
29
30
  export declare class RemoveCommandToolbarDirective extends ToolbarEditingToolBase {
30
31
  editService: EditService;
@@ -9,13 +9,12 @@ import { CellContext } from '../rendering/common/cell-context';
9
9
  import { ContextService } from '../common/provider.service';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * Represents the `remove` command of the Grid. You can apply this directive to any `button` element
12
+ * Represents the `remove` command of the Grid. Apply this directive to any `button` element
13
13
  * inside a [CommandColumnComponent]({% slug api_grid_commandcolumncomponent %})
14
14
  * ([see example](slug:editing_directives_grid#toc-command-column-directives)).
15
- * When an associated button with the directive is clicked, the
16
- * [remove]({% slug api_grid_gridcomponent %}#toc-remove) event
17
- * is triggered.
18
- * When the row is in the `edit` mode, the button with the `kendoGridRemoveCommand` is automatically hidden.
15
+ * When you click the button with this directive, the
16
+ * [`remove`]({% slug api_grid_gridcomponent %}#toc-remove) event fires.
17
+ * The button with `kendoGridRemoveCommand` is automatically hidden when the row is in edit mode.
19
18
  *
20
19
  * @example
21
20
  * ```html
@@ -4,7 +4,8 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { EditEvent } from "./edit-event-args.interface";
6
6
  /**
7
- * Arguments for the `remove` event. [See example](slug:inline_editing_grid#toc-removing-records).
7
+ * Provides the arguments for the `remove` event. [See example](slug:inline_editing_grid#toc-removing-records).
8
+ *
8
9
  */
9
10
  export interface RemoveEvent extends EditEvent {
10
11
  }
@@ -10,21 +10,22 @@ import { ContextService } from '../common/provider.service';
10
10
  import { ToolbarEditingToolBase } from './toolbar-editing-tool-base.directive';
11
11
  import * as i0 from "@angular/core";
12
12
  /**
13
- * Represents the `save` command in the Grid.
14
- * You can apply this directive to any `kendo-toolbar-button` element inside a
15
- * ToolbarComponent used in the Grid.
13
+ * Represents the `save` command in the Grid. Apply this directive to any `kendo-toolbar-button`
14
+ * element inside a ToolbarComponent used in the Grid.
16
15
  *
17
- * When the user clicks the toolbar button that is associated with the directive, the
18
- * [save]({% slug api_grid_gridcomponent %}#toc-save) event is triggered.
16
+ * When you click the toolbar button with this directive, the
17
+ * [`save`]({% slug api_grid_gridcomponent %}#toc-save) event fires.
19
18
  *
20
19
  * @example
21
- * ```html-no-run
20
+ * ```html
22
21
  * <kendo-grid>
23
22
  * <kendo-toolbar>
24
23
  * <kendo-toolbar-button text="Save" kendoGridSaveTool></kendo-toolbar-button>
25
24
  * </kendo-toolbar>
26
25
  * </kendo-grid>
27
26
  * ```
27
+ * @remarks
28
+ * Applied to: {@link ToolBarButtonComponent}.
28
29
  */
29
30
  export declare class SaveCommandToolbarDirective extends ToolbarEditingToolBase {
30
31
  editService: EditService;
@@ -9,14 +9,14 @@ import { CellContext } from '../rendering/common/cell-context';
9
9
  import { ContextService } from '../common/provider.service';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * Represents the `save` command of the Grid. You can apply this directive to any `button`
12
+ * Represents the `save` command of the Grid. Apply this directive to any `button`
13
13
  * element inside a [CommandColumnComponent]({% slug api_grid_commandcolumncomponent %})
14
14
  * ([see example](slug:editing_directives_grid#toc-command-column-directives)).
15
- * When an associated button with the directive is clicked, the
16
- * [save]({% slug api_grid_gridcomponent %}#toc-save) event
17
- * is triggered. When the row is not in the edit mode, the button with `kendoGridSaveCommand` is automatically hidden.
15
+ * When you click the button with this directive, the
16
+ * [`save`]({% slug api_grid_gridcomponent %}#toc-save) event fires.
17
+ * The button with `kendoGridSaveCommand` is automatically hidden when the row is not in edit mode.
18
18
  *
19
- * You can control the content of the button based on the state of the row.
19
+ * You can change the button content based on the row state.
20
20
  *
21
21
  * @example
22
22
  * ```html
@@ -5,7 +5,8 @@
5
5
  import { EditEvent } from "./edit-event-args.interface";
6
6
  import { FormGroup } from "@angular/forms";
7
7
  /**
8
- * Arguments for the `save` event. [See example](slug:inline_editing_grid#toc-saving-records).
8
+ * Provides the arguments for the `save` event. [See example](slug:inline_editing_grid#toc-saving-records).
9
+ *
9
10
  */
10
11
  export interface SaveEvent extends EditEvent {
11
12
  /**
@@ -4,7 +4,7 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { EditEvent } from "../editing/edit-event-args.interface";
6
6
  /**
7
- * The argument that is passed to the `createFormGroup` function.
7
+ * Represents the argument passed to the `createFormGroup` function.
8
8
  */
9
9
  export interface CreateFormGroupArgs extends EditEvent {
10
10
  }
@@ -3,24 +3,31 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * The interface of the `editService` that can be set to the
7
- * [editing directives](slug:editing_directives_grid#toc-custom-editing-service) of the Grid.
6
+ * The interface which must be extended when creating custom edit service.
7
+ * This interface defines the methods that a custom editing service should implement to handle create, update, and remove operations on grid items.
8
+ * Set the custom edit service to the `editService` input of the respective editing directive.
9
+ * [See exampe](slug:editing_directives_grid#toc-custom-editing-service).
8
10
  */
9
11
  export interface EditService {
10
12
  /**
11
- * The method that is called to create the items for new rows.
13
+ * Creates an item for a new row.
14
+ * @param item The item to create.
12
15
  */
13
16
  create(item: any): void;
14
17
  /**
15
- * The method that is called to update the items for existing rows.
18
+ * Updates an item for an existing row.
19
+ * @param item The item to update.
16
20
  */
17
21
  update(item: any): void;
18
22
  /**
19
- * The method that is called to remove existing rows.
23
+ * Removes an existing row.
24
+ * @param item The item to remove.
20
25
  */
21
26
  remove(item: any): void;
22
27
  /**
23
- * The method that is called to set new values to an item.
28
+ * Sets new values to an item.
29
+ * @param target The target item.
30
+ * @param source The source of values.
24
31
  */
25
32
  assignValues(target: any, source: any): void;
26
33
  }
@@ -12,23 +12,30 @@ import { EditEvent } from '../editing/edit-event-args.interface';
12
12
  import { AdaptiveGridService } from '../common/adaptiveness.service';
13
13
  import * as i0 from "@angular/core";
14
14
  /**
15
- * A directive which encapsulates the editing operations of the Grid when using the
15
+ * Represents the Kendo UI Grid external editing directive. The directive manages editing operations in the Grid when using the
16
16
  * External Form ([see example](slug:editing_directives_grid#external-editing)).
17
+ *
18
+ * @example
19
+ * ```typescript
20
+ * <kendo-grid [data]="data" kendoGridExternalEditing></kendo-grid>
21
+ * ```
22
+ * @remarks
23
+ * Applied to: {@link GridComponent}.
17
24
  */
18
25
  export declare class ExternalEditingDirective extends EditingDirectiveBase {
19
26
  protected grid: GridComponent;
20
27
  protected localDataChangesService: LocalDataChangesService;
21
28
  private adaptiveGridService;
22
29
  /**
23
- * The function that creates the `FormGroup` for the edited model.
30
+ * Specifies the function that creates the `FormGroup` for the edited model.
24
31
  */
25
32
  createFormGroup: CreateFormGroup;
26
33
  /**
27
- * Allows you to customize form orientation, hints, labels and error messages.
34
+ * Customizes form orientation, hints, labels, and error messages.
28
35
  */
29
36
  formSettings: FormSettings;
30
37
  /**
31
- * Allows you to customize the Dialog that contains the edit form.
38
+ * Customizes the Dialog that contains the edit form.
32
39
  */
33
40
  dialogSettings: FormDialogSettings;
34
41
  constructor(grid: GridComponent, localDataChangesService: LocalDataChangesService, adaptiveGridService: AdaptiveGridService);
@@ -9,15 +9,21 @@ import { LocalDataChangesService } from '../editing/local-data-changes.service';
9
9
  import { CreateFormGroup } from '../common/create-form-group';
10
10
  import * as i0 from "@angular/core";
11
11
  /**
12
- * A directive which encapsulates the editing operations of the Grid when using the in-cell
13
- * editing with Reactive Forms ([see example]({% slug editing_directives_grid %}#toc-in-cell-editing)).
12
+ * Represent the directive that manages in-cell editing operations in the Grid when using Reactive Forms ([see example]({% slug editing_directives_grid %}#toc-in-cell-editing)).
13
+ *
14
+ * @example
15
+ * ```typescript
16
+ * <kendo-grid [data]="data" kendoGridInCellEditing></kendo-grid>
17
+ * ```
18
+ * @remarks
19
+ * Applied to: {@link GridComponent}.
14
20
  */
15
21
  export declare class InCellEditingDirective extends EditingDirectiveBase {
16
22
  protected grid: GridComponent;
17
23
  protected localDataChangesService: LocalDataChangesService;
18
24
  protected cdr: ChangeDetectorRef;
19
25
  /**
20
- * The function that creates the `FormGroup` for the edited model.
26
+ * Specifies the function that creates the `FormGroup` for the edited model.
21
27
  */
22
28
  createFormGroup: CreateFormGroup;
23
29
  constructor(grid: GridComponent, localDataChangesService: LocalDataChangesService, cdr: ChangeDetectorRef);
@@ -8,14 +8,20 @@ import { LocalDataChangesService } from '../editing/local-data-changes.service';
8
8
  import { CreateFormGroup } from '../common/create-form-group';
9
9
  import * as i0 from "@angular/core";
10
10
  /**
11
- * A directive which encapsulates the editing operations of the Grid when using the
12
- * Reactive Forms ([see example](slug:editing_directives_grid#toc-reactive-editing-directive)).
11
+ * Represents the directive that manages editing operations in the Grid when using Reactive Forms ([see example](slug:editing_directives_grid#toc-reactive-editing-directive)).
12
+ *
13
+ * @example
14
+ * ```typescript
15
+ * <kendo-grid [data]="data" kendoGridReactiveEditing></kendo-grid>
16
+ * ```
17
+ * @remarks
18
+ * Applied to: {@link GridComponent}.
13
19
  */
14
20
  export declare class ReactiveEditingDirective extends RowEditingDirectiveBase {
15
21
  protected grid: GridComponent;
16
22
  protected localDataChangesService: LocalDataChangesService;
17
23
  /**
18
- * The function that creates the `FormGroup` for the edited model.
24
+ * Specifies the function that creates the `FormGroup` for the edited model.
19
25
  */
20
26
  createFormGroup: CreateFormGroup;
21
27
  constructor(grid: GridComponent, localDataChangesService: LocalDataChangesService);
@@ -7,14 +7,20 @@ import { GridComponent } from '../grid.component';
7
7
  import { LocalDataChangesService } from '../editing/local-data-changes.service';
8
8
  import * as i0 from "@angular/core";
9
9
  /**
10
- * A directive which encapsulates the editing operations of the Grid when using
11
- * the Template-Driven Angular Forms ([see example]({% slug editing_directives_grid %}#toc-template-editing-directive)).
10
+ * Represents the directive that manages editing operations in the Grid when using Template-Driven Angular Forms ([see example]({% slug editing_directives_grid %}#toc-template-editing-directive)).
11
+ *
12
+ * @example
13
+ * ```typescript
14
+ * <kendo-grid [data]="data" kendoGridTemplateEditing></kendo-grid>
15
+ * ```
16
+ * @remarks
17
+ * Applied to: {@link GridComponent}.
12
18
  */
13
19
  export declare class TemplateEditingDirective extends RowEditingDirectiveBase {
14
20
  protected grid: GridComponent;
15
21
  protected localDataChangesService: LocalDataChangesService;
16
22
  /**
17
- * The function that creates the `dataItem` for the new rows.
23
+ * Specifies the function that creates the `dataItem` for new rows.
18
24
  */
19
25
  createNewItem: Function;
20
26
  protected dataItem: any;
@@ -5,10 +5,12 @@
5
5
  import { Directive, TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the status bar template of the Grid. Allows you to visualize the aggregates using custom rendering inside the template.
9
- * The template context has the following field:
10
- * - `aggregates`&mdash;The [SelectionAggregates]({% slug api_grid_selectionaggregates %}) object that contains all calculated aggregates.
11
- * Use the Angular [ngFor](link:site.data.urls.angular['ngfor']) structural directive combined with the [KeyValuePipe](https://angular.io/api/common/KeyValuePipe)
8
+ * Represents the status bar template of the Grid. Use this directive to customize how the Grid displays aggregates in the status bar.
9
+ *
10
+ * The template context provides:
11
+ * - `aggregates`&mdash;The [`SelectionAggregates`]({% slug api_grid_selectionaggregates %}) object with all calculated aggregates.
12
+ *
13
+ * Use the Angular [`ngFor`](link:site.data.urls.angular['ngfor']) structural directive and the [`KeyValuePipe`](https://angular.io/api/common/KeyValuePipe)
12
14
  * to loop through the aggregates as key-value pairs.
13
15
  */
14
16
  export class StatusBarTemplateDirective {
@@ -7,7 +7,7 @@
7
7
  */
8
8
  export class ColumnLockedChangeEvent {
9
9
  /**
10
- * The columns whose locked state is changed.
10
+ * The columns whose locked state changes.
11
11
  */
12
12
  columns;
13
13
  /**
@@ -16,8 +16,8 @@ import * as i1 from "../common/provider.service";
16
16
  * Represents the column-menu item for resizing all columns to the minimum possible width so that they fit the widest header or cell content without wrapping.
17
17
  * [See example](slug:columnmenu_grid#toc-autosize-all-columns-item).
18
18
  *
19
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
20
- * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
19
+ * Place this component inside a [`ColumnMenuTemplate`]({% slug api_grid_columnmenutemplatedirective %}) directive.
20
+ * To register it as a column menu item, set the [`ColumnMenuService`]({% slug api_grid_columnmenuservice %}) passed by
21
21
  * the template to the `service` input of the `kendo-grid-columnmenu-autosize-all-columns` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
22
22
  *
23
23
  * @example
@@ -29,6 +29,15 @@ import * as i1 from "../common/provider.service";
29
29
  * </ng-template>
30
30
  * </kendo-grid>
31
31
  * ```
32
+ * @example
33
+ * ```html
34
+ * <kendo-grid-column field="ProductName">
35
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
36
+ * <kendo-grid-columnmenu-autosize-all-columns [service]="service">
37
+ * </kendo-grid-columnmenu-autosize-all-columns>
38
+ * </ng-template>
39
+ * </kendo-grid-column>
40
+ * ```
32
41
  */
33
42
  export class ColumnMenuAutoSizeAllColumnsComponent extends ColumnMenuItemBase {
34
43
  ctx;
@@ -15,11 +15,10 @@ import * as i1 from "../common/provider.service";
15
15
  /**
16
16
  * Represents the column-menu item for resizing the specified column to the minimum possible width so that it fits the header or cell content without wrapping.
17
17
  * [See example](slug:columnmenu_grid#toc-autosize-column-item).
18
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
19
- * [See example](slug:columnmenu_grid#toc-customizing-the-content).
20
18
  *
21
- * You have to set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) and `column` that are passed by
22
- * the template to the `service` and `column` input of the `kendo-grid-columnmenu-autosize-column` component.
19
+ * Place this component inside a [`ColumnMenuTemplate`]({% slug api_grid_columnmenutemplatedirective %}) directive.
20
+ * Set the [`ColumnMenuService`]({% slug api_grid_columnmenuservice %}) and `column` passed by
21
+ * the template to the `service` and `column` inputs of the `kendo-grid-columnmenu-autosize-column` component.
23
22
  *
24
23
  * @example
25
24
  * ```html
@@ -30,11 +29,20 @@ import * as i1 from "../common/provider.service";
30
29
  * </ng-template>
31
30
  * </kendo-grid>
32
31
  * ```
32
+ * @example
33
+ * ```html
34
+ * <kendo-grid-column field="ProductName">
35
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
36
+ * <kendo-grid-columnmenu-autosize-column [column]="column" [service]="service">
37
+ * </kendo-grid-columnmenu-autosize-column>
38
+ * </ng-template>
39
+ * </kendo-grid-column>
40
+ * ```
33
41
  */
34
42
  export class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBase {
35
43
  ctx;
36
44
  /**
37
- * The Grid column instance which will be resized through the auto size column option.
45
+ * Specifies the Grid column instance to resize with the auto size column option.
38
46
  */
39
47
  column;
40
48
  maxWidthIcon = maxWidthIcon;
@@ -49,7 +57,7 @@ export class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBase {
49
57
  }
50
58
  }
51
59
  /**
52
- * Resizes a specified column to the minimum possible width so that it fits the widest header or cell content without wrapping.
60
+ * Resizes the specified column to the minimum possible width so that it fits the widest header or cell content without wrapping.
53
61
  */
54
62
  autoSizeColumn() {
55
63
  autoSizeColumn(this.ctx.grid, this.service, this.column);
@@ -16,9 +16,9 @@ import * as i2 from "../common/column-info.service";
16
16
  /**
17
17
  * Represents the column-menu item for selecting columns in the Grid. [See example](slug:columnmenu_grid#toc-column-chooser-item).
18
18
  *
19
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_grid_columnmenutemplatedirective %}) directive.
20
- * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_grid_columnmenuservice %}) that is passed by
21
- * the template to the service input of the `kendo-grid-columnmenu-chooser` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
19
+ * Place this component inside a [`ColumnMenuTemplate`]({% slug api_grid_columnmenutemplatedirective %}) directive.
20
+ * To register it as a column menu item, set the [`ColumnMenuService`]({% slug api_grid_columnmenuservice %}) passed by
21
+ * the template to the `service` input of the `kendo-grid-columnmenu-chooser` component. [See example](slug:columnmenu_grid#toc-customizing-the-content).
22
22
  *
23
23
  * @example
24
24
  * ```html
@@ -28,6 +28,14 @@ import * as i2 from "../common/column-info.service";
28
28
  * </ng-template>
29
29
  * </kendo-grid>
30
30
  * ```
31
+ * @example
32
+ * ```html
33
+ * <kendo-grid-column field="ProductName">
34
+ * <ng-template kendoGridColumnMenuTemplate let-service="service">
35
+ * <kendo-grid-columnmenu-chooser [service]="service"></kendo-grid-columnmenu-chooser>
36
+ * </ng-template>
37
+ * </kendo-grid-column>
38
+ * ```
31
39
  */
32
40
  export class ColumnMenuChooserComponent extends ColumnMenuItemBase {
33
41
  ctx;
@@ -35,11 +43,11 @@ export class ColumnMenuChooserComponent extends ColumnMenuItemBase {
35
43
  changeDetector;
36
44
  hostElement;
37
45
  /**
38
- * Fires when the content is expanded.
46
+ * Fires when the content expands.
39
47
  */
40
48
  expand = new EventEmitter();
41
49
  /**
42
- * Fires when the content is collapsed.
50
+ * Fires when the content collapses.
43
51
  */
44
52
  collapse = new EventEmitter();
45
53
  /**