@progress/kendo-angular-treelist 12.0.1-develop.3 → 12.0.1-develop.4

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 (53) hide show
  1. package/binding-directives/flat-binding.directive.d.ts +1 -1
  2. package/binding-directives/hierarchy-binding.directive.d.ts +1 -1
  3. package/column-menu/column-menu-item-content-template.directive.d.ts +14 -6
  4. package/column-menu/column-menu-template.directive.d.ts +15 -6
  5. package/editing/add-command.directive.d.ts +4 -13
  6. package/editing/cancel-command.directive.d.ts +4 -17
  7. package/editing/edit-command.directive.d.ts +5 -5
  8. package/editing/edit-template.directive.d.ts +1 -2
  9. package/editing/remove-command.directive.d.ts +3 -3
  10. package/editing/save-command.directive.d.ts +3 -16
  11. package/editing-directives/in-cell-editing.directive.d.ts +1 -1
  12. package/editing-directives/template-editing.directive.d.ts +1 -1
  13. package/esm2020/binding-directives/flat-binding.directive.mjs +1 -1
  14. package/esm2020/binding-directives/hierarchy-binding.directive.mjs +1 -1
  15. package/esm2020/column-menu/column-menu-item-content-template.directive.mjs +14 -6
  16. package/esm2020/column-menu/column-menu-template.directive.mjs +15 -6
  17. package/esm2020/editing/add-command.directive.mjs +4 -13
  18. package/esm2020/editing/cancel-command.directive.mjs +4 -17
  19. package/esm2020/editing/edit-command.directive.mjs +5 -5
  20. package/esm2020/editing/edit-template.directive.mjs +1 -2
  21. package/esm2020/editing/remove-command.directive.mjs +3 -3
  22. package/esm2020/editing/save-command.directive.mjs +3 -16
  23. package/esm2020/editing-directives/in-cell-editing.directive.mjs +1 -1
  24. package/esm2020/editing-directives/template-editing.directive.mjs +1 -1
  25. package/esm2020/excel/excel-command.directive.mjs +6 -7
  26. package/esm2020/expand-state/expandable.directive.mjs +9 -1
  27. package/esm2020/navigation/focusable.directive.mjs +2 -2
  28. package/esm2020/package-metadata.mjs +2 -2
  29. package/esm2020/pager/pager-template.directive.mjs +15 -7
  30. package/esm2020/pdf/pdf-command.directive.mjs +6 -7
  31. package/esm2020/pdf/pdf-template.directive.mjs +13 -6
  32. package/esm2020/rendering/cell-template.directive.mjs +10 -6
  33. package/esm2020/rendering/footer-template.directive.mjs +9 -8
  34. package/esm2020/rendering/header/header-template.directive.mjs +10 -6
  35. package/esm2020/rendering/no-records-template.directive.mjs +10 -7
  36. package/esm2020/rendering/toolbar/toolbar-template.directive.mjs +12 -13
  37. package/esm2020/selection/selectable.directive.mjs +1 -1
  38. package/excel/excel-command.directive.d.ts +6 -7
  39. package/expand-state/expandable.directive.d.ts +9 -1
  40. package/fesm2015/progress-kendo-angular-treelist.mjs +158 -145
  41. package/fesm2020/progress-kendo-angular-treelist.mjs +158 -145
  42. package/navigation/focusable.directive.d.ts +2 -2
  43. package/package.json +15 -15
  44. package/pager/pager-template.directive.d.ts +15 -7
  45. package/pdf/pdf-command.directive.d.ts +6 -7
  46. package/pdf/pdf-template.directive.d.ts +13 -6
  47. package/rendering/cell-template.directive.d.ts +10 -6
  48. package/rendering/footer-template.directive.d.ts +9 -8
  49. package/rendering/header/header-template.directive.d.ts +10 -6
  50. package/rendering/no-records-template.directive.d.ts +10 -7
  51. package/rendering/toolbar/toolbar-template.directive.d.ts +12 -13
  52. package/schematics/ngAdd/index.js +3 -3
  53. package/selection/selectable.directive.d.ts +1 -1
@@ -46,8 +46,8 @@ const packageMetadata = {
46
46
  name: '@progress/kendo-angular-treelist',
47
47
  productName: 'Kendo UI for Angular',
48
48
  productCodes: ['KENDOUIANGULAR', 'KENDOUICOMPLETE'],
49
- publishDate: 1683100454,
50
- version: '12.0.1-develop.3',
49
+ publishDate: 1683180347,
50
+ version: '12.0.1-develop.4',
51
51
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
52
52
  };
53
53
 
@@ -67,12 +67,16 @@ const packageMetadata = {
67
67
  * - `loading`—Specifies if the item children are currently loading.
68
68
  * - `rowIndex`—The current row index. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
69
69
  *
70
- * {% meta height:470 %}
71
- * {% embed_file data-binding/hierarchy/app.component.ts preview %}
72
- * {% embed_file data-binding/hierarchy/app.module.ts %}
73
- * {% embed_file shared/main.ts %}
74
- * {% embed_file shared/filesystem.ts %}
75
- * {% endmeta %}
70
+ * * @example
71
+ * ```html
72
+ * <kendo-treelist ...>
73
+ * <kendo-treelist-column field="ProductName">
74
+ * <ng-template kendoTreeListCellTemplate let-dataItem let-rowIndex="rowIndex" let-column="column">
75
+ * Data Row: {{rowIndex}}
76
+ * </ng-template>
77
+ * </kendo-treelist-column>
78
+ * </kendo-treelist>
79
+ *```
76
80
  */
77
81
  class CellTemplateDirective {
78
82
  constructor(templateRef) {
@@ -99,8 +103,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
99
103
  * - `column`&mdash;The current column instance.
100
104
  * - `dataItem`&mdash;The current data item.
101
105
  * - `cellContext`&mdash;An object used to pass context information to built-in directives.
102
- * - `formGroup`&mdash;The current [`FormGroup`](link:site.data.urls.angular['formgroupapi']).
103
- * If you use the TreeList inside [Template-Driven Forms](link:site.data.urls.angular['forms']), it will be `undefined`.
106
+ * - `formGroup`&mdash;The current [`FormGroup`](link:site.data.urls.angular['formgroupapi']). If you use the TreeList inside [Template-Driven Forms](link:site.data.urls.angular['forms']), `formGroup` will be `undefined`.
104
107
  * - `isNew`&mdash;The state of the current item.
105
108
  * - `rowIndex`&mdash;The current row index. If inside a new item row, `rowIndex` is `-1`.
106
109
  */
@@ -130,12 +133,21 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
130
133
  * - `service`&mdash;Represents the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}).
131
134
  * - `column`&mdash;Represents the TreeList column.
132
135
  *
133
- * {% meta height:500 %}
134
- * {% embed_file column-menu/template/app.component.ts preview %}
135
- * {% embed_file column-menu/template/app.module.ts %}
136
- * {% embed_file shared/main.ts %}
137
- * {% embed_file shared/employees.ts %}
138
- * {% endmeta %}
136
+ * @example
137
+ * ```html
138
+ * <kendo-treelist ... >
139
+ * <ng-template kendoTreeListColumnMenuTemplate let-service="service">
140
+ * <kendo-treelist-columnmenu-sort [service]="service">
141
+ * </kendo-treelist-columnmenu-sort>
142
+ * </ng-template>
143
+ * <kendo-treelist-column field="name">
144
+ * <ng-template kendoTreeListColumnMenuTemplate let-service="service">
145
+ * <kendo-treelist-columnmenu-sort [service]="service">
146
+ * </kendo-treelist-columnmenu-sort>
147
+ * </ng-template>
148
+ * </kendo-treelist-column>
149
+ * </kendo-treelist>
150
+ * ```
139
151
  */
140
152
  class ColumnMenuTemplateDirective {
141
153
  constructor(templateRef) {
@@ -179,7 +191,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
179
191
  * ([more information and example]({% slug templates_columns_treelist %}#toc-footer-template)).
180
192
  * Helps to customize the table footer cell for the column.
181
193
  * To define a footer template, nest an `<ng-template>` tag with the
182
- * [`kendoTreeListFooterTemplate`]({% slug api_treelist_footertemplatedirective %}) directive inside the `<kendo-treelist-column>` tag.
194
+ * `kendoTreeListFooterTemplate` directive inside the `<kendo-treelist-column>` tag.
183
195
  *
184
196
  * The template context is set to the aggregate values and the following additional fields are passed:
185
197
  * * `aggregates`&mdash;The aggregates for the level items.
@@ -189,13 +201,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
189
201
  * * `items`&mdash;The data items on this level.
190
202
  * * `parentItem`&mdash;The parent data item; `null` for root level items.
191
203
  *
192
- *
193
- * {% meta height:500 %}
194
- * {% embed_file configuration/footer-template/app.component.ts preview %}
195
- * {% embed_file configuration/footer-template/app.module.ts %}
196
- * {% embed_file shared/main.ts %}
197
- * {% embed_file shared/employees.ts %}
198
- * {% endmeta %}
204
+ * @example
205
+ * ```html
206
+ * <kendo-treelist-column field="name">
207
+ * <ng-template kendoTreeListFooterTemplate let-aggregates="aggregates">
208
+ * {{ aggregates.name.count }}
209
+ * </ng-template>
210
+ * </kendo-treelist-column>
211
+ * ```
199
212
  */
200
213
  class FooterTemplateDirective {
201
214
  constructor(templateRef) {
@@ -224,12 +237,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
224
237
  * * `column`&mdash;Defines an instance of the [`ColumnComponent`]({% slug api_treelist_columncomponent %}) option.
225
238
  * * `columnIndex`&mdash;Defines the current column index.
226
239
  *
227
- * {% meta height:533 %}
228
- * {% embed_file configuration/header-template/app.component.ts preview %}
229
- * {% embed_file configuration/header-template/app.module.ts %}
230
- * {% embed_file shared/main.ts %}
231
- * {% embed_file shared/employees.ts %}
232
- * {% endmeta %}
240
+ * @example
241
+ * ```html
242
+ * <kendo-treelist-column field="name">
243
+ * <ng-template
244
+ * kendoTreeListHeaderTemplate
245
+ * let-column>
246
+ * {{ column.field }}
247
+ * </ng-template>
248
+ * </kendo-treelist-column>
249
+ * ```
233
250
  */
234
251
  class HeaderTemplateDirective {
235
252
  constructor(templateRef) {
@@ -2017,14 +2034,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
2017
2034
  * appearance of the item that is displayed when no data is present. To define the no-records template,
2018
2035
  * nest an `<ng-template>` tag with the `kendoTreeListNoRecordsTemplate` directive inside `<kendo-treelist>`.
2019
2036
  *
2020
- * > When the locked columns of the TreeList are in use, the template is displayed in the non-locked part of the content.
2037
+ * When the locked columns of the TreeList are in use, the template is displayed in the non-locked part of the content.
2021
2038
  *
2022
- * {% meta height:533 %}
2023
- * {% embed_file configuration/no-records-template/app.component.ts preview %}
2024
- * {% embed_file configuration/no-records-template/app.module.ts %}
2025
- * {% embed_file shared/main.ts %}
2026
- * {% embed_file shared/employees.ts %}
2027
- * {% endmeta %}
2039
+ * @example
2040
+ * ```html
2041
+ * <kendo-treelist ... >
2042
+ * <kendo-treelist-column field="name" ></kendo-treelist-column>
2043
+ * <ng-template kendoTreeListNoRecordsTemplate>
2044
+ * No data loaded.
2045
+ * </ng-template>
2046
+ * </kendo-treelist>
2047
+ * ```
2028
2048
  */
2029
2049
  class NoRecordsTemplateDirective {
2030
2050
  constructor(templateRef) {
@@ -2113,7 +2133,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
2113
2133
 
2114
2134
  /**
2115
2135
  * Represents the pager template which helps to customize the pager appearance in the TreeList. To define a pager
2116
- * template, nest an `<ng-template>` tag with the `kendoTreeListPagerTemplate` directive inside `<kendo-treelist>`.
2136
+ * template, nest an `<ng-template>` tag with the `kendoTreeListPagerTemplate` directive inside `<kendo-treelist>`. [See example](slug:paging_treelist#toc-pager-template).
2117
2137
  *
2118
2138
  * The template context provides the following fields:
2119
2139
  * * `currentPage`&mdash;The index of the displayed page.
@@ -2122,12 +2142,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
2122
2142
  * * `total`&mdash;The total number of records.
2123
2143
  * * `totalPages`&mdash;The total number of available pages.
2124
2144
  *
2125
- * {% meta height:470 %}
2126
- * {% embed_file configuration/pager-template-all/app.component.ts preview %}
2127
- * {% embed_file configuration/pager-template-all/app.module.ts %}
2128
- * {% embed_file shared/main.ts %}
2129
- * {% embed_file shared/filesystem.ts %}
2130
- * {% endmeta %}
2145
+ * @example
2146
+ * ```
2147
+ * <kendo-treelist ...>
2148
+ * <kendo-treelist-column field="type"></kendo-treelist-column>
2149
+ * <ng-template
2150
+ * kendoTreeListPagerTemplate
2151
+ * let-totalPages="totalPages"
2152
+ * let-currentPage="currentPage">
2153
+ * <kendo-treelist-pager-prev-buttons></kendo-treelist-pager-prev-buttons>
2154
+ * <kendo-treelist-pager-next-buttons></kendo-treelist-pager-next-buttons>
2155
+ * <kendo-treelist-pager-info></kendo-treelist-pager-info>
2156
+ * </ng-template>
2157
+ * </kendo-treelist>
2158
+ * ```
2131
2159
  */
2132
2160
  class PagerTemplateDirective {
2133
2161
  constructor(templateRef) {
@@ -2398,15 +2426,18 @@ class ColumnList {
2398
2426
  * Represents the toolbar template of the TreeList.
2399
2427
  *
2400
2428
  * The template context has the following field:
2401
- * - `position`&mdash;The position at which the toolbar template is rendered. The possible values are "top" and "bottom".
2429
+ * - `position`&mdash;The position at which the toolbar template is rendered. The possible values are `top`, `bottom` and `both`.
2402
2430
  *
2403
2431
  * @example
2404
- * {% meta height:470 %}
2405
- * {% embed_file configuration/toolbar-template/basic/app.component.ts preview %}
2406
- * {% embed_file configuration/toolbar-template/basic/app.module.ts %}
2407
- * {% embed_file shared/main.ts %}
2408
- * {% embed_file shared/employees.ts %}
2409
- * {% endmeta %}
2432
+ * ```html
2433
+ * <kendo-treelist ...>
2434
+ * <ng-template kendoTreeListToolbarTemplate>
2435
+ * <button kendoTreeListExcelCommand icon="file-excel">
2436
+ * Export to Excel
2437
+ * </button>
2438
+ * </ng-template>
2439
+ * </kendo-treelist>
2440
+ * ```
2410
2441
  */
2411
2442
  class ToolbarTemplateDirective {
2412
2443
  constructor(templateRef, optionChanges) {
@@ -2416,12 +2447,8 @@ class ToolbarTemplateDirective {
2416
2447
  }
2417
2448
  /**
2418
2449
  * The position of the toolbar ([see example]({% slug toolbartemplate_treelist %})).
2419
- *
2420
- * The possible values are:
2421
- * - `top`&mdash;Positions the toolbar above the group panel or header.
2422
- * - `bottom`&mdash;Positions the toolbar below the pager.
2423
- * - `both`&mdash;Displays two toolbar instances. Positions the first one above
2424
- * the group panel or header and the second one below the pager.
2450
+ * The group panel or header and the second one below the pager.
2451
+ * @default 'top'
2425
2452
  */
2426
2453
  set position(position) {
2427
2454
  this._position = position;
@@ -3395,10 +3422,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
3395
3422
  *
3396
3423
  * The directive takes as input the `cellContext` from the cell template.
3397
3424
  *
3398
- * ```ts-no-run
3425
+ * ```html
3399
3426
  * <kendo-treelist-column>
3400
3427
  * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext">
3401
- * <input type="button" kendoButton [kendoTreeListFocusable]="cellContext" value="Focus me!" />
3428
+ * <input [kendoTreeListFocusable]="cellContext" />
3402
3429
  * </ng-template>
3403
3430
  * </kendo-treelist-column>
3404
3431
  * ```
@@ -7356,12 +7383,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
7356
7383
  * To define the content template, nest an `<ng-template>` tag with the
7357
7384
  * `kendoTreeListColumnMenuItemContentTemplate` directive inside a `<kendo-treelist-columnmenu-item>`.
7358
7385
  *
7359
- * {% meta height:500 %}
7360
- * {% embed_file column-menu/template-item-content/app.component.ts preview %}
7361
- * {% embed_file column-menu/template-item-content/app.module.ts %}
7362
- * {% embed_file shared/main.ts %}
7363
- * {% embed_file shared/employees.ts %}
7364
- * {% endmeta %}
7386
+ * @example
7387
+ * ```html
7388
+ * <kendo-treelist>
7389
+ * <kendo-treelist-column field="ProductName">
7390
+ * <ng-template kendoTreeListColumnMenuTemplate>
7391
+ * <kendo-treelist-columnmenu-item text="Item Text" [expanded]="true">
7392
+ * <ng-template kendoTreeListColumnMenuItemContentTemplate>
7393
+ * Item Content
7394
+ * </ng-template>
7395
+ * </kendo-treelist-columnmenu-item>
7396
+ * </ng-template>
7397
+ * </kendo-treelist-column>
7398
+ * </kendo-treelist>
7399
+ * ```
7365
7400
  */
7366
7401
  class ColumnMenuItemContentTemplateDirective {
7367
7402
  constructor(templateRef) {
@@ -17840,17 +17875,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
17840
17875
  * element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
17841
17876
  * When an associated button with the directive is clicked, the
17842
17877
  * [`edit`]({% slug api_treelist_treelistcomponent %}#toc-edit) event
17843
- * is triggered ([see example]({% slug editing_treelist %})).
17878
+ * is triggered ([see example](slug:custom_editors_editing_treelist)).
17844
17879
  *
17845
- * > * When the row is in the edit mode, the button with `kendoTreeListEditCommand` is automatically hidden.
17846
- * > * The directive takes as input the `cellContext` from the cell template.
17880
+ * When the row is in the `edit` mode, the button with `kendoTreeListEditCommand` is automatically hidden.
17881
+ * The directive takes as input the `cellContext` from the cell template.
17847
17882
  *
17848
17883
  * @example
17849
- * ```html-no-run
17884
+ * ```html
17850
17885
  * <kendo-treelist>
17851
17886
  * <kendo-treelist-command-column title="command">
17852
17887
  * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext">
17853
- * <button [kendoTreeListEditCommand]="cellContext" class="k-primary">Edit</button>
17888
+ * <button [kendoTreeListEditCommand]="cellContext">Edit</button>
17854
17889
  * </ng-template>
17855
17890
  * </kendo-treelist-command-column>
17856
17891
  * </kendo-treelist>
@@ -17912,13 +17947,13 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
17912
17947
  * element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
17913
17948
  * When an associated button with the directive is clicked, the
17914
17949
  * [`cancel`]({% slug api_treelist_treelistcomponent %}#toc-cancel) event
17915
- * is triggered ([see example]({% slug editing_treelist %})).
17950
+ * is triggered ([see example](slug:custom_editors_editing_treelist)).
17916
17951
  *
17917
- * > * When the row is not in the edit mode, the button with the `kendoTreeListCancelCommand` is automatically hidden.
17918
- * > * The directive takes as input the `cellContext` from the cell template.
17952
+ * When the row is not in the `edit` mode, the button with the `kendoTreeListCancelCommand` is automatically hidden.
17953
+ * The directive takes as input the `cellContext` from the cell template.
17919
17954
  *
17920
17955
  * @example
17921
- * ```html-no-run
17956
+ * ```html
17922
17957
  * <kendo-treelist>
17923
17958
  * <kendo-treelist-command-column title="command">
17924
17959
  * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext">
@@ -17927,19 +17962,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
17927
17962
  * </kendo-treelist-command-column>
17928
17963
  * </kendo-treelist>
17929
17964
  * ```
17930
- *
17931
- * You can control the content of the button based on the state of the row.
17932
- *
17933
- * @example
17934
- * ```html-no-run
17935
- * <kendo-treelist>
17936
- * <kendo-treelist-command-column title="command">
17937
- * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext" let-isNew="isNew">
17938
- * <button [kendoTreeListCancelCommand]="cellContext">{{isNew ? 'Discard' : 'Cancel changes'}}</button>
17939
- * </ng-template>
17940
- * </kendo-treelist-command-column>
17941
- * </kendo-treelist>
17942
- * ```
17943
17965
  */
17944
17966
  class CancelCommandDirective extends BaseCommandDirective {
17945
17967
  constructor(editService, element, renderer, localization, ngZone) {
@@ -17999,11 +18021,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
17999
18021
  * [`save`]({% slug api_treelist_treelistcomponent %}#toc-save) event
18000
18022
  * is triggered ([see example]({% slug editing_treelist %})).
18001
18023
  *
18002
- * > * When the row is not in the edit mode, the button with `kendoTreeListSaveCommand` is automatically hidden.
18003
- * > * The directive takes as input the `cellContext` from the cell template.
18024
+ * When the row is not in the `edit` mode, the button with `kendoTreeListSaveCommand` is automatically hidden.
18025
+ * The directive takes as input the `cellContext` from the cell template.
18004
18026
  *
18005
18027
  * @example
18006
- * ```html-no-run
18028
+ * ```html
18007
18029
  * <kendo-treelist>
18008
18030
  * <kendo-treelist-command-column title="command">
18009
18031
  * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext">
@@ -18012,19 +18034,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
18012
18034
  * </kendo-treelist-command-column>
18013
18035
  * </kendo-treelist>
18014
18036
  * ```
18015
- *
18016
- * You can control the content of the button based on the state of the row.
18017
- *
18018
- * @example
18019
- * ```html-no-run
18020
- * <kendo-treelist>
18021
- * <kendo-treelist-command-column title="command">
18022
- * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext" let-isNew="isNew">
18023
- * <button [kendoTreeListSaveCommand]="cellContext">{{isNew ? 'Add' : 'Update'}}</button>
18024
- * </ng-template>
18025
- * </kendo-treelist-command-column>
18026
- * </kendo-treelist>
18027
- * ```
18028
18037
  */
18029
18038
  class SaveCommandDirective extends BaseCommandDirective {
18030
18039
  constructor(editService, element, renderer, localization, ngZone) {
@@ -18083,11 +18092,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
18083
18092
  * [`remove` event]({% slug api_treelist_treelistcomponent %}#toc-remove)
18084
18093
  * is triggered ([see example]({% slug editing_reactive_forms_treelist %})).
18085
18094
  *
18086
- * > * When the row is in the edit mode, the button with the `kendoTreeListRemoveCommand` is automatically hidden.
18087
- * > * The directive takes as input the `cellContext` from the cell template.
18095
+ * When the row is in the `edit` mode, the button with the `kendoTreeListRemoveCommand` is automatically hidden.
18096
+ * The directive takes as input the `cellContext` from the cell template.
18088
18097
  *
18089
18098
  * @example
18090
- * ```html-no-run
18099
+ * ```html
18091
18100
  * <kendo-treelist>
18092
18101
  * <kendo-treelist-command-column title="command">
18093
18102
  * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext">
@@ -18149,28 +18158,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
18149
18158
 
18150
18159
  /**
18151
18160
  * Represents the command for adding a new item to the TreeList. You can apply this directive to any
18152
- * `button` element inside a [`ToolbarTemplate`]({% slug api_treelist_commandcolumncomponent %}) or
18161
+ * `button` element inside a [`ToolbarTemplate`](slug:toolbartemplate_treelist) or
18153
18162
  * inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
18154
18163
  *
18155
18164
  * When an associated button with the directive is clicked, the
18156
18165
  * [`add`]({% slug api_treelist_treelistcomponent %}#toc-add) event is triggered
18157
- * ([see example]({% slug editing_treelist %})).
18166
+ * ([see example](slug:custom_editors_editing_treelist)).
18158
18167
  *
18159
- * > When the row is in the edit mode, the button with `kendoTreeListAddCommand` is automatically hidden.
18160
- *
18161
- * @example
18162
- * ```html-no-run
18163
- * <kendo-treelist>
18164
- * <ng-template kendoTreeListToolbarTemplate>
18165
- * <button kendoTreeListAddCommand>Add new</button>
18166
- * </ng-template>
18167
- * </kendo-treelist>
18168
- * ```
18168
+ * When the row is in the `edit mode`, the button with `kendoTreeListAddCommand` is automatically hidden.
18169
18169
  *
18170
18170
  * When added to the command column, the directive takes as input the `cellContext` from the cell template.
18171
18171
  *
18172
18172
  * @example
18173
- * ```html-no-run
18173
+ * ```html
18174
18174
  * <kendo-treelist>
18175
18175
  * <kendo-treelist-command-column title="command">
18176
18176
  * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext">
@@ -18466,7 +18466,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
18466
18466
 
18467
18467
  /**
18468
18468
  * A directive which encapsulates the editing operations of the TreeList when using
18469
- * the Template-Driven Angular Forms ([see example]({% slug editing_directives_treelist %}#toc-the-template-directive)).
18469
+ * the Template-Driven Angular Forms ([see example](slug:editing_directives_treelist#toc-template-editing-directive)).
18470
18470
  */
18471
18471
  class TemplateEditingDirective extends RowEditingDirectiveBase {
18472
18472
  constructor(treelist) {
@@ -18583,7 +18583,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
18583
18583
 
18584
18584
  /**
18585
18585
  * A directive which encapsulates the editing operations of the TreeList when using the in-cell
18586
- * editing with Reactive Forms ([see example]({% slug editing_directives_treelist %}#toc-the-incell-directive)).
18586
+ * editing with Reactive Forms ([see example](slug:editing_directives_treelist#toc-in-cell-editing-directive)).
18587
18587
  */
18588
18588
  class InCellEditingDirective extends EditingDirectiveBase {
18589
18589
  constructor(treelist) {
@@ -18848,7 +18848,7 @@ class HierarchyEditService extends LocalEditService {
18848
18848
  *
18849
18849
  * The directive encapsulates the in-memory handling of data operations such as
18850
18850
  * [sorting]({% slug sorting_treelist %}), [aggregation]({% slug treelist_with_aggregates %})
18851
- * and [filtering]({% slug filtering_treelist %}) ([more information and examples]({% slug databinding_treelist %})).
18851
+ * and [filtering]({% slug filtering_treelist %}) ([more information and examples](slug:databinding_treelist#toc-binding-to-hierarchical-data)).
18852
18852
  */
18853
18853
  class HierarchyBindingDirective extends BaseBindingDirective {
18854
18854
  constructor(component) {
@@ -18934,7 +18934,7 @@ class FlatEditService extends LocalEditService {
18934
18934
  const ROOT_ID = null;
18935
18935
  /**
18936
18936
  * A directive which binds the TreeList to an array of objects by using
18937
- * an ID and parentID field to define the hierarchy.
18937
+ * an `idField` and `parentIDField` field to define the hierarchy.
18938
18938
  *
18939
18939
  * The directive encapsulates the in-memory handling of data operations such as
18940
18940
  * [sorting]({% slug sorting_treelist %}), [aggregation]({% slug treelist_with_aggregates %})
@@ -18993,7 +18993,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
18993
18993
  }] } });
18994
18994
 
18995
18995
  /**
18996
- * A directive which controls the expanded state of the items.
18996
+ * A directive which controls the expanded state of the items. [See example](slug:treelist_expanded_state#toc-built-in-directive).
18997
+ *
18998
+ * @example
18999
+ * ```html
19000
+ * <kendo-treelist ...
19001
+ * [kendoTreeListFlatBinding]="data"
19002
+ * kendoTreeListExpandable> ...
19003
+ * </kendo-treelist>
19004
+ * ```
18997
19005
  */
18998
19006
  class ExpandableDirective {
18999
19007
  constructor(component) {
@@ -19088,7 +19096,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
19088
19096
 
19089
19097
  const defaultColumnKeyGetter = (_column, columnIndex) => columnIndex;
19090
19098
  /**
19091
- * A directive which controls the selection state
19099
+ * A directive which controls the selection state. [See example](slug:selection_treelist).
19092
19100
  */
19093
19101
  class SelectableDirective {
19094
19102
  constructor(treelist) {
@@ -19456,12 +19464,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
19456
19464
  * - `pageNumber`&mdash;Defines PDF page number.
19457
19465
  * - `totalPages`&mdash;Defines the total number of PDF pages.
19458
19466
  *
19459
- * {% meta height:550 %}
19460
- * {% embed_file pdf-export/page-template-inline/app.component.ts preview %}
19461
- * {% embed_file pdf-export/page-template-inline/app.module.ts %}
19462
- * {% embed_file shared/filesystem.ts %}
19463
- * {% embed_file shared/main.ts %}
19464
- * {% endmeta %}
19467
+ * @example
19468
+ * ```html
19469
+ * <kendo-treelist-pdf fileName="Files.pdf" ...>
19470
+ * <ng-template
19471
+ * kendoTreeListPDFTemplate
19472
+ * let-pageNum="pageNum"
19473
+ * let-totalPages="totalPages">
19474
+ * <div style="position: absolute; top: 5px; left: 5px;">
19475
+ * Page {{ pageNum }} of {{ totalPages }}
19476
+ * </div>
19477
+ * </ng-template>
19478
+ * </kendo-treelist-pdf>
19479
+ * ```
19465
19480
  */
19466
19481
  class PDFTemplateDirective extends PDFExportTemplateDirective {
19467
19482
  constructor(templateRef) {
@@ -19849,19 +19864,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
19849
19864
  /**
19850
19865
  * Represents the `export-to-PDF` command of the TreeList.
19851
19866
  * You can apply this directive to any `button` element inside a
19852
- * [`ToolbarTemplate`]({% slug api_treelist_commandcolumncomponent %}).
19867
+ * [`ToolbarTemplate`](slug:toolbartemplate_treelist).
19853
19868
  * When the user clicks a button that is associated with the directive, the
19854
19869
  * [`pdfExport`]({% slug api_treelist_treelistcomponent %}#toc-pdfexport) event
19855
19870
  * fires ([see example]({% slug pdfexport_treelist %})).
19856
19871
  *
19857
19872
  * @example
19858
- * ```html-no-run
19873
+ * ```html
19859
19874
  * <kendo-treelist>
19860
- * <ng-template kendoTreeListToolbarTemplate>
19861
- * <button kendoTreeListPDFCommand>Export to PDF</button>
19862
- * </ng-template>
19863
- * <kendo-treelist-pdf fileName="TreeList.pdf">
19864
- * </kendo-treelist-pdf>
19875
+ * <ng-template kendoTreeListToolbarTemplate>
19876
+ * <button kendoTreeListPDFCommand>Export to PDF</button>
19877
+ * </ng-template>
19878
+ * <kendo-treelist-pdf fileName="TreeList.pdf"></kendo-treelist-pdf>
19865
19879
  * </kendo-treelist>
19866
19880
  * ```
19867
19881
  */
@@ -20202,19 +20216,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
20202
20216
  /**
20203
20217
  * Represents the `export-to-Excel` command of the TreeList. You can apply this
20204
20218
  * directive to any `button` element inside a
20205
- * [`ToolbarTemplate`]({% slug api_treelist_commandcolumncomponent %}).
20219
+ * [`ToolbarTemplate`](slug:toolbartemplate_treelist).
20206
20220
  * When the user clicks a button associated with the directive, the
20207
20221
  * [`excelExport`]({% slug api_treelist_treelistcomponent %}#toc-excelexport) event
20208
20222
  * fires ([see example]({% slug excelexport_treelist %})).
20209
20223
  *
20210
20224
  * @example
20211
- * ```html-no-run
20225
+ * ```html
20212
20226
  * <kendo-treelist>
20213
- * <ng-template kendoTreeListToolbarTemplate>
20214
- * <button kendoTreeListExcelCommand>Export to PDF</button>
20215
- * </ng-template>
20216
- * <kendo-treelist-excel fileName="TreeList.xlsx">
20217
- * </kendo-treelist-excel>
20227
+ * <ng-template kendoTreeListToolbarTemplate>
20228
+ * <button kendoTreeListExcelCommand>Export to PDF</button>
20229
+ * </ng-template>
20230
+ * <kendo-treelist-excel fileName="TreeList.xlsx"> </kendo-treelist-excel>
20218
20231
  * </kendo-treelist>
20219
20232
  * ```
20220
20233
  */
@@ -12,10 +12,10 @@ import * as i0 from "@angular/core";
12
12
  *
13
13
  * The directive takes as input the `cellContext` from the cell template.
14
14
  *
15
- * ```ts-no-run
15
+ * ```html
16
16
  * <kendo-treelist-column>
17
17
  * <ng-template kendoTreeListCellTemplate let-cellContext="cellContext">
18
- * <input type="button" kendoButton [kendoTreeListFocusable]="cellContext" value="Focus me!" />
18
+ * <input [kendoTreeListFocusable]="cellContext" />
19
19
  * </ng-template>
20
20
  * </kendo-treelist-column>
21
21
  * ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@progress/kendo-angular-treelist",
3
- "version": "12.0.1-develop.3",
3
+ "version": "12.0.1-develop.4",
4
4
  "description": "Kendo UI TreeList for Angular - Display hierarchical data in an Angular tree grid view that supports sorting, filtering, paging, and much more.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "author": "Progress",
@@ -30,24 +30,24 @@
30
30
  "@progress/kendo-data-query": "^1.0.0",
31
31
  "@progress/kendo-drawing": "^1.17.2",
32
32
  "@progress/kendo-licensing": "^1.0.2",
33
- "@progress/kendo-angular-buttons": "12.0.1-develop.3",
34
- "@progress/kendo-angular-common": "12.0.1-develop.3",
35
- "@progress/kendo-angular-dateinputs": "12.0.1-develop.3",
36
- "@progress/kendo-angular-dropdowns": "12.0.1-develop.3",
37
- "@progress/kendo-angular-excel-export": "12.0.1-develop.3",
38
- "@progress/kendo-angular-icons": "12.0.1-develop.3",
39
- "@progress/kendo-angular-inputs": "12.0.1-develop.3",
40
- "@progress/kendo-angular-intl": "12.0.1-develop.3",
41
- "@progress/kendo-angular-l10n": "12.0.1-develop.3",
42
- "@progress/kendo-angular-label": "12.0.1-develop.3",
43
- "@progress/kendo-angular-pdf-export": "12.0.1-develop.3",
44
- "@progress/kendo-angular-popup": "12.0.1-develop.3",
33
+ "@progress/kendo-angular-buttons": "12.0.1-develop.4",
34
+ "@progress/kendo-angular-common": "12.0.1-develop.4",
35
+ "@progress/kendo-angular-dateinputs": "12.0.1-develop.4",
36
+ "@progress/kendo-angular-dropdowns": "12.0.1-develop.4",
37
+ "@progress/kendo-angular-excel-export": "12.0.1-develop.4",
38
+ "@progress/kendo-angular-icons": "12.0.1-develop.4",
39
+ "@progress/kendo-angular-inputs": "12.0.1-develop.4",
40
+ "@progress/kendo-angular-intl": "12.0.1-develop.4",
41
+ "@progress/kendo-angular-l10n": "12.0.1-develop.4",
42
+ "@progress/kendo-angular-label": "12.0.1-develop.4",
43
+ "@progress/kendo-angular-pdf-export": "12.0.1-develop.4",
44
+ "@progress/kendo-angular-popup": "12.0.1-develop.4",
45
45
  "rxjs": "^6.5.3 || ^7.0.0",
46
- "@progress/kendo-angular-listview": "12.0.1-develop.3"
46
+ "@progress/kendo-angular-listview": "12.0.1-develop.4"
47
47
  },
48
48
  "dependencies": {
49
49
  "tslib": "^2.3.1",
50
- "@progress/kendo-angular-schematics": "12.0.1-develop.3",
50
+ "@progress/kendo-angular-schematics": "12.0.1-develop.4",
51
51
  "@progress/kendo-common": "^0.2.0",
52
52
  "@progress/kendo-file-saver": "^1.0.0"
53
53
  },
@@ -6,7 +6,7 @@ import { TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
8
  * Represents the pager template which helps to customize the pager appearance in the TreeList. To define a pager
9
- * template, nest an `<ng-template>` tag with the `kendoTreeListPagerTemplate` directive inside `<kendo-treelist>`.
9
+ * template, nest an `<ng-template>` tag with the `kendoTreeListPagerTemplate` directive inside `<kendo-treelist>`. [See example](slug:paging_treelist#toc-pager-template).
10
10
  *
11
11
  * The template context provides the following fields:
12
12
  * * `currentPage`&mdash;The index of the displayed page.
@@ -15,12 +15,20 @@ import * as i0 from "@angular/core";
15
15
  * * `total`&mdash;The total number of records.
16
16
  * * `totalPages`&mdash;The total number of available pages.
17
17
  *
18
- * {% meta height:470 %}
19
- * {% embed_file configuration/pager-template-all/app.component.ts preview %}
20
- * {% embed_file configuration/pager-template-all/app.module.ts %}
21
- * {% embed_file shared/main.ts %}
22
- * {% embed_file shared/filesystem.ts %}
23
- * {% endmeta %}
18
+ * @example
19
+ * ```
20
+ * <kendo-treelist ...>
21
+ * <kendo-treelist-column field="type"></kendo-treelist-column>
22
+ * <ng-template
23
+ * kendoTreeListPagerTemplate
24
+ * let-totalPages="totalPages"
25
+ * let-currentPage="currentPage">
26
+ * <kendo-treelist-pager-prev-buttons></kendo-treelist-pager-prev-buttons>
27
+ * <kendo-treelist-pager-next-buttons></kendo-treelist-pager-next-buttons>
28
+ * <kendo-treelist-pager-info></kendo-treelist-pager-info>
29
+ * </ng-template>
30
+ * </kendo-treelist>
31
+ * ```
24
32
  */
25
33
  export declare class PagerTemplateDirective {
26
34
  templateRef: TemplateRef<any>;