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

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

@@ -15,18 +15,17 @@ import * as i1 from "./data-bound-tree-component";
 import * as i2 from "../row-reordering/row-reorder.service";
 const ROOT_ID = null;
 /**
- * A directive which binds the TreeList to an array of objects by using
- * an `idField` and `parentIDField` field to define the hierarchy.
+ * Represents the Kendo for Angular UI TreeList flat binding directive.
+ * Use this directive to bind the TreeList to a flat array of objects using `idField` and `parentIdField` to define the hierarchy.
+ * Handles in-memory data operations [sorting]({% slug sorting_treelist %}), [aggregation]({% slug treelist_with_aggregates %})
+ * and [filtering]({% slug filtering_treelist %}). [More information and examples]({% slug databinding_treelist %}).
  *
- * The directive encapsulates the in-memory handling of data operations such as
- * [sorting]({% slug sorting_treelist %}), [aggregation]({% slug treelist_with_aggregates %})
- * and [filtering]({% slug filtering_treelist %}) ([more information and examples]({% slug databinding_treelist %})).
  */
 export class FlatBindingDirective extends BaseBindingDirective {
     component;
     rowReorderService;
     /**
-     * The name of the field which contains the identifier of the parent node.
+     * Sets the name of the field that contains the identifier of the parent node.
      */
     set parentIdField(value) {
         this.parentIdGetter = getter(value);
@@ -37,7 +36,7 @@ export class FlatBindingDirective extends BaseBindingDirective {
         return this._parentIdField;
     }
     /**
-     * The name of the field which contains the unique identifier of the node.
+     * Sets the name of the field that contains the unique identifier of the node.
      */
     set idField(value) {
         this.idGetter = getter(value);
@@ -48,7 +47,7 @@ export class FlatBindingDirective extends BaseBindingDirective {
         return this._idField;
     }
     /**
-     * The array of data which will be used to populate the TreeList.
+     * Sets the array of data that populates the TreeList.
      */
     data;
     idGetter = getter('id');

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

@@ -13,17 +13,24 @@ import * as i0 from "@angular/core";
 import * as i1 from "./data-bound-tree-component";
 import * as i2 from "../row-reordering/row-reorder.service";
 /**
- * A directive which binds the TreeList to a tree of objects.
+ * Represents the Kendo UI for Angular TreeList hierarchy binding directive.
+ * Use this directive to bind the TreeList to a tree of objects using a field that holds child data items.
+ * Handles in-memory data operations [sorting]({% slug sorting_treelist %}), [aggregation]({% slug treelist_with_aggregates %})
+ * and [filtering]({% slug filtering_treelist %}). [More information and examples.](slug:local_databinding_treelist#toc-binding-to-hierarchical-data-1)
  *
- * The directive encapsulates the in-memory handling of data operations such as
- * [sorting]({% slug sorting_treelist %}), [aggregation]({% slug treelist_with_aggregates %})
- * and [filtering]({% slug filtering_treelist %}) ([more information and examples](slug:local_databinding_treelist#toc-binding-to-hierarchical-data-1)).
+ * @example
+ * ```html
+ * <kendo-treelist [kendoTreeListHierarchyBinding]="data" [children]="childrenField"></kendo-treelist>
+ * ```
+ *
+ * @remarks
+ * Applied to: {@link TreeListComponent}.
  */
 export class HierarchyBindingDirective extends BaseBindingDirective {
     component;
     rowReorderService;
     /**
-     *  The name of the field which holds the child data items of the node.
+     * Sets the name of the field that holds the child data items of the node.
      */
     set childrenField(value) {
         this.childrenGetter = getter(value);
@@ -34,7 +41,7 @@ export class HierarchyBindingDirective extends BaseBindingDirective {
         return this._childrenField;
     }
     /**
-     * The array of data which will be used to populate the TreeList.
+     * Sets the array of data that populates the TreeList.
      */
     data;
     childrenGetter = getter('items');

package/esm2022/column-menu/column-chooser.component.mjs

@@ -16,15 +16,14 @@ import * as i1 from "@progress/kendo-angular-l10n";
 import * as i2 from "../common/column-info.service";
 import * as i3 from "@progress/kendo-angular-popup";
 /**
- * Represents the component for selecting columns in the TreeList.
- * To show and hide the columns without including the column chooser item in the [Column Menu](slug:columnmenu_treelist),
- * add the component inside the [`ToolbarTemplate`]({% slug api_treelist_toolbartemplatedirective %}) directive.
+ * Represents the Kendo UI for Angular TreeList column chooser component.
+ * Use this component to let users show or hide columns in the TreeList. To display the column chooser outside the Column Menu, add it inside the [`ToolbarTemplate`]({% slug api_treelist_toolbartemplatedirective %}) directive.
  *
  * @example
  * ```html
  * <kendo-treelist ...>
- *   <ng-template kendoTreeListToolbarTemplate>
- *     <kendo-treelist-column-chooser> </kendo-treelist-column-chooser>
+ *   <ng-template kendoTreeListColumnMenuTemplate>
+ *     <kendo-treelist-column-chooser></kendo-treelist-column-chooser>
  *   </ng-template>
  * </kendo-treelist>
  * ```
@@ -37,14 +36,12 @@ export class ColumnChooserComponent {
     renderer;
     changeDetector;
     /**
-     * Specifies if the changes in the visibility of the column will be immediately applied.
-     *
+     * Specifies if changes in column visibility are applied immediately.
      * @default false
      */
     autoSync = false;
     /**
      * Specifies if all columns can be hidden.
-     *
      * @default true
      */
     allowHideAll = true;

package/esm2022/column-menu/column-locked-change-event.mjs

@@ -3,11 +3,13 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Arguments for the `columnLockedChange` event.
+ * Represents the event arguments for the `columnLockedChange` event in the Kendo UI for Angular TreeList.
+ * Use this event to access the columns whose locked state has changed.
+ *
  */
 export class ColumnLockedChangeEvent {
     /**
-     * The columns whose locked state is changed.
+     * The array of columns whose locked state has changed.
      */
     columns;
     /**

package/esm2022/column-menu/column-menu-autosize-all.component.mjs

@@ -13,12 +13,10 @@ import { NgIf } from '@angular/common';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/provider.service";
 /**
- * Represents the column-menu item for resizing all columns to the minimum possible width so that they fit the widest header or cell content without wrapping.
- * [See example](slug:columnmenu_treelist#toc-autosize-all-columns-item).
+ * Represents the Kendo UI TreeList column-menu item for resizing all columns to fit the widest header or cell content without wrapping. [See example](slug:columnmenu_treelist#toc-autosize-all-columns-item).
  *
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_treelist_columnmenutemplatedirective %}) directive.
- * To register the component as a known column menu item, set the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}) that is passed by
- * the template to the `service` input of the `kendo-treelist-columnmenu-autosize-all-columns` component. [See example](slug:columnmenu_treelist#toc-customizing-the-content).
+ * Place this component inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive to enable the feature.
+ * Register the component as a known column menu item by setting the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %}) to the `service` input. [See example](slug:columnmenu_treelist#toc-customizing-the-content).
  *
  * @example
  * ```html

package/esm2022/column-menu/column-menu-autosize.component.mjs

@@ -13,12 +13,10 @@ import { ColumnMenuErrorMessages } from '../common/error-messages';
 import * as i0 from "@angular/core";
 import * as i1 from "../common/provider.service";
 /**
- * Represents the column-menu item for resizing the specified column to the minimum possible width so that it fits the header or cell content without wrapping.
- * The component can be placed inside a [ColumnMenuTemplate]({% slug api_treelist_columnmenutemplatedirective %}) directive.
- * [See example](slug:columnmenu_treelist#toc-customizing-the-content).
+ * Represents the Kendo UI for Angular TreeList column-menu item for resizing a specified column to fit the header or cell content without wrapping. [See example](slug:columnmenu_treelist#toc-customizing-the-content).
  *
- * You have to set the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}) and `column` that are passed by
- * the template to the `service` and `column` input of the `kendo-treelist-columnmenu-autosize-column` component.
+ * Place this component inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive to enable the feature.
+ * Set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %}) and `column` inputs using the values passed by the template.
  *
  * @example
  * ```html
@@ -33,7 +31,7 @@ import * as i1 from "../common/provider.service";
 export class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBase {
     ctx;
     /**
-     * The TreeList column instance which will be resized through the auto size column option.
+     * The TreeList column instance to resize with the auto size column option.
      */
     column;
     maxWidthIcon = maxWidthIcon;
@@ -48,7 +46,7 @@ export class ColumnMenuAutoSizeColumnComponent extends ColumnMenuItemBase {
         }
     }
     /**
-     * Resizes a specified column to the minimum possible width so that it fits the widest header or cell content without wrapping.
+     * Resizes the specified column to the minimum possible width so that it fits the widest header or cell content without wrapping.
      */
     autoSizeColumn() {
         autoSizeColumn(this.ctx.treelist, this.service, this.column);

package/esm2022/column-menu/column-menu-chooser.component.mjs

@@ -14,12 +14,21 @@ import * as i0 from "@angular/core";
 import * as i1 from "@progress/kendo-angular-l10n";
 import * as i2 from "../common/column-info.service";
 /**
- * Represents the column-menu item for selecting columns in the TreeList. [See example](slug:columnmenu_treelist#toc-column-chooser-item).
  *
- * The component can be placed inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
+ * Represents the Kendo UI for Angular TreeList column-menu item for chaging the visibility of the columns. [See example](slug:columnmenu_treelist#toc-column-chooser-item).
  *
- * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %})
- * that is passed by the template to the service input of the `kendo-treelist-columnmenu-chooser` component.
+ * Place this component inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive to enable the feature.
+ * Set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %}) and `column` inputs using the values passed by the template.
+ *
+ * @example
+ * ```html
+ * <kendo-treelist [columnMenu]="true" ...>
+ *   <ng-template kendoTreeListColumnMenuTemplate let-service="service" let-column="column">
+ *     <kendo-treelist-columnmenu-chooser [column]="column" [service]="service">
+ *     </kendo-treelist-columnmenu-chooser>
+ *   </ng-template>
+ * </kendo-treelist>
+ * ```
  */
 export class ColumnMenuChooserComponent extends ColumnMenuItemBase {
     localization;
@@ -27,11 +36,11 @@ export class ColumnMenuChooserComponent extends ColumnMenuItemBase {
     changeDetector;
     hostElement;
     /**
-     * Fires when the content is expanded.
+     * Fires when the content expands.
      */
     expand = new EventEmitter();
     /**
-     * Fires when the content is collapsed.
+     * Fires when the content collapses.
      */
     collapse = new EventEmitter();
     /**

package/esm2022/column-menu/column-menu-filter.component.mjs

@@ -14,21 +14,31 @@ import * as i1 from "@progress/kendo-angular-l10n";
 /**
  * Represents the column-menu item for editing column filters in the TreeList.
  *
- * The component can be placed inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
+ * Render this component inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
  *
  * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %})
- * that is passed by the template to the service input of the `kendo-treelist-columnmenu-filter` component.
+ * that the template passes to the `service` input of the `kendo-treelist-columnmenu-filter` component.
  *
+ * @example
+ * ```html
+ * <kendo-treelist ...>
+ *  <kendo-treelist-column field="ProductName">
+ *   <ng-template kendoTreeListColumnMenuTemplate>
+ *    <kendo-treelist-columnmenu-filter></kendo-treelist-columnmenu-filter>
+ *   </ng-template>
+ *  </kendo-treelist-column>
+ * </kendo-treelist>
+ * ```
  */
 export class ColumnMenuFilterComponent extends ColumnMenuItemBase {
     localization;
     hostElement;
     /**
-     * Fires when the content is expanded.
+     * Fires when the content expands.
      */
     expand = new EventEmitter();
     /**
-     * Fires when the content is collapsed.
+     * Fires when the content collapses.
      */
     collapse = new EventEmitter();
     /**

package/esm2022/column-menu/column-menu-item-base.mjs

@@ -11,7 +11,7 @@ import * as i0 from "@angular/core";
  */
 export class ColumnMenuItemBase {
     /**
-     * Represents the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %}) class.
+     * Represents the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %}) instance.
      * Requires a mandatory input.
      */
     service;

package/esm2022/column-menu/column-menu-item-content-template.directive.mjs

@@ -5,11 +5,9 @@
 import { Directive, Optional, TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the content template of the
- * [`kendo-treelist-columnmenu-item`]({% slug api_treelist_columnmenuitemcomponent %}) component.
- * Provides an option for specifying the content of a column item.
- * To define the content template, nest an `<ng-template>` tag with the
- * `kendoTreeListColumnMenuItemContentTemplate` directive inside a `<kendo-treelist-columnmenu-item>`.
+ * Represents the content template for the [`kendo-treelist-columnmenu-item`]({% slug api_treelist_columnmenuitemcomponent %}) component.
+ * Use this directive to specify the content of a column menu item.
+ * To define the content template, nest an `<ng-template>` tag with the `kendoTreeListColumnMenuItemContentTemplate` directive inside a `<kendo-treelist-columnmenu-item>`.
  *
  * @example
  * ```html

package/esm2022/column-menu/column-menu-item.component.mjs

@@ -12,8 +12,7 @@ import { ColumnMenuService } from './column-menu.service';
 import { guid } from '@progress/kendo-angular-common';
 import * as i0 from "@angular/core";
 /**
- * Represents an item that can be placed inside a
- * [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
+ * Represents an item you can place inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
  *
  * @example
  * ```html
@@ -30,25 +29,23 @@ export class ColumnMenuItemComponent {
      */
     itemClick = new EventEmitter();
     /**
-     * Fires when the content is expanded.
+     * Fires when the content expands.
      */
     expand = new EventEmitter();
     /**
-     * Fires when the content is collapsed.
+     * Fires when the content collapses.
      */
     collapse = new EventEmitter();
     /**
-     * Specifies the name of the [font icon](slug:icons#icons-list)
-     * that will be rendered for the item.
+     * Sets the name of the [font icon](slug:icons#icons-list) rendered for the item.
      */
     icon;
     /**
-     * Specifies the name of the [SVG icon]({% slug svgicon_list %})
-     * that will be rendered for the item.
+     * Sets the name of the [SVG icon]({% slug svgicon_list %}) rendered for the item.
      */
     svgIcon;
     /**
-     * Specifies the item text.
+     * Sets the item text.
      */
     text;
     /**
@@ -64,7 +61,7 @@ export class ColumnMenuItemComponent {
      */
     expanded;
     /**
-     * Represents the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}) class.
+     * Provides the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}) instance.
      * Required to include the item in the column menu keyboard navigation sequence.
      */
     service;

package/esm2022/column-menu/column-menu-item.directive.mjs

@@ -8,12 +8,34 @@ import { Keys } from '@progress/kendo-angular-common';
 import { ColumnMenuChooserComponent } from './column-menu-chooser.component';
 import { ColumnMenuFilterComponent } from './column-menu-filter.component';
 import * as i0 from "@angular/core";
+/**
+ * Provides keyboard navigation support for TreeList column menu items.
+ * Use this directive to manage focus and tab order for custom column menu items. [See example](slug:columnmenu_treelist#customizing-the-content).
+ *
+ * @example
+ * ```html
+ * <ng-template kendoTreelistColumnMenuTemplate let-service="service" let-column="column">
+ *    <kendo-treelist-columnmenu-sort #sortItem [kendoTreeListColumnMenuItem]="sortItem" [service]="service">
+ *    </kendo-treelist-columnmenu-sort>
+ * </ng-template>
+ * ```
+ * @remarks
+ * Applied to:
+ * {@link ColumnMenuChooserComponent},
+ * {@link ColumnMenuFilterComponent},
+ * {@link ColumnMenuSortComponent},
+ * {@link ColumnMenuLockComponent},
+ * {@link ColumnMenuComponent},
+ * {@link ColumnMenuItemComponent},
+ * {@link ColumnMenuAutoSizeAllColumnsComponent},
+ * {@link ColumnMenuAutoSizeColumnComponent}.
+ */
 export class ColumnMenuItemDirective {
     hostElement;
     renderer;
     ngZone;
     /**
-     * The reference to the TreeList column menu item. Required to include the item in the built-in keyboard navigation.
+     * Provides a reference to the TreeList column menu item. Required for built-in keyboard navigation.
      */
     menuItemComponent;
     firstFocusableElement;

package/esm2022/column-menu/column-menu-lock.component.mjs

@@ -12,13 +12,23 @@ import * as i0 from "@angular/core";
 import * as i1 from "@progress/kendo-angular-l10n";
 import * as i2 from "../common/column-info.service";
 /**
- * Represents the column-menu item that allows the user to lock or unlock columns.
+ * Represents the column-menu item that lets you lock or unlock columns.
  *
- * The componnt can be placed inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
+ * Render this component inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
  *
-* To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %})
- * that is passed by the template to the service input of the `kendo-treelist-columnmenu-lock` component.
+ * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %})
+ * that the template passes to the `service` input of the `kendo-treelist-columnmenu-lock` component.
  *
+ * @example
+ * ```html
+ * <kendo-treelist ...>
+ *   <kendo-treelist-column field="ProductName">
+ *     <ng-template kendoTreeListColumnMenuTemplate>
+ *       <kendo-treelist-columnmenu-lock></kendo-treelist-columnmenu-lock>
+ *     </ng-template>
+ *   </kendo-treelist-column>
+ * </kendo-treelist>
+ * ```
  */
 export class ColumnMenuLockComponent extends ColumnMenuItemBase {
     localization;

package/esm2022/column-menu/column-menu-sort.component.mjs

@@ -15,11 +15,21 @@ import * as i2 from "../common/sort.service";
 /**
  * Represents the column-menu item for sorting TreeList columns.
  *
- * The component can be placed inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
+ * Render this component inside a [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
  *
  * To register the component as a known column menu item, set the [`ColumnMenuService`]({% slug api_treelist_columnmenuservice %})
- * that is passed by the template to the service input of the `kendo-treelist-columnmenu-sort` component.
+ * that the template passes to the `service` input of the `kendo-treelist-columnmenu-sort` component.
  *
+ * @example
+ * ```html
+ * <kendo-treelist ...>
+ *   <kendo-treelist-column field="ProductName">
+ *     <ng-template kendoTreeListColumnMenuTemplate>
+ *       <kendo-treelist-columnmenu-sort></kendo-treelist-columnmenu-sort>
+ *     </ng-template>
+ *   </kendo-treelist-column>
+ * </kendo-treelist>
+ * ```
  */
 export class ColumnMenuSortComponent extends ColumnMenuItemBase {
     localization;

package/esm2022/column-menu/column-menu-template.directive.mjs

@@ -5,12 +5,10 @@
 import { Directive, Optional, TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents the template for the column menu in the TreeList. Provides an option for
- * customizing the content of the column menu for all or for specific columns.
- * To define the content template, nest an `<ng-template>` tag with the
- * `kendoTreeListColumnMenuTemplate` directive inside the `kendo-treelist` or the `<kendo-treelist-column>` component.
+ * Represents the template for the column menu in the TreeList. Use this directive to customize the content of the column menu for all or specific columns.
+ * To define the content template, nest an `<ng-template>` tag with the `kendoTreeListColumnMenuTemplate` directive inside the `kendo-treelist` or the `<kendo-treelist-column>` component.
  *
- * The template context is passes through the following fields:
+ * The template context is passed through the following fields:
  * - `service`&mdash;Represents the [ColumnMenuService]({% slug api_treelist_columnmenuservice %}).
  * - `column`&mdash;Represents the TreeList column.
  *

package/esm2022/column-menu/column-menu.component.mjs

@@ -36,6 +36,18 @@ let id = 0;
 const getId = (gridId) => `${gridId}-column-menu-${id++}`;
 /**
  * Represents the [column menu]({% slug columnmenu_treelist %}) component of the TreeList.
+ * Use this component to display and manage column menu options for a TreeList column.
+ *
+ * @example
+ * ```html
+ * <kendo-treelist ...>
+ *   <kendo-treelist-column field="ProductName">
+ *     <ng-template kendoTreeListColumnMenuTemplate let-service="service" let-column="column">
+ *       <kendo-treelist-column-menu [column]="column"></kendo-treelist-column-menu>
+ *     </ng-template>
+ *   </kendo-treelist-column>
+ * </kendo-treelist>
+ * ```
  */
 export class ColumnMenuComponent {
     navigationService;
@@ -61,12 +73,12 @@ export class ColumnMenuComponent {
      */
     settings = {};
     /**
-     * The descriptors by which the data will be sorted.
+     * The descriptors by which the data is sorted.
      * Typically bound to the same value as [TreeListComponent.sort]({% slug api_treelist_treelistcomponent %}#toc-sort).
      */
     sort;
     /**
-     * The descriptor by which the data will be filtered.
+     * The descriptor by which the data is filtered.
      * Typically bound to the same value as [TreeListComponent.filter]({% slug api_treelist_treelistcomponent %}#toc-filter).
      */
     filter;

package/esm2022/column-menu/column-menu.service.mjs

@@ -7,8 +7,7 @@ import { MenuTabbingService } from '../filtering/menu/menu-tabbing.service';
 import * as i0 from "@angular/core";
 import * as i1 from "../filtering/menu/menu-tabbing.service";
 /**
- * Represents the service that is passed to the
- * [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
+ * Represents the service passed to the [`ColumnMenuTemplate`]({% slug api_treelist_columnmenutemplatedirective %}) directive.
  *
  * @example
  * ```html

package/esm2022/column-menu/column-visibility-change-event.mjs

@@ -3,11 +3,11 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Arguments for the `columnVisibilityChange` event.
+ * Represents the arguments for the `columnVisibilityChange` event.
  */
 export class ColumnVisibilityChangeEvent {
     /**
-     * The columns whose visibility is changed.
+     * Contains the columns whose visibility changes.
      */
     columns;
     /**

package/esm2022/columns/checkbox-column.component.mjs

@@ -8,20 +8,32 @@ import { CellTemplateDirective } from '../rendering/cell-template.directive';
 import * as i0 from "@angular/core";
 import * as i1 from "./column-base";
 /**
- * Represents the checkbox for selecting rows in the TreeList. [See example](slug:treelist_row_selection#toc-select-all-checkbox).
+ * Represents the checkbox column for selecting rows in the TreeList. [See example](slug:treelist_row_selection#toc-select-all-checkbox).
+ *
+ * @example
+ * ```html
+ * <kendo-treelist ...>
+ *   <kendo-treelist-checkbox-column
+ *     [showSelectAll]="true"
+ *     [checkChildren]="true"
+ *     [expandable]="true">
+ *   </kendo-treelist-checkbox-column>
+ *   <kendo-treelist-column field="ProductName" title="Product Name"></kendo-treelist-column>
+ * </kendo-treelist>
+ * ```
  */
 export class CheckboxColumnComponent extends ColumnBase {
     parent;
     /**
-     * Determines whether a select-all checkbox will be displayed in the header.
+     * Specifies if a select-all checkbox appears in the header.
      */
     showSelectAll;
     /**
-     * Determines whether checkbox click should select / unselect all children
+     * Specifies if clicking the checkbox selects or deselects all children.
      */
     checkChildren;
     /**
-     * Defines whether the expanded indicator should be rendered in the column.
+     * Specifies if the expanded indicator appears in the column.
      * @default false
      */
     expandable;