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

package/rendering/toolbar/toolbar-focusable.directive.d.ts

@@ -6,8 +6,19 @@ import { ElementRef } from '@angular/core';
 import { ContextService } from '../../common/provider.service';
 import * as i0 from "@angular/core";
 /**
- * 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 declare class TreeListToolbarFocusableDirective {
     private host;

package/rendering/toolbar/toolbar-template.directive.d.ts

@@ -9,15 +9,13 @@ import * as i0 from "@angular/core";
  * 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>
  * ```
@@ -27,8 +25,8 @@ export declare class ToolbarTemplateDirective {
     private optionChanges;
     _position: 'top' | 'bottom' | 'both';
     /**
-     * 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: 'top' | 'bottom' | 'both');

package/row-reordering/types.d.ts

@@ -3,7 +3,7 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The arguments for the `rowReorder` event
+ * The arguments for the `rowReorder` event.
  */
 export interface RowReorderEvent {
     /**
@@ -36,4 +36,7 @@ export interface DragRow {
      */
     element: HTMLElement;
 }
+/**
+ * Specifies the drop position for row reordering.
+ */
 export type DropPosition = 'before' | 'after' | 'over' | 'forbidden';

package/schematics/ngAdd/index.js

@@ -4,13 +4,13 @@ const schematics_1 = require("@angular-devkit/schematics");
 function default_1(options) {
     const finalOptions = Object.assign(Object.assign({}, options), { mainNgModule: 'TreeListModule', package: 'treelist', peerDependencies: {
             // peer dep of the dropdowns
-            '@progress/kendo-angular-treeview': '19.1.2-develop.4',
+            '@progress/kendo-angular-treeview': '19.1.2-develop.5',
             // peer dependency of kendo-angular-inputs
-            '@progress/kendo-angular-dialog': '19.1.2-develop.4',
+            '@progress/kendo-angular-dialog': '19.1.2-develop.5',
             // peer dependency of kendo-angular-icons
             '@progress/kendo-svg-icons': '^4.0.0',
             // peer dependency of kendo-angular-dateinputs
-            '@progress/kendo-angular-navigation': '19.1.2-develop.4',
+            '@progress/kendo-angular-navigation': '19.1.2-develop.5',
         } });
     return (0, schematics_1.externalSchematic)('@progress/kendo-angular-schematics', 'ng-add', finalOptions);
 }

package/scrolling/content-scroll-event.d.ts

@@ -4,6 +4,8 @@
 *-------------------------------------------------------------------------------------------*/
 /**
  * Arguments for the [`contentScroll`](slug:api_treelist_treelistcomponent#toc-contentscroll) event.
+ *
+ * Use this event to get information about the scroll position and visible rows or columns in the TreeList.
  */
 export interface ContentScrollEvent {
     /**

package/scrolling/scroll-bottom-event.d.ts

@@ -5,6 +5,8 @@
 import { TreeListComponent } from "../treelist.component";
 /**
  * Arguments for the [`scrollBottom`](slug:api_treelist_treelistcomponent#toc-scrollbottom) event. [See example](slug:scrollmmodes_grid#toc-endless-scrolling).
+ *
+ * Use this event to get the TreeListComponent instance when the user scrolls to the bottom.
  */
 export interface ScrollBottomEvent {
     /**

package/scrolling/scroll-request.service.d.ts

@@ -5,15 +5,15 @@
 import { Subject } from 'rxjs';
 import * as i0 from "@angular/core";
 /**
- * Arguments for the scrollTo method. Specifies to which row / column should the treelist scroll to.
+ * Arguments for the scrollTo method. Specifies the row or column to which the TreeList should scroll.
  */
 export interface ScrollRequest {
     /**
-     * The row index to which the TreeList should scroll to, considering 0 as first row.
+     * The row index to which the TreeList should scroll, considering 0 as the first row.
      */
     row?: number;
     /**
-     * The column index to which the TreeList should scroll to, considering 0 as first column.
+     * The column index to which the TreeList should scroll, considering 0 as the first column.
      */
     column?: number;
 }

package/scrolling/scrollmode.d.ts

@@ -6,9 +6,9 @@
  * The scroll mode of the TreeList.
  *
  * The available values are:
- * * `none`—Scrollbars are hidden. The TreeList cannot be scrolled.
- * * `scrollable`—Displays scrollbars in TreeList.
- * * `virtual`—Enables the [virtual scroll mode](slug:virtualscrolling_treelist) of the TreeList.
+ * - `none`—Scrollbars are hidden. The TreeList cannot be scrolled.
+ * - `scrollable`—Displays scrollbars in TreeList.
+ * - `virtual`—Enables the [virtual scroll mode](slug:virtualscrolling_treelist) of the TreeList.
  *
  * @example
  * ```html

package/selection/is-selected.d.ts

@@ -4,11 +4,12 @@
 *-------------------------------------------------------------------------------------------*/
 import { ColumnBase } from '../columns/column-base';
 /**
- * Represents the callback that is used by the
- * [`isSelected`]({% slug api_treelist_treelistcomponent %}#toc-isSelected) property.
+ * Represents the callback used by the [`isSelected`]({% slug api_treelist_treelistcomponent %}#toc-isSelected) property.
+ * Use this function to determine if a data item is selected.
  *
- * ```ts-no-run
- * isSelected(dataItem: any, column?: ColumnBase, columnIndex?: number) {
+ * @example
+ * ```ts
+ * public isSelected(dataItem: any, column?: ColumnBase, columnIndex?: number): boolean {
  *   return dataItem.selected;
  * }
  * ```

package/selection/selectable-settings.d.ts

@@ -3,7 +3,7 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The settings for the selection functionality of the TreeList.[See example](slug:selection_treelist#toc-setup).
+ * The settings for the selection functionality of the TreeList. [See example](slug:selection_treelist#toc-setup).
  */
 export interface SelectableSettings {
     /**
@@ -22,15 +22,15 @@ export interface SelectableSettings {
     };
     /**
      * Specifies if the selection functionality is enabled.
-     * Setting this option to `false` will stop all selection-related functionality.
-     * The end user will not be able to select and deselect rows or cells.
-     * Items in the [selectedItems]({% slug api_treelist_selectabledirective %}#toc-selecteditems) collection will not be rendered as selected.
-     * The [isSelected]({% slug api_treelist_treelistcomponent %}#toc-isselected) callback will be ignored.
+     * Setting this option to `false` stops all selection-related functionality.
+     * The end user cannot select or deselect rows or cells.
+     * Items in the [selectedItems]({% slug api_treelist_selectabledirective %}#toc-selecteditems) collection are not rendered as selected.
+     * The [isSelected]({% slug api_treelist_treelistcomponent %}#toc-isselected) callback is ignored.
      */
     enabled?: boolean;
     /**
      * Determines if the selection is performed only through clicking a checkbox.
-     * If enabled, clicking the row itself will not select the row.
+     * If enabled, clicking the row itself does not select the row.
      * Applicable if at least one checkbox column is present.
      */
     checkboxOnly?: boolean;

package/selection/selectable.directive.d.ts

@@ -21,6 +21,18 @@ export interface SelectionItem {
 }
 /**
  * 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 declare class SelectableDirective implements OnDestroy {
     private treelist;

package/selection/selection-change-event.d.ts

@@ -9,7 +9,7 @@ import { ColumnBase } from '../columns/column-base';
  */
 export interface SelectionChangeItem {
     /**
-     * The changed selection dataItem
+     * The changed selection dataItem.
      */
     dataItem: any;
     /**
@@ -26,7 +26,7 @@ export interface SelectionChangeItem {
  */
 export declare class SelectionChangeEvent {
     /**
-     * Specifies how was the selection changed
+     * Specifies how the selection was changed.
      */
     action: 'select' | 'add' | 'remove';
     /**