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

package/esm2022/treelist.module.mjs

@@ -120,22 +120,20 @@ import * as i104 from "@progress/kendo-angular-toolbar";
 import * as i105 from "@progress/kendo-angular-pager";
 // IMPORTANT: NgModule export kept for backwards compatibility
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the TreeList component.
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the TreeList component.
+ * Use this module to enable TreeList features in your application.
  *
  * @example
- *
  * ```ts
  * import { NgModule } from '@angular/core';
  * import { BrowserModule } from "@angular/platform-browser";
  * import { TreeListModule } from '@progress/kendo-angular-treelist';
- *
  * import { AppComponent } from './app.component';
  *
- * _@NgModule({
- *     declarations: [AppComponent],
- *     imports:      [BrowserModule, TreeListModule],
- *     bootstrap:    [AppComponent]
+ * @NgModule({
+ *   declarations: [AppComponent],
+ *   imports: [BrowserModule, TreeListModule],
+ *   bootstrap: [AppComponent]
  * })
  * export class AppModule {}
  * ```

package/esm2022/utils.mjs

@@ -114,4 +114,4 @@ export const isColumnEditable = (column, formGroup) => column.isEditable !== fal
 /**
  * @hidden
  */
-export const replaceMessagePlaceholder = (message, name, value) => message.replace(new RegExp(`\{\\s*${name}\\s*\}`, 'g'), value);
+export const replaceMessagePlaceholder = (message, name, value) => message.replace(new RegExp(`{\\s*${name}\\s*}`, 'g'), value);

package/excel/excel-command-tool.directive.d.ts

@@ -6,24 +6,22 @@ import { ToolBarButtonComponent } from '@progress/kendo-angular-toolbar';
 import { ExcelService } from './excel.service';
 import * as i0 from "@angular/core";
 /**
- * Represents the `export-to-Excel` toolbar tool of the TreeList.
- * You can apply this directive to any `kendo-toolbar-button` element inside a
- * ToolbarComponent used in the TreeList.
+ * Represents the `export-to-Excel` toolbar tool of the TreeList. Apply this directive to any `kendo-toolbar-button` element inside a ToolbarComponent used in the TreeList.
  *
- * When the user clicks a button associated with the directive, the
- * [excelExport]({% slug api_treelist_treelistcomponent %}#toc-excelexport) event
- * fires ([see example]({% slug excelexport_treelist %})).
+ * When the user clicks a button with this directive, the [excelExport]({% slug api_treelist_treelistcomponent %}#toc-excelexport) event fires ([see example]({% slug excelexport_treelist %})).
  *
  * @example
- * ```html-no-run
+ * ```html
  * <kendo-treelist>
- *      <kendo-toolbar>
+ *     <kendo-toolbar>
  *         <kendo-toolbar-button text="Excel Export" kendoTreeListExcelTool></kendo-toolbar-button>
- *      </kendo-toolbar>
- *      <kendo-treelist-excel fileName="TreeList.xlsx">
- *      </kendo-treelist-excel>
+ *     </kendo-toolbar>
+ *     <kendo-treelist-excel fileName="TreeList.xlsx">
+ *     </kendo-treelist-excel>
  * </kendo-treelist>
  * ```
+ * @remarks
+ * Applied to: {@link ToolBarButtonComponent}
  */
 export declare class ExcelCommandToolbarDirective {
     private excelService;

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

@@ -8,18 +8,14 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { ExcelService } from './excel.service';
 import * as i0 from "@angular/core";
 /**
- * Represents the `export-to-Excel` command of the TreeList. You can apply this
- * directive to any `button` element inside a
- * [`ToolbarTemplate`](slug:toolbartemplate_treelist).
- * When the user clicks a button associated with the directive, the
- * [`excelExport`]({% slug api_treelist_treelistcomponent %}#toc-excelexport) event
- * fires ([see example]({% slug excelexport_treelist %})).
+ * Represents the `export-to-Excel` command of the TreeList. Apply this directive to any `button` element inside a [`ToolbarTemplate`](slug:toolbartemplate_treelist).
+ * When the user clicks a button with this directive, the [`excelExport`]({% slug api_treelist_treelistcomponent %}#toc-excelexport) event fires ([see example]({% slug excelexport_treelist %})).
  *
  * @example
  * ```html
  * <kendo-treelist ...>
  *   <ng-template kendoTreeListToolbarTemplate>
- *     <button kendoTreeListExcelCommand>Export to PDF</button>
+ *     <button kendoTreeListExcelCommand>Export to Excel</button>
  *   </ng-template>
  *   <kendo-treelist-excel fileName="TreeList.xlsx"> </kendo-treelist-excel>
  * </kendo-treelist>

package/excel/excel-export-data.interface.d.ts

@@ -4,19 +4,19 @@
 *-------------------------------------------------------------------------------------------*/
 import { Observable } from "rxjs";
 /**
- * The expected type of result for the treelist excel export [`fetchData function`](slug:api_treelist_excelcomponent#toc-fetchdata).
+ * The expected type of result for the TreeList Excel export [`fetchData` function](slug:api_treelist_excelcomponent#toc-fetchdata).
  */
 export interface ExcelExportData {
     /**
-     * The root data that should be exported.
+     * The root data to export.
      */
     data: any[] | Observable<any[]>;
     /**
-     * A function that returns the children for an item.
+     * Returns the children for an item.
      */
     fetchChildren: any;
     /**
-     * A function that indicates if a particular item has children.
+     * Indicates if a particular item has children.
      */
     hasChildren: any;
 }

package/excel/excel.component.d.ts

@@ -10,7 +10,14 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { ExcelExportData } from './excel-export-data.interface';
 import * as i0 from "@angular/core";
 /**
- * Configures the settings for the export of TreeList in Excel ([see example]({% slug excelexport_treelist %})).
+ * Configures the settings for exporting the TreeList to Excel. [See example]({% slug excelexport_treelist %}).
+ *
+ * @example
+ * ```html
+ * <kendo-treelist [data]="data" [height]="500">
+ *    <kendo-treelist-excel fileName="Employees.xlsx"></kendo-treelist-excel>
+ * </kendo-treelist>
+ * ```
  */
 export declare class ExcelComponent implements OnDestroy {
     private excelService;
@@ -22,57 +29,56 @@ export declare class ExcelComponent implements OnDestroy {
      */
     fileName: string;
     /**
-     * Enables or disables column filtering in the Excel file. This behavior is different from the filtering feature of the TreeList.
+     * Enables or disables column filtering in the Excel file. This is different from the TreeList filtering feature.
      */
     filterable: boolean;
     /**
-     * The author of the workbook.
+     * Sets the author of the workbook.
      */
     creator?: string;
     /**
-     * The date on which the workbook was created. Defaults to `new Date()`.
+     * Sets the date the workbook was created. Defaults to `new Date()`.
      */
     date?: Date;
     /**
-     * If set to `true`, the content is forwarded to `proxyURL` even if the browser supports the saving of files locally.
+     * If set to `true`, forwards the content to `proxyURL` even if the browser supports saving files locally.
      */
     forceProxy: boolean;
     /**
-     * The URL of the server-side proxy which streams the file to the end user.
-     * Using a proxy is required if the browser is not capable of saving files locally.
+     * The URL of the server-side proxy that streams the file to the user.
+     * Use a proxy if the browser cannot save files locally.
      *
      * Optionally, set up a proxy to reduce memory usage. This avoids copying the file contents into memory,
      * but transmits it over the network instead. For this use case, set [forceProxy](#toc-forceproxy) to `true`
      * to skip client-side saving even in browsers that support it.
      *
-     * In the request body, the proxy receives a POST request with the specific parameters. [See example](slug:server_proxy#toc-implementations).
+     * The proxy receives a POST request with specific parameters in the request body. [See example](slug:server_proxy#toc-implementations).
      * The proxy returns the decoded file with the `"Content-Disposition"` header set to `attachment; filename="<fileName.xslx>"`.
      *
-     * For details on the server-side proxy usage and implementation, see the [File Saver]({% slug overview_filesaver %}) documentation.
-     *
+     * For details on server-side proxy usage and implementation, see the [File Saver]({% slug overview_filesaver %}) documentation.
      */
     proxyURL: string;
     /**
-     * The function that is used to get the exported data options. By default, uses the current data of the TreeList.
-     * To export data that is different from the current TreeList data, provide a custom function.
+     * The function used to get the exported data options. By default, uses the current TreeList data.
+     * To export data different from the current TreeList data, provide a custom function.
      */
     fetchData: (component: TreeListComponent) => ExcelExportData;
     /**
-     * Specifies if the item levels in the Excel file are collapsible. Applicable only if the treelist has footers.
+     * Specifies if item levels in the Excel file are collapsible. Applies only if the TreeList has footers.
      */
     collapsible: boolean;
     /**
-     * Specifies if export should include all pages
+     * Specifies if export should include all pages.
      * @default true
      */
     allPages: boolean;
     /**
-     * Specifies if the export should expand all items or should use the current TreeList state.
+     * Specifies if the export should expand all items or use the current TreeList state.
      * @default true
      */
     expandAll: boolean;
     /**
-     * The options of the cells that are inserted before the data to indicate the hierarchy.
+     * The options for the cells inserted before the data to indicate the hierarchy.
      */
     paddingCellOptions: CellOptions;
     /**

package/excel/excel.module.d.ts

@@ -8,7 +8,7 @@ import * as i2 from "./excel-command.directive";
 import * as i3 from "./excel-command-tool.directive";
 import * as i4 from "@progress/kendo-angular-excel-export";
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi'])
  * definition for the Excel component of the TreeList.
  *
  * @example
@@ -18,7 +18,7 @@ import * as i4 from "@progress/kendo-angular-excel-export";
  * import { TreeListModule, ExcelModule } from '@progress/kendo-angular-treelist';
  * import { AppComponent } from './app.component';
  *
- * _@NgModule({
+ * @NgModule({
  *     declarations: [AppComponent],
  *     imports:      [BrowserModule, TreeListModule, ExcelModule],
  *     bootstrap:    [AppComponent]

package/expand-state/expand-event.d.ts

@@ -5,15 +5,15 @@
 import type { TreeListComponent } from '../treelist.component';
 import { PreventableEvent } from '../common/preventable-event';
 /**
- * Arguments for the TreeList expand and collapse events ([see examples]({% slug treelist_expanded_state %})).
+ * Arguments for the TreeList expand and collapse events. [See example]({% slug treelist_expanded_state %}).
  */
 export declare class ExpandEvent extends PreventableEvent {
     /**
-     * The expanded/collapsed data item.
+     * The expanded or collapsed data item.
      */
     dataItem: any;
     /**
-     * The TreeList component that triggered the event.
+     * The TreeList component that triggers the event.
      */
     sender: TreeListComponent;
     /**

package/expand-state/expandable-tree-component.d.ts

@@ -11,11 +11,11 @@ import * as i0 from "@angular/core";
  */
 export declare abstract class ExpandableTreeComponent {
     /**
-     * Extracts the id value if an idField is set.
+     * Extracts the id value when `idField` is set.
      */
     abstract idGetter: any;
     /**
-     * Emits when the expand or collapse events are fired.
+     * Emits when expand or collapse events occur.
      */
     abstract expandStateChange: EventEmitter<any>;
     /**
@@ -23,10 +23,8 @@ export declare abstract class ExpandableTreeComponent {
      */
     abstract isExpanded(node: any): boolean;
     /**
-     * Updates the state of the current TreeList view without reloading the data.
-     *
-     * Checks all currently rendered items for changes and
-     * triggers re-evaluation of the the `isExpanded` and `isSelected` callbacks.
+     * Updates the state of the current TreeList view without reloading data.
+     * Checks all rendered items for changes and triggers re-evaluation of the `isExpanded` and `isSelected` callbacks.
      */
     abstract updateView(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ExpandableTreeComponent, never>;

package/expand-state/expandable.directive.d.ts

@@ -6,7 +6,7 @@ import { OnDestroy, EventEmitter } from '@angular/core';
 import { ExpandableTreeComponent } from './expandable-tree-component';
 import * as i0 from "@angular/core";
 /**
- * A directive which controls the expanded state of the items. [See example](slug:treelist_expanded_state#toc-built-in-directive).
+ * A directive which controls the expanded state of items in the TreeList. [See example](slug:treelist_expanded_state#toc-built-in-directive).
  *
  * @example
  * ```html
@@ -15,26 +15,29 @@ import * as i0 from "@angular/core";
  *   kendoTreeListExpandable> ...
  * </kendo-treelist>
  * ```
+ * @remarks
+ * Applied to: {@link TreeListComponent},
  */
 export declare class ExpandableDirective implements OnDestroy {
     private component;
     /**
-     * Fires when the expandedKeys are changed.
+     * Emits when the `expandedKeys` change.
      */
     expandedKeysChange: EventEmitter<any>;
     /**
      * Sets the expanded item keys.
+     * Use this property to control which items are expanded.
      */
     set expandedKeys(value: any[]);
     get expandedKeys(): any[];
     /**
-     * Specifies if the items should be initially expanded.
+     * Specifies if items are initially expanded.
      * @default false
      */
     initiallyExpanded: boolean;
     /**
-     * Defines the item key that will be stored in the expandedKeys collection.
-     * Defaults to the component idField.
+     * Defines the item key stored in the `expandedKeys` collection.
+     * Uses the component `idField` by default.
      */
     set expandBy(key: string | ((dataItem: any) => any));
     protected get keyGetter(): any;