@progress/kendo-angular-treelist 19.1.2-develop.3 → 19.1.2-develop.5

package/directives.d.ts

@@ -107,27 +107,27 @@ import { PDFCommandToolbarDirective } from './pdf/pdf-command-tool.directive';
 import { ColumnMenuItemDirective } from './column-menu/column-menu-item.directive';
 /**
  * @hidden
- * Utility array that contains the former Shared module exports
+ * Utility array that contains the former Shared module exports.
  */
 export declare const SHARED_EXPORTS: readonly [typeof ColumnComponent, typeof ColumnGroupComponent, typeof LogicalCellDirective, typeof LogicalRowDirective, typeof FocusableDirective, typeof ColGroupComponent, typeof ResizableContainerDirective, typeof TemplateContextDirective, typeof FieldAccessorPipe, typeof SpanColumnComponent, typeof LoadingComponent, typeof FilterCellOperatorsComponent, typeof CheckboxColumnComponent, typeof RowReorderColumnComponent];
 /**
  * @hidden
- * Utility array that contains the Body module exports
+ * Utility array that contains the Body module exports.
  */
 export declare const BODY_EXPORTS: readonly [typeof CommandColumnComponent, typeof CellTemplateDirective, typeof CellComponent, typeof NoRecordsTemplateDirective, typeof EditTemplateDirective, typeof EditCommandDirective, typeof CancelCommandDirective, typeof SaveCommandDirective, typeof RemoveCommandDirective, typeof AddCommandDirective, typeof AddCommandToolbarDirective, typeof FooterTemplateDirective];
 /**
  * @hidden
- * Utility array that contains the Header module exports
+ * Utility array that contains the Header module exports.
  */
 export declare const HEADER_EXPORTS: readonly [typeof HeaderComponent, typeof HeaderTemplateDirective, typeof ColumnHandleDirective];
 /**
  * @hidden
- * Utility array that contains the former SharedFilter module exports
+ * Utility array that contains the former SharedFilter module exports.
  */
 export declare const SHARED_FILTER_EXPORTS: readonly [typeof FilterCellOperatorsComponent, typeof ContainsFilterOperatorComponent, typeof DoesNotContainFilterOperatorComponent, typeof EndsWithFilterOperatorComponent, typeof EqualFilterOperatorComponent, typeof IsEmptyFilterOperatorComponent, typeof IsNotEmptyFilterOperatorComponent, typeof IsNotNullFilterOperatorComponent, typeof IsNullFilterOperatorComponent, typeof NotEqualFilterOperatorComponent, typeof StartsWithFilterOperatorComponent, typeof GreaterFilterOperatorComponent, typeof GreaterOrEqualToFilterOperatorComponent, typeof LessFilterOperatorComponent, typeof LessOrEqualToFilterOperatorComponent, typeof AfterFilterOperatorComponent, typeof AfterEqFilterOperatorComponent, typeof BeforeEqFilterOperatorComponent, typeof BeforeFilterOperatorComponent, typeof FilterInputDirective, typeof ColumnComponent, typeof ColumnGroupComponent, typeof LogicalCellDirective, typeof LogicalRowDirective, typeof FocusableDirective, typeof ColGroupComponent, typeof ResizableContainerDirective, typeof TemplateContextDirective, typeof FieldAccessorPipe, typeof SpanColumnComponent, typeof LoadingComponent, typeof FilterCellOperatorsComponent, typeof CheckboxColumnComponent, typeof RowReorderColumnComponent];
 /**
  * @hidden
- * Utility array that contains the former ColumnMenu module exports
+ * Utility array that contains the former ColumnMenu module exports.
  */
 export declare const ROW_FILTER_EXPORTS: readonly [typeof FilterRowComponent, typeof FilterCellComponent, typeof FilterCellTemplateDirective, typeof StringFilterCellComponent, typeof NumericFilterCellComponent, typeof AutoCompleteFilterCellComponent, typeof BooleanFilterCellComponent, typeof FilterCellHostDirective, typeof FilterCellWrapperComponent, typeof DateFilterCellComponent, typeof FilterCellOperatorsComponent, typeof ContainsFilterOperatorComponent, typeof DoesNotContainFilterOperatorComponent, typeof EndsWithFilterOperatorComponent, typeof EqualFilterOperatorComponent, typeof IsEmptyFilterOperatorComponent, typeof IsNotEmptyFilterOperatorComponent, typeof IsNotNullFilterOperatorComponent, typeof IsNullFilterOperatorComponent, typeof NotEqualFilterOperatorComponent, typeof StartsWithFilterOperatorComponent, typeof GreaterFilterOperatorComponent, typeof GreaterOrEqualToFilterOperatorComponent, typeof LessFilterOperatorComponent, typeof LessOrEqualToFilterOperatorComponent, typeof AfterFilterOperatorComponent, typeof AfterEqFilterOperatorComponent, typeof BeforeEqFilterOperatorComponent, typeof BeforeFilterOperatorComponent, typeof FilterInputDirective, typeof ColumnComponent, typeof ColumnGroupComponent, typeof LogicalCellDirective, typeof LogicalRowDirective, typeof FocusableDirective, typeof ColGroupComponent, typeof ResizableContainerDirective, typeof TemplateContextDirective, typeof FieldAccessorPipe, typeof SpanColumnComponent, typeof LoadingComponent, typeof FilterCellOperatorsComponent, typeof CheckboxColumnComponent, typeof RowReorderColumnComponent];
 /**
@@ -137,20 +137,21 @@ export declare const ROW_FILTER_EXPORTS: readonly [typeof FilterRowComponent, ty
 export declare const FILTER_MENU_EXPORTS: readonly [typeof FilterMenuComponent, typeof FilterMenuContainerComponent, typeof FilterMenuInputWrapperComponent, typeof StringFilterMenuInputComponent, typeof StringFilterMenuComponent, typeof FilterMenuTemplateDirective, typeof NumericFilterMenuComponent, typeof NumericFilterMenuInputComponent, typeof DateFilterMenuInputComponent, typeof DateFilterMenuComponent, typeof FilterMenuHostDirective, typeof BooleanFilterMenuComponent, typeof BooleanFilterRadioButtonDirective];
 /**
  * @hidden
- * Utility array that contains the former ColumnMenu module exports
+ * Utility array that contains the former ColumnMenu module exports.
  */
 export declare const COLUMN_MENU_EXPORTS: readonly [typeof ColumnChooserComponent, typeof ColumnMenuChooserComponent, typeof ColumnMenuFilterComponent, typeof ColumnMenuItemComponent, typeof ColumnMenuItemContentTemplateDirective, typeof ColumnMenuSortComponent, typeof ColumnMenuComponent, typeof ColumnMenuLockComponent, typeof ColumnMenuTemplateDirective, typeof ColumnMenuItemDirective];
 /**
  * @hidden
- * Utility array that contains the Excel module exports
+ * Utility array that contains the Excel module exports.
  */
 export declare const KENDO_TREELIST_EXCEL_EXPORT: readonly [typeof ExcelComponent, typeof ExcelCommandDirective, typeof ExcelCommandToolbarDirective, typeof ExcelColumnComponent, typeof ExcelColumnGroupComponent, typeof ExcelFooterTemplateDirective, typeof ExcelGroupFooterTemplateDirective, typeof ExcelGroupHeaderColumnTemplateDirective, typeof ExcelGroupHeaderTemplateDirective];
 /**
  * @hidden
- * Utility array that contains the PDF module exports
+ * Utility array that contains the PDF module exports.
  */
 export declare const KENDO_TREELIST_PDF_EXPORT: readonly [typeof PDFComponent, typeof PDFMarginComponent, typeof PDFCommandDirective, typeof PDFTemplateDirective, typeof PDFCommandToolbarDirective];
 /**
- * Utility array that contains all `@progress/kendo-angular-treelist` related components and directives
+ * Utility array that contains all `@progress/kendo-angular-treelist`-related components and directives.
+ * Use it to import all TreeList components and directives into a standalone Angular application.
  */
 export declare const KENDO_TREELIST: readonly [typeof TreeListComponent, typeof ToolbarTemplateDirective, typeof ToolbarComponent, typeof TreeListSpacerComponent, typeof CustomMessagesComponent, typeof TemplateEditingDirective, typeof ReactiveEditingDirective, typeof InCellEditingDirective, typeof HierarchyBindingDirective, typeof FlatBindingDirective, typeof ExpandableDirective, typeof SelectableDirective, typeof TreeListToolbarFocusableDirective, typeof ColumnComponent, typeof ColumnGroupComponent, typeof LogicalCellDirective, typeof LogicalRowDirective, typeof FocusableDirective, typeof ColGroupComponent, typeof ResizableContainerDirective, typeof TemplateContextDirective, typeof FieldAccessorPipe, typeof SpanColumnComponent, typeof LoadingComponent, typeof FilterCellOperatorsComponent, typeof CheckboxColumnComponent, typeof RowReorderColumnComponent, typeof CommandColumnComponent, typeof CellTemplateDirective, typeof CellComponent, typeof NoRecordsTemplateDirective, typeof EditTemplateDirective, typeof EditCommandDirective, typeof CancelCommandDirective, typeof SaveCommandDirective, typeof RemoveCommandDirective, typeof AddCommandDirective, typeof AddCommandToolbarDirective, typeof FooterTemplateDirective, typeof HeaderComponent, typeof HeaderTemplateDirective, typeof ColumnHandleDirective, typeof FilterRowComponent, typeof FilterCellComponent, typeof FilterCellTemplateDirective, typeof StringFilterCellComponent, typeof NumericFilterCellComponent, typeof AutoCompleteFilterCellComponent, typeof BooleanFilterCellComponent, typeof FilterCellHostDirective, typeof FilterCellWrapperComponent, typeof DateFilterCellComponent, typeof FilterCellOperatorsComponent, typeof ContainsFilterOperatorComponent, typeof DoesNotContainFilterOperatorComponent, typeof EndsWithFilterOperatorComponent, typeof EqualFilterOperatorComponent, typeof IsEmptyFilterOperatorComponent, typeof IsNotEmptyFilterOperatorComponent, typeof IsNotNullFilterOperatorComponent, typeof IsNullFilterOperatorComponent, typeof NotEqualFilterOperatorComponent, typeof StartsWithFilterOperatorComponent, typeof GreaterFilterOperatorComponent, typeof GreaterOrEqualToFilterOperatorComponent, typeof LessFilterOperatorComponent, typeof LessOrEqualToFilterOperatorComponent, typeof AfterFilterOperatorComponent, typeof AfterEqFilterOperatorComponent, typeof BeforeEqFilterOperatorComponent, typeof BeforeFilterOperatorComponent, typeof FilterInputDirective, typeof ColumnComponent, typeof ColumnGroupComponent, typeof LogicalCellDirective, typeof LogicalRowDirective, typeof FocusableDirective, typeof ColGroupComponent, typeof ResizableContainerDirective, typeof TemplateContextDirective, typeof FieldAccessorPipe, typeof SpanColumnComponent, typeof LoadingComponent, typeof FilterCellOperatorsComponent, typeof CheckboxColumnComponent, typeof RowReorderColumnComponent, typeof FilterMenuComponent, typeof FilterMenuContainerComponent, typeof FilterMenuInputWrapperComponent, typeof StringFilterMenuInputComponent, typeof StringFilterMenuComponent, typeof FilterMenuTemplateDirective, typeof NumericFilterMenuComponent, typeof NumericFilterMenuInputComponent, typeof DateFilterMenuInputComponent, typeof DateFilterMenuComponent, typeof FilterMenuHostDirective, typeof BooleanFilterMenuComponent, typeof BooleanFilterRadioButtonDirective, typeof ColumnChooserComponent, typeof ColumnMenuChooserComponent, typeof ColumnMenuFilterComponent, typeof ColumnMenuItemComponent, typeof ColumnMenuItemContentTemplateDirective, typeof ColumnMenuSortComponent, typeof ColumnMenuComponent, typeof ColumnMenuLockComponent, typeof ColumnMenuTemplateDirective, typeof ColumnMenuItemDirective, typeof ExcelComponent, typeof ExcelCommandDirective, typeof ExcelCommandToolbarDirective, typeof ExcelColumnComponent, typeof ExcelColumnGroupComponent, typeof ExcelFooterTemplateDirective, typeof ExcelGroupFooterTemplateDirective, typeof ExcelGroupHeaderColumnTemplateDirective, typeof ExcelGroupHeaderTemplateDirective, typeof PDFComponent, typeof PDFMarginComponent, typeof PDFCommandDirective, typeof PDFTemplateDirective, typeof PDFCommandToolbarDirective];

package/dragdrop/column-reorder-config.d.ts

@@ -3,11 +3,12 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Additional configuration for the [`reorderColumn`](slug:api_treelist_treelistcomponent#toc-reordercolumn) method.
+ * Provides additional configuration for the [`reorderColumn`](slug:api_treelist_treelistcomponent#toc-reordercolumn) method. Use this interface to control the position of the reordered column.
+ *
  */
 export interface ColumnReorderConfig {
     /**
-     * Indicates whether the reordered column will be positioned before or after the destination index.
+     * Indicates whether the reordered column is positioned before or after the destination index.
      */
     before: boolean;
 }

package/dragdrop/column-reorder-event.d.ts

@@ -5,21 +5,19 @@
 import { PreventableEvent } from '../common/preventable-event';
 import { ColumnBase } from '../columns/column-base';
 /**
- * Arguments for the `columnReorder` event.
+ * Provides arguments for the `columnReorder` event. Use this event to access the reordered column and its new and old indexes.
  */
 export declare class ColumnReorderEvent extends PreventableEvent {
     /**
-     * The reordered column.
+     * Specifies the reordered column.
      */
     readonly column: ColumnBase;
     /**
-     * The new index of the column.
-     * Relative to the collection of columns.
+     * The new index of the column, relative to the collection of columns.
      */
     readonly newIndex: number;
     /**
-     * The original index of the column before reordering.
-     * Relative to the collection of columns.
+     * The original index of the column before reordering, relative to the collection of columns.
      */
     readonly oldIndex: number;
     /**

package/editing/add-command-tool.directive.d.ts

@@ -6,21 +6,18 @@ import { EditService } from './edit.service';
 import { ToolBarButtonComponent } from '@progress/kendo-angular-toolbar';
 import * as i0 from "@angular/core";
 /**
- * Represents the command for adding a new item to the TreeList.
- * You can apply this directive to any `kendo-toolbar-button` element inside a
- * ToolbarComponent used in the TreeList.
- *
- * When the user clicks the toolbar button that is associated with the directive, the
- * [add]({% slug api_treelist_treelistcomponent %}#toc-add) event is triggered.
+ * Represents the command for adding a new item to the TreeList. Apply this directive to any `kendo-toolbar-button` element inside a ToolbarComponent. When the user clicks the toolbar button associated with the directive, the [`add`]({% slug api_treelist_treelistcomponent %}#toc-add) event is triggered.
  *
  * @example
- * ```html-no-run
- * <kendo-grid>
- *      <kendo-toolbar>
- *         <kendo-toolbar-button text="Add new" kendoTreeListAddTool></kendo-toolbar-button>
- *      </kendo-toolbar>
- * </kendo-grid>
+ * ```html
+ * <kendo-treelist>
+ *   <kendo-toolbar>
+ *     <kendo-toolbar-button text="Add new" kendoTreeListAddTool></kendo-toolbar-button>
+ *   </kendo-toolbar>
+ * </kendo-treelist>
  * ```
+ * @remarks
+ * Applied to: {@link ToolBarButtonComponent}
  */
 export declare class AddCommandToolbarDirective {
     private editService;

package/editing/add-command.directive.d.ts

@@ -8,17 +8,13 @@ import { EditService } from './edit.service';
 import { BaseCommandDirective } from './base-command.directive';
 import * as i0 from "@angular/core";
 /**
- * Represents the command for adding a new item to the TreeList. You can apply this directive to any
- * `button` element inside a [`ToolbarTemplate`](slug:toolbartemplate_treelist) or
- * inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
+ * Represents the command for adding a new item to the TreeList. Apply this directive to any `button` element inside a [`ToolbarTemplate`](slug:toolbartemplate_treelist) or inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
  *
- * When an associated button with the directive is clicked, the
- * [`add`]({% slug api_treelist_treelistcomponent %}#toc-add) event is triggered
- * ([see example](slug:custom_editors_editing_treelist)).
+ * When the user clicks a button with this directive, the [`add`]({% slug api_treelist_treelistcomponent %}#toc-add) event is triggered ([see example](slug:custom_editors_editing_treelist)).
  *
- * When the row is in the `edit mode`, the button with `kendoTreeListAddCommand` is automatically hidden.
+ * The button with `kendoTreeListAddCommand` is automatically hidden when the row is in edit mode.
  *
- * When added to the command column, the directive takes as input the `cellContext` from the cell template.
+ * When used in the command column, the directive takes the `cellContext` from the cell template as input.
  *
  * @example
  * ```html
@@ -33,7 +29,7 @@ import * as i0 from "@angular/core";
  */
 export declare class AddCommandDirective extends BaseCommandDirective {
     /**
-     * The `cellContext` provided to the template.
+     * Provides the `cellContext` to the template.
      */
     cellContext: any;
     commandClass: boolean;

package/editing/add-event-args.interface.d.ts

@@ -4,11 +4,12 @@
 *-------------------------------------------------------------------------------------------*/
 import { EditEvent } from "./edit-event-args.interface";
 /**
- * Arguments for the `add` event.
+ * Provides arguments for the `add` event. Use this interface to access the parent data item when adding a new row to the TreeList.
+ *
  */
 export interface AddEvent extends EditEvent {
     /**
-     * The data item of the parent row, if any.
+     * Specifies the data item of the parent row, if any.
      */
     parent: any;
 }

package/editing/cancel-command.directive.d.ts

@@ -8,14 +8,11 @@ import { EditService } from './edit.service';
 import { BaseCommandDirective } from './base-command.directive';
 import * as i0 from "@angular/core";
 /**
- * Represents the `cancel` command of the TreeList. You can apply this directive to any `button`
- * element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
- * When an associated button with the directive is clicked, the
- * [`cancel`]({% slug api_treelist_treelistcomponent %}#toc-cancel) event
- * is triggered ([see example](slug:custom_editors_editing_treelist)).
+ * Represents the `cancel` command of the TreeList. Apply this directive to any `button` element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
  *
- * When the row is not in the `edit` mode, the button with the `kendoTreeListCancelCommand` is automatically hidden.
- * The directive takes as input the `cellContext` from the cell template.
+ * When the user clicks a button with this directive, the [`cancel`]({% slug api_treelist_treelistcomponent %}#toc-cancel) event is triggered ([see example](slug:custom_editors_editing_treelist)).
+ *
+ * The button with `kendoTreeListCancelCommand` is automatically hidden when the row is not in edit mode. The directive takes the `cellContext` from the cell template as input.
  *
  * @example
  * ```html
@@ -30,7 +27,7 @@ import * as i0 from "@angular/core";
  */
 export declare class CancelCommandDirective extends BaseCommandDirective {
     /**
-     * The `cellContext` provided to the template.
+     * Provides the `cellContext` to the template.
      */
     cellContext: any;
     commandClass: boolean;

package/editing/cancel-event-args.interface.d.ts

@@ -4,6 +4,6 @@
 *-------------------------------------------------------------------------------------------*/
 import { SaveEvent } from "./save-event-args.interface";
 /**
- * Arguments for the `cancel` event. [See example](slug:editing_reactive_forms_treelist#toc-cancelling-editing).
+ * Provides arguments for the `cancel` event. Use this type to access the event data when cancelling editing in the TreeList. [See example](slug:editing_reactive_forms_treelist#toc-cancelling-editing).
  */
 export type CancelEvent = SaveEvent;

package/editing/cell-close-event.d.ts

@@ -6,7 +6,8 @@ import { PreventableEvent } from '../common/preventable-event';
 import { EditEvent } from "./edit-event-args.interface";
 import type { TreeListComponent } from "../treelist.component";
 /**
- * Arguments for the `cellClose` event.
+ * Provides arguments for the `cellClose` event.
+ *
  */
 export declare class CellCloseEvent extends PreventableEvent implements EditEvent {
     isNew: boolean;
@@ -17,16 +18,15 @@ export declare class CellCloseEvent extends PreventableEvent implements EditEven
      */
     action: string;
     /**
-     * The TreeList column that will be closed.
+     * Specifies the TreeList column that will be closed.
      */
     column: any;
     /**
-     * The [`FormGroup`](link:site.data.urls.angular['formgroupapi']) that is used to edit the cell which will be closed.
+     * Provides the [`FormGroup`](link:site.data.urls.angular['formgroupapi']) used to edit the cell that will be closed.
      */
     formGroup: any;
     /**
-     * The DOM event that caused the `cellClose` event.
-     * May not be present if `cellClose` was caused by an API call.
+     * Provides the DOM event that caused the `cellClose` event. May not be present if `cellClose` was caused by an API call.
      */
     originalEvent: any;
     constructor(options: any);

package/editing/edit-command.directive.d.ts

@@ -8,14 +8,11 @@ import { EditService } from './edit.service';
 import { BaseCommandDirective } from './base-command.directive';
 import * as i0 from "@angular/core";
 /**
- * Represents the `edit` command of the TreeList. You can apply this directive to any `button`
- * element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
- * When an associated button with the directive is clicked, the
- * [`edit`]({% slug api_treelist_treelistcomponent %}#toc-edit) event
- * is triggered ([see example](slug:custom_editors_editing_treelist)).
+ * Represents the `edit` command of the TreeList. Apply this directive to any `button` element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
  *
- * When the row is in the `edit` mode, the button with `kendoTreeListEditCommand` is automatically hidden.
- * The directive takes as input the `cellContext` from the cell template.
+ * When the user clicks a button with this directive, the [`edit`]({% slug api_treelist_treelistcomponent %}#toc-edit) event is triggered ([see example](slug:custom_editors_editing_treelist)).
+ *
+ * The button with `kendoTreeListEditCommand` is automatically hidden when the row is in edit mode. The directive takes the `cellContext` from the cell template as input.
  *
  * @example
  * ```html
@@ -27,11 +24,10 @@ import * as i0 from "@angular/core";
  *   </kendo-treelist-command-column>
  * </kendo-treelist>
  * ```
- *
  */
 export declare class EditCommandDirective extends BaseCommandDirective {
     /**
-     * The `cellContext` provided to the template.
+     * Provides the `cellContext` to the template.
      */
     cellContext: any;
     commandClass: boolean;

package/editing/edit-event-args.interface.d.ts

@@ -4,11 +4,12 @@
 *-------------------------------------------------------------------------------------------*/
 import type { TreeListComponent } from "../treelist.component";
 /**
- * Arguments for the [`edit`](slug:api_treelist_treelistcomponent#toc-edit) event.
+ * Provides arguments for the [`edit`](slug:api_treelist_treelistcomponent#toc-edit) event. Use this interface to access the data item, its state, and the TreeList component instance when editing a row.
+ *
  */
 export interface EditEvent {
     /**
-     * The data item.
+     * Specifies the data item.
      */
     dataItem: any;
     /**
@@ -16,7 +17,7 @@ export interface EditEvent {
      */
     isNew: boolean;
     /**
-     * The `TreeListComponent` instance.
+     * Provides the `TreeListComponent` instance.
      */
     sender: TreeListComponent;
 }

package/editing/edit-template.directive.d.ts

@@ -5,15 +5,13 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the column edit-cell template of the TreeList ([see example]({% slug editing_template_forms_treelist %})).
- * Helps to customize the content of the edited cells. To define the cell template, nest an `<ng-template>`
- * tag with the `kendoTreeListEditTemplate` directive inside a `<kendo-treelist-column>` tag.
+ * Represents the column edit-cell template of the TreeList ([see example](slug:editing_template_forms_treelist)). Use this directive to customize the content of edited cells. To define the cell template, nest an `<ng-template>` tag with the `kendoTreeListEditTemplate` directive inside a `<kendo-treelist-column>` tag.
  *
  * The template context contains the following fields:
  * - `column`&mdash;The current column instance.
  * - `dataItem`&mdash;The current data item.
  * - `cellContext`&mdash;An object used to pass context information to built-in directives.
- * - `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`.
+ * - `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` is `undefined`.
  * - `isNew`&mdash;The state of the current item.
  * - `rowIndex`&mdash;The current row index. If inside a new item row, `rowIndex` is `-1`.
  *

package/editing/remove-command.directive.d.ts

@@ -8,14 +8,11 @@ import { EditService } from './edit.service';
 import { BaseCommandDirective } from './base-command.directive';
 import * as i0 from "@angular/core";
 /**
- * Represents the `remove` command of the TreeList. You can apply this directive to any `button` element
- * inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
- * When an associated button with the directive is clicked, the
- * [`remove` event]({% slug api_treelist_treelistcomponent %}#toc-remove)
- * is triggered ([see example]({% slug editing_reactive_forms_treelist %})).
+ * Represents the `remove` command of the TreeList. Apply this directive to any `button` element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
  *
- *  When the row is in the `edit` mode, the button with the `kendoTreeListRemoveCommand` is automatically hidden.
- *  The directive takes as input the `cellContext` from the cell template.
+ * When the user clicks a button with this directive, the [`remove` event]({% slug api_treelist_treelistcomponent %}#toc-remove) is triggered ([see example]({% slug editing_reactive_forms_treelist %})).
+ *
+ * The button with `kendoTreeListRemoveCommand` is automatically hidden when the row is in edit mode. The directive takes the `cellContext` from the cell template as input.
  *
  * @example
  * ```html
@@ -30,7 +27,7 @@ import * as i0 from "@angular/core";
  */
 export declare class RemoveCommandDirective extends BaseCommandDirective {
     /**
-     * The `cellContext` provided to the template.
+     * Provides the `cellContext` to the template.
      */
     cellContext: any;
     commandClass: boolean;

package/editing/remove-event-args.interface.d.ts

@@ -4,11 +4,12 @@
 *-------------------------------------------------------------------------------------------*/
 import { EditEvent } from "./edit-event-args.interface";
 /**
- * Arguments for the [`remove`](slug:api_treelist_treelistcomponent#toc-remove) event.
+ * Provides arguments for the [`remove`](slug:api_treelist_treelistcomponent#toc-remove) event. Use this interface to access the parent data item when removing a row from the TreeList.
+ *
  */
 export interface RemoveEvent extends EditEvent {
     /**
-     * The data item of the parent row, if any.
+     * Specifies the data item of the parent row, if any.
      */
     parent: any;
 }

package/editing/save-command.directive.d.ts

@@ -8,14 +8,11 @@ import { EditService } from './edit.service';
 import { BaseCommandDirective } from './base-command.directive';
 import * as i0 from "@angular/core";
 /**
- * Represents the `save` command of the TreeList. You can apply this directive to any `button`
- * element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
- * When an associated button with the directive is clicked, the
- * [`save`]({% slug api_treelist_treelistcomponent %}#toc-save) event
- * is triggered ([see example]({% slug editing_treelist %})).
+ * Represents the `save` command of the TreeList. Apply this directive to any `button` element inside a [`CommandColumnComponent`]({% slug api_treelist_commandcolumncomponent %}).
  *
- * When the row is not in the `edit` mode, the button with `kendoTreeListSaveCommand` is automatically hidden.
- * The directive takes as input the `cellContext` from the cell template.
+ * When the user clicks a button with this directive, the [`save`]({% slug api_treelist_treelistcomponent %}#toc-save) event is triggered ([see example]({% slug editing_treelist %})).
+ *
+ * The button with `kendoTreeListSaveCommand` is automatically hidden when the row is not in edit mode. The directive takes the `cellContext` from the cell template as input.
  *
  * @example
  * ```html
@@ -30,7 +27,7 @@ import * as i0 from "@angular/core";
  */
 export declare class SaveCommandDirective extends BaseCommandDirective {
     /**
-     * The `cellContext` provided to the template.
+     * Provides the `cellContext` to the template.
      */
     cellContext: any;
     commandClass: boolean;

package/editing/save-event-args.interface.d.ts

@@ -5,15 +5,16 @@
 import { EditEvent } from "./edit-event-args.interface";
 import { FormGroup } from "@angular/forms";
 /**
- * Arguments for the [`save`](slug:api_treelist_treelistcomponent#toc-save) event.
+ * Provides arguments for the [`save`](slug:api_treelist_treelistcomponent#toc-save) event. Use this interface to access the form group and parent data item when saving a row in the TreeList.
+ *
  */
 export interface SaveEvent extends EditEvent {
     /**
-     * The edited `formGroup` instance.
+     * Specifies the edited `formGroup` instance.
      */
     formGroup: FormGroup;
     /**
-     * The data item of the parent row, if any.
+     * Specifies the data item of the parent row, if any.
      */
     parent: any;
 }

package/editing-directives/create-form-group-args.interface.d.ts

@@ -4,6 +4,6 @@
 *-------------------------------------------------------------------------------------------*/
 import { EditEvent } from "../editing/edit-event-args.interface";
 /**
- * The argument that is passed to the `createFormGroup` function.
+ * The argument passed to the `createFormGroup` function.
  */
 export type CreateFormGroupArgs = EditEvent;

package/editing-directives/edit-service.interface.d.ts

@@ -3,24 +3,32 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The interface of the `editService` that can be set to the
+ * The interface for the `editService` that you can set to the
  * [editing directives]({% slug editing_directives_treelist %}#toc-custom-service) of the TreeList.
  */
 export interface EditService {
     /**
-     * The method that is called to create a new item.
+     * Creates a new item.
+     * @param item The item to create.
+     * @param parent The parent item, if any.
+     * @param id The unique identifier, if any.
      */
     create(item: any, parent?: any, id?: any): void;
     /**
-     * The method that is called to update the items for existing item.
+     * Updates the items for an existing item.
+     * @param item The item to update.
      */
     update(item: any): void;
     /**
-     * The method that is called to remove existing item.
+     * Removes an existing item.
+     * @param item The item to remove.
+     * @param parent The parent item, if any.
      */
     remove(item: any, parent?: any): void;
     /**
-     * The method that is called to set new values to an item.
+     * Sets new values to an item.
+     * @param target The item to update.
+     * @param source The values to assign.
      */
     assignValues(target: any, source: any): void;
 }

package/editing-directives/editing-directive-base.d.ts

@@ -14,19 +14,19 @@ import * as i0 from "@angular/core";
 export declare abstract class EditingDirectiveBase implements OnInit, OnDestroy {
     protected treelist: TreeListComponent;
     /**
-     * The edit service that will handle the operations.
+     * The edit service that handles the operations.
      */
     set editService(value: EditService);
     get editService(): EditService;
     /**
-     * Gets or sets a function that will be called to determine the unique identifier
+     * Gets or sets a function that determines the unique identifier
      * for new items. The function receives the `item` and its `parent` as parameters
      * and must return an ID.
      */
     set newItemId(callback: (item: any, parent?: any) => any);
     get newItemId(): (item: any, parent?: any) => any;
     /**
-     * A function that is called to confirm if the `dataItem` will be removed.
+     * A function that confirms if the `dataItem` will be removed.
      */
     removeConfirmation: RemoveConfirmationCallback;
     protected subscriptions: Subscription;

package/editing-directives/in-cell-editing.directive.d.ts

@@ -7,8 +7,18 @@ import { TreeListComponent } from '../treelist.component';
 import { CreateFormGroup } from '../common/create-form-group';
 import * as i0 from "@angular/core";
 /**
- * A directive which encapsulates the editing operations of the TreeList when using the in-cell
- * editing with Reactive Forms ([see example](slug:editing_directives_treelist#toc-in-cell-editing-directive)).
+ * A directive that encapsulates the editing operations of the TreeList when using the in-cell
+ * editing with Reactive Forms. [See example](slug:editing_directives_treelist#toc-in-cell-editing-directive).
+ *
+ * @example
+ * ```html
+ * <kendo-treelist [kendoTreeListInCellEditing]="createFormGroup">
+ *   <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 declare class InCellEditingDirective extends EditingDirectiveBase {
     protected treelist: TreeListComponent;

package/editing-directives/reactive-editing.directive.d.ts

@@ -7,8 +7,18 @@ import { TreeListComponent } from '../treelist.component';
 import { CreateFormGroup } from '../common/create-form-group';
 import * as i0 from "@angular/core";
 /**
- * A directive which encapsulates the editing operations of the TreeList when using the
- * Reactive Forms ([see example](slug:editing_directives_treelist#toc-reactive-editing-directive)).
+ * A directive that encapsulates the editing operations of the TreeList when using the
+ * Reactive Forms. [See example](slug:editing_directives_treelist#toc-reactive-editing-directive).
+ *
+ * @example
+ * ```html
+ * <kendo-treelist [kendoTreeListReactiveEditing]="createFormGroup">
+ *   <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 declare class ReactiveEditingDirective extends RowEditingDirectiveBase {
     protected treelist: TreeListComponent;

package/editing-directives/template-editing.directive.d.ts

@@ -6,13 +6,23 @@ import { RowEditingDirectiveBase } from './row-editing-directive-base';
 import { TreeListComponent } from '../treelist.component';
 import * as i0 from "@angular/core";
 /**
- * A directive which encapsulates the editing operations of the TreeList when using
- * the Template-Driven Angular Forms ([see example](slug:editing_directives_treelist#toc-template-editing-directive)).
+ * A directive that encapsulates the editing operations of the TreeList when using
+ * Template-Driven Angular Forms. [See example](slug:editing_directives_treelist#toc-template-editing-directive).
+ *
+ * @example
+ * ```html
+ * <kendo-treelist [kendoTreeListTemplateEditing]="createNewItem">
+ *   <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 declare class TemplateEditingDirective extends RowEditingDirectiveBase {
     protected treelist: TreeListComponent;
     /**
-     * The function that creates the `dataItem` for the new rows.
+     * The function that creates the `dataItem` for new rows.
      */
     createNewItem: Function;
     protected originalValues: any;

package/esm2022/binding-directives/base-binding.directive.mjs

@@ -12,23 +12,26 @@ import { RowReorderService } from './../row-reordering/row-reorder.service';
 import * as i0 from "@angular/core";
 import * as i1 from "./data-bound-tree-component";
 import * as i2 from "./../row-reordering/row-reorder.service";
+/**
+ * @hidden
+ */
 export class BaseBindingDirective {
     component;
     rowReorderService;
     /**
-     * Defines the descriptors by which the data will be sorted.
+     * Sets the descriptors that sort the data.
      */
     set sort(value) {
         this.component.sort = this.state.sort = value;
     }
     /**
-     * Defines the descriptor by which the data will be filtered.
+     * Sets the descriptor that filters the data.
      */
     set filter(value) {
         this.component.filter = this.state.filter = value;
     }
     /**
-     * Defines the descriptor by which the data will be aggregated.
+     * Sets the descriptor that aggregates the data.
      */
     set aggregate(value) {
         this._aggregate = value;