@progress/kendo-angular-treelist 19.1.2-develop.4 → 19.1.2-develop.6

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 (244) hide show
  1. package/binding-directives/base-binding.directive.d.ts +6 -3
  2. package/binding-directives/flat-binding.directive.d.ts +7 -8
  3. package/binding-directives/hierarchy-binding.directive.d.ts +13 -6
  4. package/column-menu/column-chooser.component.d.ts +5 -8
  5. package/column-menu/column-locked-change-event.d.ts +4 -2
  6. package/column-menu/column-menu-autosize-all.component.d.ts +3 -5
  7. package/column-menu/column-menu-autosize.component.d.ts +5 -7
  8. package/column-menu/column-menu-chooser.component.d.ts +15 -6
  9. package/column-menu/column-menu-expandable-item.interface.d.ts +4 -3
  10. package/column-menu/column-menu-filter.component.d.ts +14 -4
  11. package/column-menu/column-menu-item-base.d.ts +1 -1
  12. package/column-menu/column-menu-item-content-template.directive.d.ts +3 -5
  13. package/column-menu/column-menu-item.component.d.ts +7 -10
  14. package/column-menu/column-menu-item.directive.d.ts +23 -1
  15. package/column-menu/column-menu-lock.component.d.ts +14 -4
  16. package/column-menu/column-menu-settings.interface.d.ts +5 -5
  17. package/column-menu/column-menu-sort.component.d.ts +12 -2
  18. package/column-menu/column-menu-template.directive.d.ts +3 -5
  19. package/column-menu/column-menu.component.d.ts +14 -2
  20. package/column-menu/column-menu.service.d.ts +1 -2
  21. package/column-menu/column-visibility-change-event.d.ts +2 -2
  22. package/column-resizing/column-resize.interface.d.ts +3 -2
  23. package/columns/checkbox-column.component.d.ts +16 -4
  24. package/columns/column-base.d.ts +15 -28
  25. package/columns/column-group.component.d.ts +1 -2
  26. package/columns/column.component.d.ts +22 -18
  27. package/columns/command-column.component.d.ts +3 -4
  28. package/columns/rowreorder-column.component.d.ts +9 -1
  29. package/columns/sort-settings.d.ts +5 -23
  30. package/columns/span-column.component.d.ts +11 -16
  31. package/common/cell-click-event-args.interface.d.ts +4 -3
  32. package/common/create-form-group.d.ts +2 -1
  33. package/common/pager-settings.d.ts +7 -8
  34. package/common/remove-confirmation.d.ts +1 -1
  35. package/common/single-popup.service.d.ts +7 -6
  36. package/data/change-event-args.interface.d.ts +6 -7
  37. package/data/data-item.interface.d.ts +5 -5
  38. package/data/data.collection.d.ts +4 -3
  39. package/data/treelist-item.interface.d.ts +2 -2
  40. package/directives.d.ts +10 -9
  41. package/dragdrop/column-reorder-config.d.ts +3 -2
  42. package/dragdrop/column-reorder-event.d.ts +4 -6
  43. package/editing/add-command-tool.directive.d.ts +9 -12
  44. package/editing/add-command.directive.d.ts +5 -9
  45. package/editing/add-event-args.interface.d.ts +3 -2
  46. package/editing/cancel-command.directive.d.ts +5 -8
  47. package/editing/cancel-event-args.interface.d.ts +1 -1
  48. package/editing/cell-close-event.d.ts +5 -5
  49. package/editing/edit-command.directive.d.ts +5 -9
  50. package/editing/edit-event-args.interface.d.ts +4 -3
  51. package/editing/edit-template.directive.d.ts +2 -4
  52. package/editing/remove-command.directive.d.ts +5 -8
  53. package/editing/remove-event-args.interface.d.ts +3 -2
  54. package/editing/save-command.directive.d.ts +5 -8
  55. package/editing/save-event-args.interface.d.ts +4 -3
  56. package/editing-directives/create-form-group-args.interface.d.ts +1 -1
  57. package/editing-directives/edit-service.interface.d.ts +13 -5
  58. package/editing-directives/editing-directive-base.d.ts +3 -3
  59. package/editing-directives/in-cell-editing.directive.d.ts +12 -2
  60. package/editing-directives/reactive-editing.directive.d.ts +12 -2
  61. package/editing-directives/template-editing.directive.d.ts +13 -3
  62. package/esm2022/binding-directives/base-binding.directive.mjs +6 -3
  63. package/esm2022/binding-directives/flat-binding.directive.mjs +7 -8
  64. package/esm2022/binding-directives/hierarchy-binding.directive.mjs +13 -6
  65. package/esm2022/column-menu/column-chooser.component.mjs +5 -8
  66. package/esm2022/column-menu/column-locked-change-event.mjs +4 -2
  67. package/esm2022/column-menu/column-menu-autosize-all.component.mjs +3 -5
  68. package/esm2022/column-menu/column-menu-autosize.component.mjs +5 -7
  69. package/esm2022/column-menu/column-menu-chooser.component.mjs +15 -6
  70. package/esm2022/column-menu/column-menu-filter.component.mjs +14 -4
  71. package/esm2022/column-menu/column-menu-item-base.mjs +1 -1
  72. package/esm2022/column-menu/column-menu-item-content-template.directive.mjs +3 -5
  73. package/esm2022/column-menu/column-menu-item.component.mjs +7 -10
  74. package/esm2022/column-menu/column-menu-item.directive.mjs +23 -1
  75. package/esm2022/column-menu/column-menu-lock.component.mjs +14 -4
  76. package/esm2022/column-menu/column-menu-sort.component.mjs +12 -2
  77. package/esm2022/column-menu/column-menu-template.directive.mjs +3 -5
  78. package/esm2022/column-menu/column-menu.component.mjs +14 -2
  79. package/esm2022/column-menu/column-menu.service.mjs +1 -2
  80. package/esm2022/column-menu/column-visibility-change-event.mjs +2 -2
  81. package/esm2022/columns/checkbox-column.component.mjs +16 -4
  82. package/esm2022/columns/column-base.mjs +15 -28
  83. package/esm2022/columns/column-group.component.mjs +1 -2
  84. package/esm2022/columns/column.component.mjs +22 -18
  85. package/esm2022/columns/command-column.component.mjs +3 -4
  86. package/esm2022/columns/rowreorder-column.component.mjs +9 -1
  87. package/esm2022/columns/span-column.component.mjs +11 -16
  88. package/esm2022/common/single-popup.service.mjs +7 -6
  89. package/esm2022/directives.mjs +10 -9
  90. package/esm2022/dragdrop/column-reorder-event.mjs +4 -6
  91. package/esm2022/editing/add-command-tool.directive.mjs +9 -12
  92. package/esm2022/editing/add-command.directive.mjs +5 -9
  93. package/esm2022/editing/cancel-command.directive.mjs +5 -8
  94. package/esm2022/editing/cell-close-event.mjs +5 -5
  95. package/esm2022/editing/edit-command.directive.mjs +5 -9
  96. package/esm2022/editing/edit-template.directive.mjs +2 -4
  97. package/esm2022/editing/remove-command.directive.mjs +5 -8
  98. package/esm2022/editing/save-command.directive.mjs +5 -8
  99. package/esm2022/editing-directives/editing-directive-base.mjs +3 -3
  100. package/esm2022/editing-directives/in-cell-editing.directive.mjs +12 -2
  101. package/esm2022/editing-directives/reactive-editing.directive.mjs +12 -2
  102. package/esm2022/editing-directives/template-editing.directive.mjs +13 -3
  103. package/esm2022/excel/excel-command-tool.directive.mjs +9 -11
  104. package/esm2022/excel/excel-command.directive.mjs +3 -7
  105. package/esm2022/excel/excel.component.mjs +22 -16
  106. package/esm2022/excel/excel.module.mjs +2 -2
  107. package/esm2022/expand-state/expand-event.mjs +3 -3
  108. package/esm2022/expand-state/expandable.directive.mjs +8 -5
  109. package/esm2022/filtering/base-filter-cell.component.mjs +3 -1
  110. package/esm2022/filtering/cell/boolean-filter-cell.component.mjs +1 -0
  111. package/esm2022/filtering/cell/date-filter-cell.component.mjs +5 -3
  112. package/esm2022/filtering/cell/filter-cell-operators.component.mjs +2 -1
  113. package/esm2022/filtering/cell/filter-cell-template.directive.mjs +18 -3
  114. package/esm2022/filtering/cell/numeric-filter-cell.component.mjs +7 -5
  115. package/esm2022/filtering/cell/string-filter-cell.component.mjs +7 -7
  116. package/esm2022/filtering/date-filter.component.mjs +8 -3
  117. package/esm2022/filtering/filter.service.mjs +2 -4
  118. package/esm2022/filtering/menu/boolean-filter-menu.component.mjs +3 -3
  119. package/esm2022/filtering/menu/date-filter-menu.component.mjs +6 -3
  120. package/esm2022/filtering/menu/filter-menu-template.directive.mjs +18 -2
  121. package/esm2022/filtering/menu/numeric-filter-menu.component.mjs +9 -5
  122. package/esm2022/filtering/menu/string-filter-menu.component.mjs +6 -4
  123. package/esm2022/filtering/numeric-filter.component.mjs +3 -3
  124. package/esm2022/filtering/operators/after-eq-filter-operator.component.mjs +27 -1
  125. package/esm2022/filtering/operators/after-filter-operator.component.mjs +27 -1
  126. package/esm2022/filtering/operators/before-eq-filter-operator.component.mjs +27 -1
  127. package/esm2022/filtering/operators/before-filter-operator.component.mjs +27 -1
  128. package/esm2022/filtering/operators/contains-filter-operator.component.mjs +28 -1
  129. package/esm2022/filtering/operators/ends-with-filter-operator.component.mjs +28 -1
  130. package/esm2022/filtering/operators/eq-filter-operator.component.mjs +76 -1
  131. package/esm2022/filtering/operators/filter-operator.base.mjs +1 -1
  132. package/esm2022/filtering/operators/gt-filter-operator.component.mjs +28 -2
  133. package/esm2022/filtering/operators/gte-filter-operator.component.mjs +27 -1
  134. package/esm2022/filtering/operators/is-empty-filter-operator.component.mjs +28 -1
  135. package/esm2022/filtering/operators/is-not-empty-filter-operator.component.mjs +28 -1
  136. package/esm2022/filtering/operators/is-not-null-filter-operator.component.mjs +76 -1
  137. package/esm2022/filtering/operators/isnull-filter-operator.component.mjs +76 -1
  138. package/esm2022/filtering/operators/lt-filter-operator.component.mjs +27 -1
  139. package/esm2022/filtering/operators/lte-filter-operator.component.mjs +28 -2
  140. package/esm2022/filtering/operators/neq-filter-operator.component.mjs +76 -1
  141. package/esm2022/filtering/operators/not-contains-filter-operator.component.mjs +28 -1
  142. package/esm2022/filtering/operators/starts-with-filter-operator.component.mjs +28 -1
  143. package/esm2022/filtering/string-filter.component.mjs +1 -1
  144. package/esm2022/localization/custom-messages.component.mjs +11 -2
  145. package/esm2022/navigation/focusable.directive.mjs +4 -4
  146. package/esm2022/package-metadata.mjs +2 -2
  147. package/esm2022/pdf/pdf-command-tool.directive.mjs +11 -9
  148. package/esm2022/pdf/pdf-command.directive.mjs +2 -2
  149. package/esm2022/pdf/pdf-export-event.mjs +3 -1
  150. package/esm2022/pdf/pdf-margin.component.mjs +10 -5
  151. package/esm2022/pdf/pdf-template.directive.mjs +2 -2
  152. package/esm2022/pdf/pdf.component.mjs +12 -2
  153. package/esm2022/pdf/pdf.module.mjs +6 -6
  154. package/esm2022/rendering/cell-template.directive.mjs +8 -9
  155. package/esm2022/rendering/common/spacer.component.mjs +16 -5
  156. package/esm2022/rendering/footer-template.directive.mjs +10 -12
  157. package/esm2022/rendering/header/header-template.directive.mjs +4 -4
  158. package/esm2022/rendering/no-records-template.directive.mjs +2 -2
  159. package/esm2022/rendering/toolbar/toolbar-focusable.directive.mjs +13 -2
  160. package/esm2022/rendering/toolbar/toolbar-template.directive.mjs +4 -6
  161. package/esm2022/selection/selectable.directive.mjs +12 -0
  162. package/esm2022/selection/selection-change-event.mjs +1 -1
  163. package/esm2022/treelist.component.mjs +145 -109
  164. package/esm2022/treelist.module.mjs +6 -8
  165. package/esm2022/utils.mjs +1 -1
  166. package/excel/excel-command-tool.directive.d.ts +9 -11
  167. package/excel/excel-command.directive.d.ts +3 -7
  168. package/excel/excel-export-data.interface.d.ts +4 -4
  169. package/excel/excel.component.d.ts +22 -16
  170. package/excel/excel.module.d.ts +2 -2
  171. package/expand-state/expand-event.d.ts +3 -3
  172. package/expand-state/expandable-tree-component.d.ts +4 -6
  173. package/expand-state/expandable.directive.d.ts +8 -5
  174. package/fesm2022/progress-kendo-angular-treelist.mjs +1470 -574
  175. package/filtering/base-filter-cell.component.d.ts +3 -1
  176. package/filtering/cell/boolean-filter-cell.component.d.ts +1 -0
  177. package/filtering/cell/date-filter-cell.component.d.ts +5 -3
  178. package/filtering/cell/filter-cell-operators.component.d.ts +2 -1
  179. package/filtering/cell/filter-cell-template.directive.d.ts +18 -3
  180. package/filtering/cell/numeric-filter-cell.component.d.ts +7 -5
  181. package/filtering/cell/string-filter-cell.component.d.ts +7 -7
  182. package/filtering/date-filter.component.d.ts +8 -3
  183. package/filtering/filter.service.d.ts +2 -4
  184. package/filtering/filterable.d.ts +3 -2
  185. package/filtering/menu/boolean-filter-menu.component.d.ts +3 -3
  186. package/filtering/menu/date-filter-menu.component.d.ts +6 -3
  187. package/filtering/menu/filter-menu-template.directive.d.ts +18 -2
  188. package/filtering/menu/numeric-filter-menu.component.d.ts +9 -5
  189. package/filtering/menu/string-filter-menu.component.d.ts +6 -4
  190. package/filtering/numeric-filter.component.d.ts +3 -3
  191. package/filtering/operators/after-eq-filter-operator.component.d.ts +27 -1
  192. package/filtering/operators/after-filter-operator.component.d.ts +27 -1
  193. package/filtering/operators/before-eq-filter-operator.component.d.ts +27 -1
  194. package/filtering/operators/before-filter-operator.component.d.ts +27 -1
  195. package/filtering/operators/contains-filter-operator.component.d.ts +28 -1
  196. package/filtering/operators/ends-with-filter-operator.component.d.ts +28 -1
  197. package/filtering/operators/eq-filter-operator.component.d.ts +76 -1
  198. package/filtering/operators/filter-operator.base.d.ts +1 -1
  199. package/filtering/operators/gt-filter-operator.component.d.ts +30 -0
  200. package/filtering/operators/gte-filter-operator.component.d.ts +27 -1
  201. package/filtering/operators/is-empty-filter-operator.component.d.ts +28 -1
  202. package/filtering/operators/is-not-empty-filter-operator.component.d.ts +28 -1
  203. package/filtering/operators/is-not-null-filter-operator.component.d.ts +76 -1
  204. package/filtering/operators/isnull-filter-operator.component.d.ts +76 -1
  205. package/filtering/operators/lt-filter-operator.component.d.ts +27 -1
  206. package/filtering/operators/lte-filter-operator.component.d.ts +30 -0
  207. package/filtering/operators/neq-filter-operator.component.d.ts +76 -1
  208. package/filtering/operators/not-contains-filter-operator.component.d.ts +28 -1
  209. package/filtering/operators/starts-with-filter-operator.component.d.ts +28 -1
  210. package/filtering/string-filter.component.d.ts +1 -1
  211. package/localization/custom-messages.component.d.ts +11 -2
  212. package/navigation/focusable-element.interface.d.ts +7 -11
  213. package/navigation/focusable.directive.d.ts +4 -4
  214. package/navigation/navigation-cell.interface.d.ts +5 -5
  215. package/navigation/navigation-row.interface.d.ts +4 -5
  216. package/package.json +18 -18
  217. package/pdf/pdf-command-tool.directive.d.ts +11 -9
  218. package/pdf/pdf-command.directive.d.ts +2 -2
  219. package/pdf/pdf-export-event.d.ts +3 -1
  220. package/pdf/pdf-margin.component.d.ts +10 -5
  221. package/pdf/pdf-margin.interface.d.ts +1 -1
  222. package/pdf/pdf-template.directive.d.ts +2 -2
  223. package/pdf/pdf.component.d.ts +12 -2
  224. package/pdf/pdf.module.d.ts +6 -6
  225. package/rendering/cell-template.directive.d.ts +8 -9
  226. package/rendering/common/row-class.d.ts +4 -7
  227. package/rendering/common/spacer.component.d.ts +16 -5
  228. package/rendering/footer-template.directive.d.ts +10 -12
  229. package/rendering/header/header-template.directive.d.ts +4 -4
  230. package/rendering/no-records-template.directive.d.ts +2 -2
  231. package/rendering/toolbar/toolbar-focusable.directive.d.ts +13 -2
  232. package/rendering/toolbar/toolbar-template.directive.d.ts +4 -6
  233. package/row-reordering/types.d.ts +4 -1
  234. package/schematics/ngAdd/index.js +3 -3
  235. package/scrolling/content-scroll-event.d.ts +2 -0
  236. package/scrolling/scroll-bottom-event.d.ts +2 -0
  237. package/scrolling/scroll-request.service.d.ts +3 -3
  238. package/scrolling/scrollmode.d.ts +3 -3
  239. package/selection/is-selected.d.ts +5 -4
  240. package/selection/selectable-settings.d.ts +6 -6
  241. package/selection/selectable.directive.d.ts +12 -0
  242. package/selection/selection-change-event.d.ts +2 -2
  243. package/treelist.component.d.ts +143 -107
  244. package/treelist.module.d.ts +6 -8
@@ -6,8 +6,19 @@ import { ElementRef } from '@angular/core';
6
6
  import { ContextService } from '../../common/provider.service';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * A directive applied to all toolbar elements that need to be a part of the TreeList
10
- * keyboard navigation.
9
+ * A directive for toolbar elements that need to be part of TreeList keyboard navigation.
10
+ * Use this directive to make toolbar elements focusable and accessible with the keyboard.
11
+ *
12
+ * @example
13
+ * ```html
14
+ * <kendo-treelist>
15
+ * <kendo-toolbar>
16
+ * <button kendoTreeListToolbarFocusable>Custom Button</button>
17
+ * <button kendoTreeListCancelCommand>Cancel</button>
18
+ * <button kendoTreeListEditCommand>Edit</button>
19
+ * </kendo-toolbar>
20
+ * </kendo-treelist>
21
+ * ```
11
22
  */
12
23
  export declare class TreeListToolbarFocusableDirective {
13
24
  private host;
@@ -9,15 +9,13 @@ import * as i0 from "@angular/core";
9
9
  * Represents the toolbar template of the TreeList ([see example](slug:toolbartemplate_treelist)).
10
10
  *
11
11
  * The template context has the following field:
12
- * - `position`&mdash;The position at which the toolbar template is rendered. The possible values are `top`, `bottom` and `both`.
12
+ * - `position`&mdash;The position at which the toolbar template is rendered. The possible values are `top`, `bottom`, and `both`.
13
13
  *
14
14
  * @example
15
15
  * ```html
16
16
  * <kendo-treelist ...>
17
17
  * <ng-template kendoTreeListToolbarTemplate>
18
- * <button kendoTreeListExcelCommand >
19
- * Export to Excel
20
- * </button>
18
+ * <button kendoTreeListExcelCommand>Export to Excel</button>
21
19
  * </ng-template>
22
20
  * </kendo-treelist>
23
21
  * ```
@@ -27,8 +25,8 @@ export declare class ToolbarTemplateDirective {
27
25
  private optionChanges;
28
26
  _position: 'top' | 'bottom' | 'both';
29
27
  /**
30
- * The position of the toolbar ([see example](slug:toolbartemplate_treelist#toc-setting-the-toolbar-position)).
31
- * The group panel or header and the second one below the pager.
28
+ * Sets the position of the toolbar. The value can be `top`, `bottom`, or `both`.
29
+ * Controls whether the toolbar appears above, below, or on both sides of the TreeList. [See example.](slug:toolbartemplate_treelist#toc-setting-the-toolbar-position)
32
30
  * @default 'top'
33
31
  */
34
32
  set position(position: 'top' | 'bottom' | 'both');
@@ -3,7 +3,7 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * The arguments for the `rowReorder` event
6
+ * The arguments for the `rowReorder` event.
7
7
  */
8
8
  export interface RowReorderEvent {
9
9
  /**
@@ -36,4 +36,7 @@ export interface DragRow {
36
36
  */
37
37
  element: HTMLElement;
38
38
  }
39
+ /**
40
+ * Specifies the drop position for row reordering.
41
+ */
39
42
  export type DropPosition = 'before' | 'after' | 'over' | 'forbidden';
@@ -4,13 +4,13 @@ const schematics_1 = require("@angular-devkit/schematics");
4
4
  function default_1(options) {
5
5
  const finalOptions = Object.assign(Object.assign({}, options), { mainNgModule: 'TreeListModule', package: 'treelist', peerDependencies: {
6
6
  // peer dep of the dropdowns
7
- '@progress/kendo-angular-treeview': '19.1.2-develop.4',
7
+ '@progress/kendo-angular-treeview': '19.1.2-develop.6',
8
8
  // peer dependency of kendo-angular-inputs
9
- '@progress/kendo-angular-dialog': '19.1.2-develop.4',
9
+ '@progress/kendo-angular-dialog': '19.1.2-develop.6',
10
10
  // peer dependency of kendo-angular-icons
11
11
  '@progress/kendo-svg-icons': '^4.0.0',
12
12
  // peer dependency of kendo-angular-dateinputs
13
- '@progress/kendo-angular-navigation': '19.1.2-develop.4',
13
+ '@progress/kendo-angular-navigation': '19.1.2-develop.6',
14
14
  } });
15
15
  return (0, schematics_1.externalSchematic)('@progress/kendo-angular-schematics', 'ng-add', finalOptions);
16
16
  }
@@ -4,6 +4,8 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
6
  * Arguments for the [`contentScroll`](slug:api_treelist_treelistcomponent#toc-contentscroll) event.
7
+ *
8
+ * Use this event to get information about the scroll position and visible rows or columns in the TreeList.
7
9
  */
8
10
  export interface ContentScrollEvent {
9
11
  /**
@@ -5,6 +5,8 @@
5
5
  import { TreeListComponent } from "../treelist.component";
6
6
  /**
7
7
  * Arguments for the [`scrollBottom`](slug:api_treelist_treelistcomponent#toc-scrollbottom) event. [See example](slug:scrollmmodes_grid#toc-endless-scrolling).
8
+ *
9
+ * Use this event to get the TreeListComponent instance when the user scrolls to the bottom.
8
10
  */
9
11
  export interface ScrollBottomEvent {
10
12
  /**
@@ -5,15 +5,15 @@
5
5
  import { Subject } from 'rxjs';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Arguments for the scrollTo method. Specifies to which row / column should the treelist scroll to.
8
+ * Arguments for the scrollTo method. Specifies the row or column to which the TreeList should scroll.
9
9
  */
10
10
  export interface ScrollRequest {
11
11
  /**
12
- * The row index to which the TreeList should scroll to, considering 0 as first row.
12
+ * The row index to which the TreeList should scroll, considering 0 as the first row.
13
13
  */
14
14
  row?: number;
15
15
  /**
16
- * The column index to which the TreeList should scroll to, considering 0 as first column.
16
+ * The column index to which the TreeList should scroll, considering 0 as the first column.
17
17
  */
18
18
  column?: number;
19
19
  }
@@ -6,9 +6,9 @@
6
6
  * The scroll mode of the TreeList.
7
7
  *
8
8
  * The available values are:
9
- * * `none`&mdash;Scrollbars are hidden. The TreeList cannot be scrolled.
10
- * * `scrollable`&mdash;Displays scrollbars in TreeList.
11
- * * `virtual`&mdash;Enables the [virtual scroll mode](slug:virtualscrolling_treelist) of the TreeList.
9
+ * - `none`&mdash;Scrollbars are hidden. The TreeList cannot be scrolled.
10
+ * - `scrollable`&mdash;Displays scrollbars in TreeList.
11
+ * - `virtual`&mdash;Enables the [virtual scroll mode](slug:virtualscrolling_treelist) of the TreeList.
12
12
  *
13
13
  * @example
14
14
  * ```html
@@ -4,11 +4,12 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { ColumnBase } from '../columns/column-base';
6
6
  /**
7
- * Represents the callback that is used by the
8
- * [`isSelected`]({% slug api_treelist_treelistcomponent %}#toc-isSelected) property.
7
+ * Represents the callback used by the [`isSelected`]({% slug api_treelist_treelistcomponent %}#toc-isSelected) property.
8
+ * Use this function to determine if a data item is selected.
9
9
  *
10
- * ```ts-no-run
11
- * isSelected(dataItem: any, column?: ColumnBase, columnIndex?: number) {
10
+ * @example
11
+ * ```ts
12
+ * public isSelected(dataItem: any, column?: ColumnBase, columnIndex?: number): boolean {
12
13
  * return dataItem.selected;
13
14
  * }
14
15
  * ```
@@ -3,7 +3,7 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * The settings for the selection functionality of the TreeList.[See example](slug:selection_treelist#toc-setup).
6
+ * The settings for the selection functionality of the TreeList. [See example](slug:selection_treelist#toc-setup).
7
7
  */
8
8
  export interface SelectableSettings {
9
9
  /**
@@ -22,15 +22,15 @@ export interface SelectableSettings {
22
22
  };
23
23
  /**
24
24
  * Specifies if the selection functionality is enabled.
25
- * Setting this option to `false` will stop all selection-related functionality.
26
- * The end user will not be able to select and deselect rows or cells.
27
- * Items in the [selectedItems]({% slug api_treelist_selectabledirective %}#toc-selecteditems) collection will not be rendered as selected.
28
- * The [isSelected]({% slug api_treelist_treelistcomponent %}#toc-isselected) callback will be ignored.
25
+ * Setting this option to `false` stops all selection-related functionality.
26
+ * The end user cannot select or deselect rows or cells.
27
+ * Items in the [selectedItems]({% slug api_treelist_selectabledirective %}#toc-selecteditems) collection are not rendered as selected.
28
+ * The [isSelected]({% slug api_treelist_treelistcomponent %}#toc-isselected) callback is ignored.
29
29
  */
30
30
  enabled?: boolean;
31
31
  /**
32
32
  * Determines if the selection is performed only through clicking a checkbox.
33
- * If enabled, clicking the row itself will not select the row.
33
+ * If enabled, clicking the row itself does not select the row.
34
34
  * Applicable if at least one checkbox column is present.
35
35
  */
36
36
  checkboxOnly?: boolean;
@@ -21,6 +21,18 @@ export interface SelectionItem {
21
21
  }
22
22
  /**
23
23
  * A directive which controls the selection state. [See example](slug:selection_treelist).
24
+ *
25
+ * @example
26
+ * ```html
27
+ * <kendo-treelist
28
+ * [kendoTreeListSelectable]="{ mode: 'row' }"
29
+ * [selectedItems]="selectedItems">
30
+ * <kendo-treelist-column field="name" title="Name"></kendo-treelist-column>
31
+ * <kendo-treelist-column field="age" title="Age"></kendo-treelist-column>
32
+ * </kendo-treelist>
33
+ * ```
34
+ * @remarks
35
+ * Applied to: {@link TreeListComponent}.
24
36
  */
25
37
  export declare class SelectableDirective implements OnDestroy {
26
38
  private treelist;
@@ -9,7 +9,7 @@ import { ColumnBase } from '../columns/column-base';
9
9
  */
10
10
  export interface SelectionChangeItem {
11
11
  /**
12
- * The changed selection dataItem
12
+ * The changed selection dataItem.
13
13
  */
14
14
  dataItem: any;
15
15
  /**
@@ -26,7 +26,7 @@ export interface SelectionChangeItem {
26
26
  */
27
27
  export declare class SelectionChangeEvent {
28
28
  /**
29
- * Specifies how was the selection changed
29
+ * Specifies how the selection was changed.
30
30
  */
31
31
  action: 'select' | 'add' | 'remove';
32
32
  /**