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

package/esm2022/pdf/pdf.module.mjs

@@ -14,8 +14,8 @@ import * as i5 from "./pdf-command-tool.directive";
 import * as i6 from "@progress/kendo-angular-icons";
 // IMPORTANT: NgModule export kept for backwards compatibility
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the TreeList PDF component.
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the TreeList PDF component.
+ * Use this module to enable PDF export features of the TreeList inside NgModule-based Angular application.
  *
  * @example
  *
@@ -25,10 +25,10 @@ import * as i6 from "@progress/kendo-angular-icons";
  * import { TreeListModule, PDFModule } from '@progress/kendo-angular-treelist';
  * import { AppComponent } from './app.component';
  *
- * _@NgModule({
- *     declarations: [AppComponent],
- *     imports:      [BrowserModule, TreeListModule, PDFModule],
- *     bootstrap:    [AppComponent]
+ * @NgModule({
+ *   declarations: [AppComponent],
+ *   imports: [BrowserModule, TreeListModule, PDFModule],
+ *   bootstrap: [AppComponent]
  * })
  * export class AppModule {}
  * ```

package/esm2022/rendering/cell-template.directive.mjs

@@ -6,19 +6,18 @@ import { Directive, TemplateRef, Optional } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
  * Represents the column cell template of the TreeList ([more information and example]({% slug templates_columns_treelist %}#toc-cell-template)).
- * Helps to customize the content of the cells. To define the cell template, nest an `<ng-template>` tag
- * with the `kendoTreeListCellTemplate` directive inside a `<kendo-treelist-column>` tag.
+ * Use this directive to customize the content of the cells. To define the cell template, nest an `<ng-template>` tag with the `kendoTreeListCellTemplate` directive inside a `<kendo-treelist-column>` tag.
  *
- * The template context is set to the current data item and the following additional fields are passed:
- * - `columnIndex`&mdash;The current column index. Use it as an alias for a template variable by utilizing the `let-columnIndex="columnIndex"` syntax.
- * - `column`&mdash;The current column instance. Use it as an alias for a template variable by utilizing the `let-column="column"` syntax.
- * - `dataItem`&mdash;The current data item. Represents the default context that will be assigned to any template variable which utilizes the `let-x` syntax&mdash;for example, `let-dataItem`.
- * - `cellContext`&mdash;An object used to pass context information to built-in directives.
+ * The template context is set to the current data item and provides the following fields:
+ * - `columnIndex`&mdash;The current column index. Use as an alias for a template variable with `let-columnIndex="columnIndex"`.
+ * - `column`&mdash;The current column instance. Use as an alias for a template variable with `let-column="column"`.
+ * - `dataItem`&mdash;The current data item. Represents the default context for any template variable using `let-x` syntax, for example, `let-dataItem`.
+ * - `cellContext`&mdash;An object for passing context information to built-in directives.
  * - `hasChildren`&mdash;Specifies if the item has children.
  * - `isExpanded`&mdash;Specifies if the item is expanded.
  * - `level`&mdash;The hierarchy level of the item.
  * - `loading`&mdash;Specifies if the item children are currently loading.
- * - `rowIndex`&mdash;The current row index. Use it as an alias for a template variable by utilizing the `let-rowIndex="rowIndex"` syntax.
+ * - `rowIndex`&mdash;The current row index. Use it as an alias for a template variable with `let-rowIndex="rowIndex"`.
  *
  * @example
  * ```html
@@ -29,7 +28,7 @@ import * as i0 from "@angular/core";
  *     </ng-template>
  *   </kendo-treelist-column>
  * </kendo-treelist>
- *```
+ * ```
  */
 export class CellTemplateDirective {
     templateRef;

package/esm2022/rendering/common/spacer.component.mjs

@@ -7,9 +7,20 @@ import { isPresent } from '../../utils';
 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. [See example](slug:toolbartemplate_treelist#toc-defining-the-spacing-between-toolbar-elements).
+ * Use this component to add extra white space between Pager inner elements or to customize the spacer width.
+ * You can also use it in any flex container within the TreeList. [See example](slug:toolbartemplate_treelist#toc-defining-the-spacing-between-toolbar-elements).
+ *
+ * @example
+ * ```html
+ * <kendo-treelist [data]="data" [fetchChildren]="fetchChildren" [hasChildren]="hasChildren">
+ *   <ng-template kendoTreeListToolbarTemplate>
+ *     <kendo-treelist-spacer></kendo-treelist-spacer>
+ *       <button type="button" kendoTreeListExcelCommand [svgIcon]="fileExcelIcon"> Export to Excel </button>
+ *     <kendo-treelist-spacer></kendo-treelist-spacer>
+ *   </ng-template>
+ *   <kendo-treelist-column field="ProductName" title="Product Name"></kendo-treelist-column>
+ * </kendo-treelist>
+ * ```
  */
 export class TreeListSpacerComponent {
     hostClass = true;
@@ -21,9 +32,9 @@ export class TreeListSpacerComponent {
     }
     /**
      * Specifies the width of the TreeListSpacer.
-     * Accepts the [string values of the CSS `flex-basis` property](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-basis).
+     * Accepts string values for the [CSS `flex-basis` property](https://developer.mozilla.org/en-US/docs/Web/CSS/flex-basis).
      *
-     * If not set, the TreeListSpacer will take all the available space.
+     * If not set, the TreeListSpacer takes all available space.
      */
     width;
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: TreeListSpacerComponent, deps: [], target: i0.ɵɵFactoryTarget.Component });

package/esm2022/rendering/footer-template.directive.mjs

@@ -5,19 +5,17 @@
 import { Directive, TemplateRef, Optional } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the column footer cell template of the TreeList
- * ([more information and example]({% slug templates_columns_treelist %}#toc-footer-template)).
- * Helps to customize the table footer cell for the column.
- * To define a footer template, nest an `<ng-template>` tag with the
- * `kendoTreeListFooterTemplate` directive inside the `<kendo-treelist-column>` tag.
+ * Represents the column footer cell template of the TreeList ([more information and example]({% slug templates_columns_treelist %}#toc-footer-template)).
+ * Use this directive to customize the table footer cell for the column.
+ * To define a footer template, nest an `<ng-template>` tag with the `kendoTreeListFooterTemplate` directive inside the `<kendo-treelist-column>` tag.
  *
- * The template context is set to the aggregate values and the following additional fields are passed:
- * * `aggregates`&mdash;The aggregates for the level items.
- * * `column`&mdash;Defines an instance of the [`ColumnComponent`]({% slug api_treelist_columncomponent %}) option.
- * * `columnIndex`&mdash;Defines the current column index.
- * * `field`&mdash;The name of the column field, if set.
- * * `items`&mdash;The data items on this level.
- * * `parentItem`&mdash;The parent data item; `null` for root level items.
+ * The template context is set to the aggregate values and provides the following fields:
+ * - `aggregates`&mdash;The aggregates for the level items.
+ * - `column`&mdash;Defines an instance of the [`ColumnComponent`]({% slug api_treelist_columncomponent %}) option.
+ * - `columnIndex`&mdash;Defines the current column index.
+ * - `field`&mdash;The name of the column field, if set.
+ * - `items`&mdash;The data items on this level.
+ * - `parentItem`&mdash;The parent data item; `null` for root level items.
  *
  * @example
  * ```html

package/esm2022/rendering/header/header-template.directive.mjs

@@ -7,13 +7,13 @@ import * as i0 from "@angular/core";
 /**
  * Represents the column header cell template of the TreeList
  * ([more information and example]({% slug templates_columns_treelist %}#toc-header-template)).
- * Helps to customize the table header cell for the column.
+ * Use this directive to customize the table header cell for the column.
  * To define a header template, nest an `<ng-template>` tag with the
  * [`kendoTreeListHeaderTemplate`]({% slug api_treelist_headertemplatedirective %}) directive inside the `<kendo-treelist-column>` tag.
  *
- *  The template context is set to the current column and then the following additional fields are passed:
- * * `column`&mdash;Defines an instance of the [`ColumnComponent`]({% slug api_treelist_columncomponent %}) option.
- * * `columnIndex`&mdash;Defines the current column index.
+ * The template context is set to the current column and provides the following fields:
+ * - `column`&mdash;Defines an instance of the [`ColumnComponent`]({% slug api_treelist_columncomponent %}) option.
+ * - `columnIndex`&mdash;Defines the current column index.
  *
  * @example
  * ```html

package/esm2022/rendering/no-records-template.directive.mjs

@@ -5,7 +5,7 @@
 import { Directive, TemplateRef, Optional } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the no-records template of the TreeList ([see example](slug:norecordtemplate_treelist)). Provides an option to customize the
+ * Represents the no-records template of the TreeList ([see example](slug:norecordtemplate_treelist)). Use this directive to customize the
  * appearance of the item that is displayed when no data is present. To define the no-records template,
  * nest an `<ng-template>` tag with the `kendoTreeListNoRecordsTemplate` directive inside `<kendo-treelist>`.
  *
@@ -14,7 +14,7 @@ import * as i0 from "@angular/core";
  * @example
  * ```html
  * <kendo-treelist ... >
- *   <kendo-treelist-column field="name" ></kendo-treelist-column>
+ *   <kendo-treelist-column field="name"></kendo-treelist-column>
  *   <ng-template kendoTreeListNoRecordsTemplate>
  *     No data loaded.
  *   </ng-template>

package/esm2022/rendering/toolbar/toolbar-focusable.directive.mjs

@@ -8,8 +8,19 @@ import { ContextService } from '../../common/provider.service';
 import * as i0 from "@angular/core";
 import * as i1 from "../../common/provider.service";
 /**
- * A directive applied to all toolbar elements that need to be a part of the TreeList
- * keyboard navigation.
+ * A directive for toolbar elements that need to be part of TreeList keyboard navigation.
+ * Use this directive to make toolbar elements focusable and accessible with the keyboard.
+ *
+ * @example
+ * ```html
+ * <kendo-treelist>
+ *     <kendo-toolbar>
+ *         <button kendoTreeListToolbarFocusable>Custom Button</button>
+ *         <button kendoTreeListCancelCommand>Cancel</button>
+ *         <button kendoTreeListEditCommand>Edit</button>
+ *     </kendo-toolbar>
+ * </kendo-treelist>
+ * ```
  */
 export class TreeListToolbarFocusableDirective {
     host;

package/esm2022/rendering/toolbar/toolbar-template.directive.mjs

@@ -10,15 +10,13 @@ import * as i1 from "../../common/option-changes.service";
  * Represents the toolbar template of the TreeList ([see example](slug:toolbartemplate_treelist)).
  *
  * The template context has the following field:
- * - `position`—The position at which the toolbar template is rendered. The possible values are `top`, `bottom` and `both`.
+ * - `position`—The position at which the toolbar template is rendered. The possible values are `top`, `bottom`, and `both`.
  *
  * @example
  * ```html
  * <kendo-treelist ...>
  *   <ng-template kendoTreeListToolbarTemplate>
- *     <button kendoTreeListExcelCommand >
- *       Export to Excel
- *     </button>
+ *     <button kendoTreeListExcelCommand>Export to Excel</button>
  *   </ng-template>
  * </kendo-treelist>
  * ```
@@ -28,8 +26,8 @@ export class ToolbarTemplateDirective {
     optionChanges;
     _position = "top";
     /**
-     * The position of the toolbar ([see example](slug:toolbartemplate_treelist#toc-setting-the-toolbar-position)).
-     * The group panel or header and the second one below the pager.
+     * Sets the position of the toolbar. The value can be `top`, `bottom`, or `both`.
+     * Controls whether the toolbar appears above, below, or on both sides of the TreeList. [See example.](slug:toolbartemplate_treelist#toc-setting-the-toolbar-position)
      * @default 'top'
      */
     set position(position) {

package/esm2022/selection/selectable.directive.mjs

@@ -14,6 +14,18 @@ import * as i2 from "./selection.service";
 const defaultColumnKeyGetter = (_column, columnIndex) => columnIndex;
 /**
  * A directive which controls the selection state. [See example](slug:selection_treelist).
+ *
+ * @example
+ * ```html
+ * <kendo-treelist
+ *   [kendoTreeListSelectable]="{ mode: 'row' }"
+ *   [selectedItems]="selectedItems">
+ *     <kendo-treelist-column field="name" title="Name"></kendo-treelist-column>
+ *     <kendo-treelist-column field="age" title="Age"></kendo-treelist-column>
+ * </kendo-treelist>
+ * ```
+ * @remarks
+ * Applied to: {@link TreeListComponent}.
  */
 export class SelectableDirective {
     treelist;

package/esm2022/selection/selection-change-event.mjs

@@ -7,7 +7,7 @@
  */
 export class SelectionChangeEvent {
     /**
-     * Specifies how was the selection changed
+     * Specifies how the selection was changed.
      */
     action;
     /**