@progress/kendo-angular-treelist 12.0.2-develop.1 → 12.0.2-develop.3

package/esm2020/pdf/pdf.module.mjs

@@ -27,29 +27,18 @@ const declarations = [
  *
  * @example
  *
- * ```ts-no-run
- * // Import the TreeList and PDF modules
- * import { TreeListModule, PDFModule } from '@progress/kendo-angular-treelist';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```ts
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
+ * import { BrowserModule } from "@angular/platform-browser";
+ * import { TreeListModule, PDFModule } from '@progress/kendo-angular-treelist';
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
  * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, TreeListModule, PDFModule], // import TreeList and PDF modules
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, TreeListModule, PDFModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 export class PDFModule {

package/esm2020/treelist.module.mjs

@@ -137,29 +137,19 @@ const declarations = [
  *
  * @example
  *
- * ```ts-no-run
- * // Import the TreeList module
- * import { TreeListModule } from '@progress/kendo-angular-treelist';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```ts
  * import { NgModule } from '@angular/core';
+ * import { BrowserModule } from "@angular/platform-browser";
+ * import { TreeListModule } from '@progress/kendo-angular-treelist';
  *
- * // Import the app component
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
  * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, TreeListModule], // import TreeList module
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, TreeListModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 export class TreeListModule {

package/excel/excel-export-event.d.ts

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { PreventableEvent } from '../common/preventable-event';
 /**
- * Arguments for the `excelExport` event.
+ * Arguments for the `excelExport` event. [See example](slug:excelexport_treelist#toc-customizing-generated-workbooks).
  */
 export declare class ExcelExportEvent extends PreventableEvent {
     workbook: any;

package/excel/excel.module.d.ts

@@ -12,30 +12,18 @@ import * as i4 from "@progress/kendo-angular-excel-export";
  * definition for the Excel component of the TreeList.
  *
  * @example
- *
- * ```ts-no-run
- * // Import the TreeList and Excel modules
- * import { TreeListModule, ExcelModule } from '@progress/kendo-angular-treelist';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```ts
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
+ * import { BrowserModule } from "@angular/platform-browser";
+ * import { TreeListModule, ExcelModule } from '@progress/kendo-angular-treelist';
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
  * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, TreeListModule, ExcelModule], // import TreeList and Excel modules
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, TreeListModule, ExcelModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 export declare class ExcelModule {

package/fesm2015/progress-kendo-angular-treelist.mjs

@@ -46,8 +46,8 @@ const packageMetadata = {
     name: '@progress/kendo-angular-treelist',
     productName: 'Kendo UI for Angular',
     productCodes: ['KENDOUIANGULAR', 'KENDOUICOMPLETE'],
-    publishDate: 1683201191,
-    version: '12.0.2-develop.1',
+    publishDate: 1683884362,
+    version: '12.0.2-develop.3',
     licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
 };
 
@@ -299,8 +299,8 @@ class ColumnBase {
         this.matchesMedia = true;
         /**
          * The column index after reordering.
-         *
-         * > `orderIndex` is a read-only property. Setting this field does not affect column order.
+         * The orderIndex` is a read-only property. Setting this field does not affect column order.
+         * @default 0
          */
         this.orderIndex = 0;
         /**
@@ -323,19 +323,23 @@ class ColumnBase {
         this.reorderable = true;
         /**
          * The width (in pixels) below which the user is not able to resize the column by using the UI.
+         * @default 10
          */
         this.minResizableWidth = 10;
         this._locked = false;
         /**
          * Specifies if the column can be locked or unlocked from the column menu or by reordering the columns.
+         * @default true
          */
         this.lockable = true;
         /**
          * Specifies if the column menu will be shown for the column.
+         * @default true
          */
         this.columnMenu = true;
         /**
          * Specifies if the column will be included in the column-chooser list.
+         * @default true
          */
         this.includeInChooser = true;
         /**
@@ -370,48 +374,9 @@ class ColumnBase {
     }
     get width() { return this._width; }
     /**
-     * Toggles the locked (frozen) state of the columns ([more information and example]({% slug locked_columns_treelist %})).
+     * Toggles the locked (frozen) state of the columns ([more information and example](slug:locked_columns_treelist)).
      *
      * @default false
-     *
-     * @example
-     * ```ts
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-treelist [data]="treelistData" [scrollable]="scrollable" style="height: 200px">
-     *          <kendo-treelist-column field="ProductID" title="Product ID" [width]="120" [locked]="true">
-     *          </kendo-treelist-column>
-     *          <kendo-treelist-column field="ProductName" title="Product Name" [width]="200">
-     *          </kendo-treelist-column>
-     *          <kendo-treelist-column field="UnitPrice" title="Unit Price" [width]="230">
-     *          </kendo-treelist-column>
-     *        </kendo-treelist>
-     *    `
-     * })
-     *
-     * class AppComponent {
-     *    public treelistData: any[];
-     *
-     *    constructor() {
-     *        this.treelistData = products;
-     *    }
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     *
-     * ```
      */
     set locked(value) {
         this._locked = value;
@@ -2907,6 +2872,9 @@ const contains$1 = (node, predicate) => {
  * Arguments for the `close` event of the filter and column-menu popup.
  */
 class PopupCloseEvent extends PreventableEvent {
+    /**
+     * @hidden
+     */
     constructor(e) {
         super();
         this.originalEvent = e;
@@ -2918,6 +2886,9 @@ const DEFAULT_POPUP_CLASS = 'k-grid-filter-popup';
  * ([see example]({% slug reusablecustomfilters_treelist %}#toc-filter-menu-with-popup)).
  */
 class SinglePopupService {
+    /**
+     * @hidden
+     */
     constructor(popupService, renderer, ngZone, scrollSyncService, localization) {
         this.popupService = popupService;
         this.renderer = renderer;
@@ -7355,12 +7326,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
  * Represents the service that is passed to the
  * [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
  *
- * {% meta height:500 %}
- * {% embed_file column-menu/template-item/app.component.ts preview %}
- * {% embed_file column-menu/template-item/app.module.ts %}
- * {% embed_file shared/main.ts %}
- * {% embed_file shared/employees.ts %}
- * {% endmeta %}
+ * @example
+ * ```html
+ * <kendo-treelist>
+ *   <ng-template
+ *     kendoTreeListColumnMenuTemplate
+ *     let-service="service"
+ *     let-column="column">
+ *     <kendo-treelist-columnmenu-sort [service]="service">
+ *   </ng-template>
+ * </kendo-treelist>
+ * ```
  */
 class ColumnMenuService {
     constructor() {
@@ -19401,29 +19377,19 @@ const declarations$2 = [
  *
  * @example
  *
- * ```ts-no-run
- * // Import the TreeList module
- * import { TreeListModule } from '@progress/kendo-angular-treelist';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```ts
  * import { NgModule } from '@angular/core';
+ * import { BrowserModule } from "@angular/platform-browser";
+ * import { TreeListModule } from '@progress/kendo-angular-treelist';
  *
- * // Import the app component
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
  * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, TreeListModule], // import TreeList module
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, TreeListModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 class TreeListModule {
@@ -20006,29 +19972,18 @@ const declarations$1 = [
  *
  * @example
  *
- * ```ts-no-run
- * // Import the TreeList and PDF modules
- * import { TreeListModule, PDFModule } from '@progress/kendo-angular-treelist';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```ts
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
+ * import { BrowserModule } from "@angular/platform-browser";
+ * import { TreeListModule, PDFModule } from '@progress/kendo-angular-treelist';
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
  * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, TreeListModule, PDFModule], // import TreeList and PDF modules
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, TreeListModule, PDFModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 class PDFModule {
@@ -20052,7 +20007,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
         }] });
 
 /**
- * Arguments for the `excelExport` event.
+ * Arguments for the `excelExport` event. [See example](slug:excelexport_treelist#toc-customizing-generated-workbooks).
  */
 class ExcelExportEvent extends PreventableEvent {
     constructor(workbook) {
@@ -20346,30 +20301,18 @@ const declarations = [ExcelComponent, ExcelCommandDirective];
  * definition for the Excel component of the TreeList.
  *
  * @example
- *
- * ```ts-no-run
- * // Import the TreeList and Excel modules
- * import { TreeListModule, ExcelModule } from '@progress/kendo-angular-treelist';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```ts
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
+ * import { BrowserModule } from "@angular/platform-browser";
+ * import { TreeListModule, ExcelModule } from '@progress/kendo-angular-treelist';
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
  * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, TreeListModule, ExcelModule], // import TreeList and Excel modules
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, TreeListModule, ExcelModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 class ExcelModule {

package/fesm2020/progress-kendo-angular-treelist.mjs

@@ -46,8 +46,8 @@ const packageMetadata = {
     name: '@progress/kendo-angular-treelist',
     productName: 'Kendo UI for Angular',
     productCodes: ['KENDOUIANGULAR', 'KENDOUICOMPLETE'],
-    publishDate: 1683201191,
-    version: '12.0.2-develop.1',
+    publishDate: 1683884362,
+    version: '12.0.2-develop.3',
     licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
 };
 
@@ -289,8 +289,8 @@ class ColumnBase {
         this.matchesMedia = true;
         /**
          * The column index after reordering.
-         *
-         * > `orderIndex` is a read-only property. Setting this field does not affect column order.
+         * The orderIndex` is a read-only property. Setting this field does not affect column order.
+         * @default 0
          */
         this.orderIndex = 0;
         /**
@@ -313,19 +313,23 @@ class ColumnBase {
         this.reorderable = true;
         /**
          * The width (in pixels) below which the user is not able to resize the column by using the UI.
+         * @default 10
          */
         this.minResizableWidth = 10;
         this._locked = false;
         /**
          * Specifies if the column can be locked or unlocked from the column menu or by reordering the columns.
+         * @default true
          */
         this.lockable = true;
         /**
          * Specifies if the column menu will be shown for the column.
+         * @default true
          */
         this.columnMenu = true;
         /**
          * Specifies if the column will be included in the column-chooser list.
+         * @default true
          */
         this.includeInChooser = true;
         /**
@@ -360,48 +364,9 @@ class ColumnBase {
     }
     get width() { return this._width; }
     /**
-     * Toggles the locked (frozen) state of the columns ([more information and example]({% slug locked_columns_treelist %})).
+     * Toggles the locked (frozen) state of the columns ([more information and example](slug:locked_columns_treelist)).
      *
      * @default false
-     *
-     * @example
-     * ```ts
-     * _@Component({
-     *    selector: 'my-app',
-     *    template: `
-     *        <kendo-treelist [data]="treelistData" [scrollable]="scrollable" style="height: 200px">
-     *          <kendo-treelist-column field="ProductID" title="Product ID" [width]="120" [locked]="true">
-     *          </kendo-treelist-column>
-     *          <kendo-treelist-column field="ProductName" title="Product Name" [width]="200">
-     *          </kendo-treelist-column>
-     *          <kendo-treelist-column field="UnitPrice" title="Unit Price" [width]="230">
-     *          </kendo-treelist-column>
-     *        </kendo-treelist>
-     *    `
-     * })
-     *
-     * class AppComponent {
-     *    public treelistData: any[];
-     *
-     *    constructor() {
-     *        this.treelistData = products;
-     *    }
-     * }
-     *
-     * const products = [{
-     *    "ProductID": 1,
-     *    "ProductName": "Chai",
-     *    "UnitPrice": 18.0000,
-     *    "Discontinued": true
-     *  }, {
-     *    "ProductID": 2,
-     *    "ProductName": "Chang",
-     *    "UnitPrice": 19.0000,
-     *    "Discontinued": false
-     *  }
-     * ];
-     *
-     * ```
      */
     set locked(value) {
         this._locked = value;
@@ -2881,6 +2846,9 @@ const contains$1 = (node, predicate) => {
  * Arguments for the `close` event of the filter and column-menu popup.
  */
 class PopupCloseEvent extends PreventableEvent {
+    /**
+     * @hidden
+     */
     constructor(e) {
         super();
         this.originalEvent = e;
@@ -2892,6 +2860,9 @@ const DEFAULT_POPUP_CLASS = 'k-grid-filter-popup';
  * ([see example]({% slug reusablecustomfilters_treelist %}#toc-filter-menu-with-popup)).
  */
 class SinglePopupService {
+    /**
+     * @hidden
+     */
     constructor(popupService, renderer, ngZone, scrollSyncService, localization) {
         this.popupService = popupService;
         this.renderer = renderer;
@@ -7318,12 +7289,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
  * Represents the service that is passed to the
  * [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
  *
- * {% meta height:500 %}
- * {% embed_file column-menu/template-item/app.component.ts preview %}
- * {% embed_file column-menu/template-item/app.module.ts %}
- * {% embed_file shared/main.ts %}
- * {% embed_file shared/employees.ts %}
- * {% endmeta %}
+ * @example
+ * ```html
+ * <kendo-treelist>
+ *   <ng-template
+ *     kendoTreeListColumnMenuTemplate
+ *     let-service="service"
+ *     let-column="column">
+ *     <kendo-treelist-columnmenu-sort [service]="service">
+ *   </ng-template>
+ * </kendo-treelist>
+ * ```
  */
 class ColumnMenuService {
     constructor() {
@@ -19352,29 +19328,19 @@ const declarations$2 = [
  *
  * @example
  *
- * ```ts-no-run
- * // Import the TreeList module
- * import { TreeListModule } from '@progress/kendo-angular-treelist';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```ts
  * import { NgModule } from '@angular/core';
+ * import { BrowserModule } from "@angular/platform-browser";
+ * import { TreeListModule } from '@progress/kendo-angular-treelist';
  *
- * // Import the app component
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
  * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, TreeListModule], // import TreeList module
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, TreeListModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 class TreeListModule {
@@ -19955,29 +19921,18 @@ const declarations$1 = [
  *
  * @example
  *
- * ```ts-no-run
- * // Import the TreeList and PDF modules
- * import { TreeListModule, PDFModule } from '@progress/kendo-angular-treelist';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```ts
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
+ * import { BrowserModule } from "@angular/platform-browser";
+ * import { TreeListModule, PDFModule } from '@progress/kendo-angular-treelist';
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
  * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, TreeListModule, PDFModule], // import TreeList and PDF modules
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, TreeListModule, PDFModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 class PDFModule {
@@ -20001,7 +19956,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.12", ngImpo
         }] });
 
 /**
- * Arguments for the `excelExport` event.
+ * Arguments for the `excelExport` event. [See example](slug:excelexport_treelist#toc-customizing-generated-workbooks).
  */
 class ExcelExportEvent extends PreventableEvent {
     constructor(workbook) {
@@ -20295,30 +20250,18 @@ const declarations = [ExcelComponent, ExcelCommandDirective];
  * definition for the Excel component of the TreeList.
  *
  * @example
- *
- * ```ts-no-run
- * // Import the TreeList and Excel modules
- * import { TreeListModule, ExcelModule } from '@progress/kendo-angular-treelist';
- *
- * // The browser platform with a compiler
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
- *
+ * ```ts
  * import { NgModule } from '@angular/core';
- *
- * // Import the app component
+ * import { BrowserModule } from "@angular/platform-browser";
+ * import { TreeListModule, ExcelModule } from '@progress/kendo-angular-treelist';
  * import { AppComponent } from './app.component';
  *
- * // Define the app module
  * _@NgModule({
- *     declarations: [AppComponent], // declare app component
- *     imports:      [BrowserModule, TreeListModule, ExcelModule], // import TreeList and Excel modules
+ *     declarations: [AppComponent],
+ *     imports:      [BrowserModule, TreeListModule, ExcelModule],
  *     bootstrap:    [AppComponent]
  * })
  * export class AppModule {}
- *
- * // Compile and launch the module
- * platformBrowserDynamic().bootstrapModule(AppModule);
- *
  * ```
  */
 class ExcelModule {

package/filtering/filterable.d.ts

@@ -4,6 +4,15 @@
 *-------------------------------------------------------------------------------------------*/
 /**
  * Represents the options for the `filterable` setting of the TreeList.
+ * The available values are:
+ * - `row`—Displays a filter row in Grid.
+ * - `menu`—Displays a filter menu in Grid.
+ * - `menu, row`—Displays filter menu with filter row.
+ *
+ * @example
+ * ```html
+ * <kendo-treelist filterable="menu, row"></kendo-treelist>
+ * ```
  */
 export declare type FilterableSettings = boolean | 'row' | 'menu' | 'menu, row';
 /**