@progress/kendo-angular-treelist 13.0.0-develop.6 → 13.0.0-develop.8

package/localization/messages.d.ts

@@ -174,7 +174,7 @@ export declare class Messages extends ComponentMessages {
     /**
      * The loading text.
      *
-     * > The `loading` property is part of the accessibility support of the TreeList.
+     * The `loading` property is part of the accessibility support of the TreeList.
      * Its value is detectable by screen readers and is not otherwise visible.
      */
     loading: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@progress/kendo-angular-treelist",
-  "version": "13.0.0-develop.6",
+  "version": "13.0.0-develop.8",
   "description": "Kendo UI TreeList for Angular - Display hierarchical data in an Angular tree grid view that supports sorting, filtering, paging, and much more.",
   "license": "SEE LICENSE IN LICENSE.md",
   "author": "Progress",
@@ -30,25 +30,25 @@
     "@progress/kendo-data-query": "^1.0.0",
     "@progress/kendo-drawing": "^1.17.2",
     "@progress/kendo-licensing": "^1.0.2",
-    "@progress/kendo-angular-buttons": "13.0.0-develop.6",
-    "@progress/kendo-angular-common": "13.0.0-develop.6",
-    "@progress/kendo-angular-dateinputs": "13.0.0-develop.6",
-    "@progress/kendo-angular-dropdowns": "13.0.0-develop.6",
-    "@progress/kendo-angular-excel-export": "13.0.0-develop.6",
-    "@progress/kendo-angular-icons": "13.0.0-develop.6",
-    "@progress/kendo-angular-inputs": "13.0.0-develop.6",
-    "@progress/kendo-angular-intl": "13.0.0-develop.6",
-    "@progress/kendo-angular-l10n": "13.0.0-develop.6",
-    "@progress/kendo-angular-label": "13.0.0-develop.6",
-    "@progress/kendo-angular-pdf-export": "13.0.0-develop.6",
-    "@progress/kendo-angular-popup": "13.0.0-develop.6",
-    "@progress/kendo-angular-utils": "13.0.0-develop.6",
+    "@progress/kendo-angular-buttons": "13.0.0-develop.8",
+    "@progress/kendo-angular-common": "13.0.0-develop.8",
+    "@progress/kendo-angular-dateinputs": "13.0.0-develop.8",
+    "@progress/kendo-angular-dropdowns": "13.0.0-develop.8",
+    "@progress/kendo-angular-excel-export": "13.0.0-develop.8",
+    "@progress/kendo-angular-icons": "13.0.0-develop.8",
+    "@progress/kendo-angular-inputs": "13.0.0-develop.8",
+    "@progress/kendo-angular-intl": "13.0.0-develop.8",
+    "@progress/kendo-angular-l10n": "13.0.0-develop.8",
+    "@progress/kendo-angular-label": "13.0.0-develop.8",
+    "@progress/kendo-angular-pdf-export": "13.0.0-develop.8",
+    "@progress/kendo-angular-popup": "13.0.0-develop.8",
+    "@progress/kendo-angular-utils": "13.0.0-develop.8",
     "rxjs": "^6.5.3 || ^7.0.0",
-    "@progress/kendo-angular-listview": "13.0.0-develop.6"
+    "@progress/kendo-angular-listview": "13.0.0-develop.8"
   },
   "dependencies": {
     "tslib": "^2.3.1",
-    "@progress/kendo-angular-schematics": "13.0.0-develop.6",
+    "@progress/kendo-angular-schematics": "13.0.0-develop.8",
     "@progress/kendo-common": "^0.2.0",
     "@progress/kendo-file-saver": "^1.0.0"
   },

package/pager/pager-numeric-buttons.component.d.ts

@@ -8,7 +8,7 @@ import { PagerContextChanges, PagerContextService } from './pager-context.servic
 import { PagerElementComponent } from './pager-element.component';
 import * as i0 from "@angular/core";
 /**
- * Displays numeric buttons to enable navigation between the pages.
+ * Displays numeric buttons to enable navigation between the pages ([see example]({% slug paging_treelist %}#toc-pager-templates)).
  */
 export declare class PagerNumericButtonsComponent extends PagerElementComponent {
     protected pagerContext: PagerContextService;

package/pager/pager-template.directive.d.ts

@@ -16,7 +16,7 @@ import * as i0 from "@angular/core";
  * * `totalPages`—The total number of available pages.
  *
  * @example
- * ```
+ * ```html
  * <kendo-treelist ...>
  *   <kendo-treelist-column field="type"></kendo-treelist-column>
  *   <ng-template

package/pdf/pdf-command.directive.d.ts

@@ -17,7 +17,7 @@ import * as i0 from "@angular/core";
  *
  * @example
  * ```html
- * <kendo-treelist>
+ * <kendo-treelist ...>
  *   <ng-template kendoTreeListToolbarTemplate>
  *     <button kendoTreeListPDFCommand>Export to PDF</button>
  *   </ng-template>

package/pdf/pdf-margin.component.d.ts

@@ -4,6 +4,15 @@
 *-------------------------------------------------------------------------------------------*/
 import { PDFExportMarginComponent } from '@progress/kendo-angular-pdf-export';
 import * as i0 from "@angular/core";
+/**
+ * Represents the Kendo UI PDFMargin component for Angular.
+ * The supported units are:
+ * `"mm"`
+ * `"cm"`
+ * `"in"`
+ * `"pt"` (default).
+ * Numbers are considered to be points (`"pt"`).
+ */
 export declare class PDFMarginComponent extends PDFExportMarginComponent {
     static ɵfac: i0.ɵɵFactoryDeclaration<PDFMarginComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<PDFMarginComponent, "kendo-treelist-pdf-margin", never, {}, {}, never, never>;

package/rendering/cell-template.directive.d.ts

@@ -20,7 +20,7 @@ import * as i0 from "@angular/core";
  * - `loading`—Specifies if the item children are currently loading.
  * - `rowIndex`—The current row index. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
  *
- * * @example
+ * @example
  * ```html
  * <kendo-treelist ...>
  *   <kendo-treelist-column field="ProductName">

package/rendering/common/spacer.component.d.ts

@@ -7,7 +7,7 @@ import * as i0 from "@angular/core";
  * Represents the Kendo UI TreeListSpacer component for Angular.
  * Used to give additional white space between the Pager inner elements,
  * and provides a way for customizing the spacer width.
- * It can also be used in any flex container within the TreeList.
+ * It can also be used in any flex container within the TreeList. [See example](slug:toolbartemplate_treelist#toc-define-spacing-between-the-toolbar-elements).
  */
 export declare class TreeListSpacerComponent {
     hostClass: boolean;

package/schematics/ngAdd/index.js

@@ -4,13 +4,13 @@ const schematics_1 = require("@angular-devkit/schematics");
 function default_1(options) {
     const finalOptions = Object.assign(Object.assign({}, options), { mainNgModule: 'TreeListModule', package: 'treelist', peerDependencies: {
             // peer dep of the dropdowns
-            '@progress/kendo-angular-treeview': '13.0.0-develop.6',
+            '@progress/kendo-angular-treeview': '13.0.0-develop.8',
             // peer dependency of kendo-angular-inputs
-            '@progress/kendo-angular-dialog': '13.0.0-develop.6',
+            '@progress/kendo-angular-dialog': '13.0.0-develop.8',
             // peer dependency of kendo-angular-icons
             '@progress/kendo-svg-icons': '^1.0.0',
             // peer dependency of kendo-angular-dateinputs
-            '@progress/kendo-angular-navigation': '13.0.0-develop.6',
+            '@progress/kendo-angular-navigation': '13.0.0-develop.8',
         } });
     return (0, schematics_1.externalSchematic)('@progress/kendo-angular-schematics', 'ng-add', finalOptions);
 }

package/treelist.component.d.ts

@@ -70,12 +70,11 @@ import * as i0 from "@angular/core";
 /**
  * Represents the Kendo UI TreeList component for Angular.
  *
- * {% meta height:470 %}
- * {% embed_file data-binding/flat/app.component.ts preview %}
- * {% embed_file data-binding/flat/app.module.ts %}
- * {% embed_file shared/main.ts %}
- * {% embed_file shared/employees.ts %}
- * {% endmeta %}
+ * @example
+ * ```html
+ * <kendo-treelist [kendoTreeListFlatBinding]="data" ...></kendo-treelist>
+ * ```
+ *
  */
 export declare class TreeListComponent implements AfterContentInit, AfterViewInit, OnDestroy, OnChanges, OnInit {
     private supportService;
@@ -126,8 +125,9 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      */
     height: number;
     /**
-     * Defines the row height that is used when the `scrollable` option of the TreeList is set to `virtual`.
+     * Represent the actual height of each TreeList row (`tr`) element in the DOM.
      * Required by the [virtual scrolling functionality]({% slug scrollmmodes_treelist %}).
+     * Set the `rowHeight` option to the exact pixels as the height of the `tr` element appears in the DOM.
      */
     rowHeight: number;
     /**
@@ -138,10 +138,7 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
     set skip(value: number | null | undefined);
     /**
      * Defines the scroll mode used by the TreeList.
-     *
-     * The available options are:
-     *  - `none`&mdash;Renders no scrollbar.
-     *  - `scrollable`&mdash;The default scroll mode. It requires the setting of the `height` option.
+     * @default 'scrollable'
      */
     scrollable: ScrollMode;
     /**
@@ -154,45 +151,7 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      *
      * By default, the TreeList tracks changes by the index of the data item.
      * Edited rows are tracked by reference.
-     * In some cases, you might need to override the default behavior,
-     * for example, when you implement editing with immutable data items.
-     *
-     * The following example demonstrates how to track items only by index.
-     *
-     * @example
-     * ```ts
-     * import { Component } from '@angular/core';
-     * import { TreeListItem } from '@progress/kendo-angular-treelist';
-     *
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-treelist [data]="treelistData" [trackBy]="trackBy">
-     *        </kendo-treelist>
-     *    `
-     * })
-     * class AppComponent {
-     *    public treelistData: any[] = products;
-     *
-     *    public trackBy(index: number, item: TreeListItem): any {
-     *        console.log(item);
-     *        return index;
-     *    }
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     * ```
+     *
      */
     trackBy: TrackByFunction<TreeListItem>;
     /**
@@ -201,6 +160,7 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
     filter: CompositeFilterDescriptor | null | undefined;
     /**
      * If set to `true`, the treelist will render only the columns in the current viewport.
+     * @default false
      */
     virtualColumns: boolean;
     /**
@@ -231,18 +191,12 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
     /**
      * Configures the pager of the TreeList ([see example]({% slug paging_treelist %})).
      *
-     * The available options are:
-     * - `buttonCount: Number`&mdash;Sets the maximum numeric buttons count before the buttons are collapsed. Defaults to `10`.
-     * - `info: Boolean`&mdash;Toggles the information about the current page and the total number of records. Defaults to `true`.
-     * - `type: PagerType`&mdash;Accepts the `numeric` (buttons with numbers) and `input` (input for typing the page number) values. Defaults to `'numeric'`.
-     * - `pageSizes: Boolean` or `Array<number>`&mdash;Shows a menu for selecting the page size. Defaults to `false`.
-     * - `previousNext: Boolean`&mdash;Toggles the **Previous** and **Next** buttons. Defaults to `true`.
-     * - `responsive: Boolean`&mdash;Toggles the built-in responsive behavior of the Pager. Defaults to `true`.
      */
     pageable: PagerSettings | boolean;
     /**
      * If set to `true`, the user can use dedicated shortcuts to interact with the TreeList.
      * By default, navigation is disabled and the TreeList content is accessible in the normal tab sequence.
+     * @default false
      */
     navigable: boolean;
     /**
@@ -261,53 +215,13 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      * Columns with `autoSize` set to `false` are excluded.
      * To dynamically update the column width to match the new content,
      * refer to [this example]({% slug resizing_columns_treelist %}).
+     *
+     * @default false
      */
     autoSize: boolean;
     /**
      * Defines a function that is executed for every data row in the component.
      *
-     * @example
-     * ```ts
-     * import { Component, ViewEncapsulation } from '@angular/core';
-     * import { RowClassArgs } from '@progress/kendo-angular-treelist';
-     *
-     * _@Component({
-     *    selector: 'my-app',
-     *    encapsulation: ViewEncapsulation.None,
-     *    styles: [`
-     *        .k-treelist tr.even { background-color: #f45c42; }
-     *        .k-treelist tr.odd { background-color: #41f4df; }
-     *    `],
-     *    template: `
-     *        <kendo-treelist [data]="treelistData" [rowClass]="rowCallback">
-     *        </kendo-treelist>
-     *    `
-     * })
-     * class AppComponent {
-     *    public treelistData: any[] = products;
-     *
-     *    public rowCallback(context: RowClassArgs) {
-     *        const isEven = context.index % 2 === 0;
-     *        return {
-     *            even: isEven,
-     *            odd: !isEven
-     *        };
-     *    }
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     * ```
      */
     set rowClass(fn: RowClassFn);
     get rowClass(): RowClassFn;
@@ -348,7 +262,9 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
     /**
      * Specifies if the header of the treelist will be hidden. The header is visible by default.
      *
-     * > The header includes column headers and the [filter row]({% slug filtering_treelist %}#toc-filter-row).
+     * The header includes column headers and the [filter row]({% slug filtering_treelist %}#toc-filter-row).
+     *
+     * @default false
      */
     hideHeader: boolean;
     /**
@@ -362,7 +278,7 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      */
     set selectable(value: boolean | SelectableSettings);
     /**
-     * Provides a callback that determines if the given row / cell is selected.
+     * Provides a callback that determines if the given row or cell is selected.
      */
     set isSelected(value: IsSelectedFn);
     /**
@@ -693,7 +609,7 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      * Exports the TreeList element to a Drawing [`Group`]({% slug api_kendo-drawing_group %}) by using the `kendo-treelist-pdf` component options.
      * ([see example]({% slug pdfexport_treelist %}#toc-exporting-multiple-treelists-to-the-same-pdf)).
      *
-     * @return {Promise} - A promise that will be resolved with the Drawing `Group`.
+     * @return {Promise} A promise that will be resolved with the Drawing `Group`.
      */
     drawPDF(): Promise<any>;
     /**
@@ -705,64 +621,8 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      * so that the whole text fits without wrapping. This method expects the TreeList
      * to be resizable (set `resizable` to `true`).
      * Makes sense to execute this method only
-     * after the TreeList is already populated with data.
-     *
-     * @example
-     * ```ts
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-treelist
-     *            #treelist
-     *            [data]="treelistData"
-     *            [resizable]="true"
-     *            style="height: 300px">
-     *            <ng-template kendoTreeListToolbarTemplate>
-     *                 <button kendoButton (click)="treelist.autoFitColumn(groupColumn)">
-     *                     Auto-fit the group column
-     *                 </button>
-     *            </ng-template>
-     *            <kendo-treelist-column-group #groupColumn title="Product Info">
-     *                <kendo-treelist-column
-     *                    field="ProductID"
-     *                    [width]="50"
-     *                    [minResizableWidth]="30"
-     *                    title="ID">
-     *                </kendo-treelist-column>
-     *
-     *                <kendo-treelist-column
-     *                    field="ProductName"
-     *                    title="Product Name">
-     *                </kendo-treelist-column>
-     *            </kendo-treelist-column-group>
-     *
-     *            <kendo-treelist-column
-     *                field="UnitPrice"
-     *                title="Unit Price"
-     *                [width]="180"
-     *                filter="numeric"
-     *                format="{0:c}">
-     *            </kendo-treelist-column>
-     *        </kendo-treelist>
-     *    `
-     * })
-     * class AppComponent {
-     *    public treelistData: any[] = products;
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     * ```
+     * after the TreeList is already populated with data. [See example](slug:resizing_columns_treelist#toc-auto-fitting-the-content).
+     *
      */
     autoFitColumn(column: ColumnBase): void;
     /**
@@ -770,69 +630,7 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      * If no columns are specified, `autoFitColumns` is applied to all columns.
      *
      * This method requires the TreeList to be resizable (set `resizable` to `true`).
-     *
-     * @example
-     * ```ts
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *      <kendo-treelist
-     *          #treelist
-     *          [data]="treelistData"
-     *          [resizable]="true"
-     *          style="height: 300px">
-     *          <ng-template kendoTreeListToolbarTemplate>
-     *              <button kendoButton (click)="treelist.autoFitColumns([firstColumn, lastColumn])">
-     *                  Auto-fit the first and last column
-     *              </button>
-     *              <button kendoButton (click)="treelist.autoFitColumns()">
-     *                  Auto-fit all columns
-     *              </button>
-     *          </ng-template>
-     *          <kendo-treelist-column-group title="Product Info">
-     *              <kendo-treelist-column
-     *                  #firstColumn
-     *                  field="ProductID"
-     *                  [width]="50"
-     *                  [minResizableWidth]="30"
-     *                  title="ID">
-     *              </kendo-treelist-column>
-     *
-     *              <kendo-treelist-column
-     *                  field="ProductName"
-     *                  title="Product Name"
-     *                  >
-     *              </kendo-treelist-column>
-     *          </kendo-treelist-column-group>
-     *
-     *          <kendo-treelist-column
-     *              #lastColumn
-     *              field="UnitPrice"
-     *              title="Unit Price"
-     *              [width]="180"
-     *              filter="numeric"
-     *              format="{0:c}">
-     *          </kendo-treelist-column>
-     *      </kendo-treelist>
-     *    `
-     * })
-     * class AppComponent {
-     *    public treelistData: any[] = products;
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     * ```
+     * [See example](slug:resizing_columns_treelist#toc-auto-fitting-the-content).
      */
     autoFitColumns(columns?: Array<ColumnBase> | QueryList<ColumnBase>): void;
     /**
@@ -860,9 +658,9 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
     /**
      * Focuses the cell with the specified row and column index.
      *
-     * The row index is based on the logical structure of the TreeList and does not correspond to the data item index:
-     * * Header rows are included, starting at index 0.
-     * * The row indexing is absolute and does not change with paging.
+     * The row index is based on the logical structure of the TreeList and does not correspond to the data item index.
+     * The row indexing is absolute and does not change with paging.
+     * Header rows are included, starting at index 0.
      *
      * If the TreeList is configured for scrolling, including virtual scrolling, the scroll position will be updated.
      * If the row is not present on the current page, the method will have no effect.
@@ -902,67 +700,6 @@ export declare class TreeListComponent implements AfterContentInit, AfterViewIni
      * @param {number} destIndex - The new position of the column.
      * @param {ColumnReorderConfig} options - Additional options.
      *
-     * @example
-     * ```ts
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-treelist
-     *            #treelist
-     *            [data]="treelistData"
-     *            [reorderable]="true"
-     *            style="height: 300px">
-     *            <ng-template kendoTreeListToolbarTemplate>
-     *                 <button kendoButton
-     *                     (click)="treelist.reorderColumn(groupColumn, 2, { before: true })">
-     *                     Move the group column before the last one.
-     *                 </button>
-     *            </ng-template>
-     *            <kendo-treelist-column-group #groupColumn title="Product Info">
-     *                <kendo-treelist-column
-     *                    field="ProductID"
-     *                    [width]="50"
-     *                    title="ID">
-     *                </kendo-treelist-column>
-     *
-     *                <kendo-treelist-column
-     *                    field="ProductName"
-     *                    title="Product Name">
-     *                </kendo-treelist-column>
-     *            </kendo-treelist-column-group>
-     *
-     *            <kendo-treelist-column
-     *                field="UnitPrice"
-     *                title="Unit Price"
-     *                [width]="180"
-     *                format="{0:c}">
-     *            </kendo-treelist-column>
-     *
-     *            <kendo-treelist-column
-     *                field="Discontinued"
-     *                title="Discontinued"
-     *                [width]="100">
-     *            </kendo-treelist-column>
-     *        </kendo-treelist>
-     *    `
-     * })
-     * class AppComponent {
-     *    public treelistData: any[] = products;
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     * ```
      */
     reorderColumn(source: ColumnBase, destIndex: number, options?: ColumnReorderConfig): void;
     /**