@progress/kendo-angular-treeview 19.1.2-develop.2 → 19.1.2-develop.4

package/treeitem-lookup.interface.d.ts

@@ -4,29 +4,30 @@
 *-------------------------------------------------------------------------------------------*/
 import { TreeItem } from './treeitem.interface';
 /**
- * Represents a node-tree lookup structure which persists information about the current node and about its parent and children nodes ([see example]({% slug checkboxes_treeview %}#toc-modifying-the-checked-state)).
+ * Represents a node-tree lookup structure that stores information about the current node, its parent, and its children
+ * ([see example](slug:checkboxes_treeview#toc-modifying-the-checked-state)).
  */
 export interface ItemLookup {
     /**
-     * The current TreeItem instance
+     * The current `TreeItem` instance.
      */
     item: TreeItem;
     /**
-     * The children of the current node
+     * The children of the current node.
      */
     children?: TreeItem[];
     /**
-     * The parent of the current node
+     * The parent of the current node.
      */
     parent?: ItemLookup;
 }
 /**
- * Represents a node-tree lookup structure which persists information about the current node and about its parent and children nodes.
- * Used in the [`checkedChange`]({% slug api_treeview_treeviewcomponent %}#toc-checkedchange) event of the TreeView ([see example]({% slug checkboxes_treeview %}#toc-modifying-the-checked-state)).
+ * Represents a node-tree lookup structure that stores information about the current node, its parent, and its children.
+ * Used in the [`checkedChange`](slug:api_treeview_treeviewcomponent#checkedchange) event of the TreeView ([see example](slug:checkboxes_treeview#toc-modifying-the-checked-state)).
  */
 export interface TreeItemLookup {
     /**
-     *  The current TreeItem instance.
+     * The current `TreeItem` instance.
      */
     item: TreeItem;
     /**
@@ -34,7 +35,7 @@ export interface TreeItemLookup {
      */
     parent?: ItemLookup;
     /**
-     *  The lookup details for the children of the current TreeView node.
+     * The lookup details for the children of the current TreeView node.
      */
     children?: TreeItemLookup[];
 }

package/treeitem.interface.d.ts

@@ -7,13 +7,13 @@
  */
 export interface TreeItem {
     /**
-     * The data item that is bound to the TreeView node
-     * ([see example]({% slug selection_treeview %}#toc-modifying-the-selection)).
+     * The data item associated with the TreeView node
+     * ([see example](slug:selection_treeview#modifying-the-selection)).
      */
     dataItem: any;
     /**
      * The auto-generated hierarchical index of the TreeView node
-     * ([see example]({% slug selection_treeview %}#toc-modifying-the-selection)).
+     * ([see example](slug:selection_treeview#toc-modifying-the-selection)).
      */
     index: string;
 }

package/treeview-filter-settings.d.ts

@@ -2,45 +2,35 @@
 * Copyright © 2025 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
+/**
+ * Represents the filter settings for the TreeView component.
+ */
 export interface TreeViewFilterSettings {
     /**
-     * The filter operator (comparison).
+     * Sets the filter operator for comparing values.
      *
-     * The supported operators are:
-     * * `"contains"`
-     * * `"doesnotcontain"`
-     * * `"startswith"`
-     * * `"doesnotstartwith"`
-     * * `"endswith"`
-     * * `"doesnotendwith"`
+     * You can use a string operator or a custom matcher function.
      *
-     * The default operator is `"contains"`.
-     *
-     * A custom matcher function can also be provided to the filter settings object:
-     * @example
-     * ```ts
-     * const matcher: MatcherFunction = (dataItem: object, searchTerm: string) => dataItem.firstName.indexOf(searchTerm) >= 0;
-     * ```
      */
     operator?: 'contains' | 'doesnotcontain' | 'startswith' | 'doesnotstartwith' | 'endswith' | 'doesnotendwith' | MatcherFunction;
     /**
-     * Determines if the string comparison is case-insensitive.
-     * By defualt, a case-insensitive filtering will be performed.
+     * Specifies if the string comparison ignores case.
+     *
+     * @default true
      */
     ignoreCase?: boolean;
     /**
-     * Determines the behavior of the filtering algorithm.
-     * - `"strict"`—does not show child nodes of filter matches. Instead, only matching nodes themselves are displayed.
-     * - `"lenient"`—all child nodes of each filter match are included in the filter results.
+     * Sets the filtering mode. In `"strict"` mode, the TreeView shows only matching nodes without any child nodes. In `"lenient"` mode, the TreeView includes all child nodes of each filter match.
      *
-     * The default mode is `"lenient"`
+     * @default "lenient"
      */
     mode?: "strict" | "lenient";
 }
 /**
- * A function that determines if a match is valid based on a source text and a term
+ * Represents a function that checks if a match is valid based on a source text and a term.
+ *
  * @example
- * ```ts
+ * ```typescript
  * const matcher: MatcherFunction = (dataItem: object, searchTerm: string) => dataItem.firstName.indexOf(searchTerm) >= 0;
  * ```
  */

package/treeview.component.d.ts

@@ -26,8 +26,19 @@ import { SVGIcon } from '@progress/kendo-svg-icons';
 import { TextBoxComponent } from '@progress/kendo-angular-inputs';
 import * as i0 from "@angular/core";
 /**
- * Represents the [Kendo UI TreeView component for Angular]({% slug overview_treeview %}).
+ * Represents the [Kendo UI TreeView component for Angular](slug:overview_treeview).
  *
+ * @example
+ * ```html
+ * <kendo-treeview
+ *    kendoTreeViewExpandable
+ *    [nodes]="data"
+ *    textField="text"
+ *    [children]="fetchChildren"
+ *    [hasChildren]="hasChildren"
+ * >
+ * </kendo-treeview>
+ * ```
  */
 export declare class TreeViewComponent implements OnChanges, OnInit, AfterViewInit, OnDestroy, DataBoundComponent {
     element: ElementRef<HTMLElement>;
@@ -57,16 +68,17 @@ export declare class TreeViewComponent implements OnChanges, OnInit, AfterViewIn
      */
     searchbox: TextBoxComponent;
     /**
-     * The hint which is displayed when the component is empty.
+     * Sets the placeholder text for the filter input when the component is empty.
      */
     filterInputPlaceholder: string;
     /**
-     * Determines whether to allow expanding disabled nodes.
+     * Allows expanding disabled nodes.
+     *
      * @default false
      */
     expandDisabledNodes: boolean;
     /**
-     * Determines whether the content animation is enabled.
+     * Enables or disables content animation.
      */
     set animate(value: boolean);
     get animate(): boolean;
@@ -80,79 +92,73 @@ export declare class TreeViewComponent implements OnChanges, OnInit, AfterViewIn
         item: TreeItem;
     }>;
     /**
-     * Fires when the user blurs the component.
-     */
+      * Fires when the component loses focus.
+      */
     onBlur: EventEmitter<any>;
     /**
-     * Fires when the user focuses the component.
+     * Fires when the component receives focus.
      */
     onFocus: EventEmitter<any>;
     /**
-     * Fires when the user expands a TreeView node.
+     * Fires when a TreeView node expands.
      */
     expand: EventEmitter<TreeItem>;
     /**
-     * Fires when the user collapses a TreeView node.
+     * Fires when a TreeView node collapses.
      */
     collapse: EventEmitter<TreeItem>;
     /**
-     * Fires just before the dragging of the node starts ([see example]({% slug draganddrop_treeview %}#toc-setup)). This event is preventable.
-     * If you prevent the event default, no drag hint will be created and the subsequent drag-related events will not be fired.
+     * Fires just before node dragging starts ([see example](slug:draganddrop_treeview#setup)). This event is preventable.
+     * Prevent the default event to stop drag hint creation and further drag events.
      */
     nodeDragStart: EventEmitter<TreeItemDragStartEvent>;
     /**
-     * Fires when an item is being dragged ([see example]({% slug draganddrop_treeview %}#toc-setup)).
+     * Fires when an item is being dragged ([see example](slug:draganddrop_treeview#setup)).
      */
     nodeDrag: EventEmitter<TreeItemDragEvent>;
     /**
-     * Emits when the built-in filtering mechanism in the data-binding directives updates the node's visibility.
-     * Used for the built-in auto-expand functionalities of the component and available for custom implementations.
+     * Emits when the built-in filtering mechanism updates node visibility.
+     * Used for the built-in auto-expand functionalities. Handle this event for custom implementations.
      */
     filterStateChange: EventEmitter<FilterState>;
     /**
-     * Fires on the target TreeView when a dragged item is dropped ([see example]({% slug draganddrop_treeview %}#toc-setup)).
-     * This event is preventable. If you prevent the event default (`event.preventDefualt()`) or invalidate its state (`event.setValid(false)`),
-     * the `addItem` and `removeItem` events will not be triggered.
+     * Fires on the target TreeView when a dragged item is dropped ([see example](slug:draganddrop_treeview#setup)).
+     *
+     * Prevent the default event (`event.preventDefault()`) or set the event as invalid (`event.setValid(false)`) to stop the `addItem` and `removeItem` events from triggering.
      *
-     * Both operations cancel the default drop operation, but the indication to the user is different. `event.setValid(false)` indicates that the operation was
-     * unsuccessful by animating the drag clue to its original position. `event.preventDefault()` simply removes the clue, as if it has been dropped successfully.
-     * As a general rule, use `preventDefault` to manually handle the add and remove operations, and `setValid(false)` to indicate the operation was unsuccessful.
+     * Use `preventDefault` to handle add/remove manually, or `setValid(false)` to indicate an unsuccessful operation. While `setValid(false)` animates the drag clue to its original position, `event.preventDefault()` simply removes the clue.
      */
     nodeDrop: EventEmitter<TreeItemDropEvent>;
     /**
-     * Fires on the source TreeView after the dragged item has been dropped ([see example]({% slug draganddrop_treeview %}#toc-setup)).
+     * Fires on the source TreeView after the dragged item is dropped ([see example](slug:draganddrop_treeview#setup)).
      */
     nodeDragEnd: EventEmitter<TreeItemDragEvent>;
     /**
-     * Fires after a dragged item is dropped ([see example]({% slug draganddrop_treeview %}#toc-setup)).
-     * Called on the TreeView where the item is dropped.
+     * Fires after a dragged item is dropped ([see example](slug:draganddrop_treeview#setup)). Called on the TreeView where the item is dropped.
      */
     addItem: EventEmitter<TreeItemAddRemoveArgs>;
     /**
-     * Fires after a dragged item is dropped ([see example]({% slug draganddrop_treeview %}#toc-setup)).
-     * Called on the TreeView from where the item is dragged.
+     * Fires after a dragged item is dropped ([see example](slug:draganddrop_treeview#setup)). Called on the TreeView from where the item is dragged.
      */
     removeItem: EventEmitter<TreeItemAddRemoveArgs>;
     /**
-     * Fires when the user selects a TreeView node checkbox
-     * ([see example]({% slug checkboxes_treeview %}#toc-modifying-the-checked-state)).
+     * Fires when a TreeView node checkbox is selected ([see example](slug:checkboxes_treeview#toc-modifying-the-checked-state)).
      */
     checkedChange: EventEmitter<TreeItemLookup>;
     /**
-     * Fires when the user selects a TreeView node
-     * ([see example]({% slug selection_treeview %}#toc-modifying-the-selection)).
+     * Fires when a TreeView node is selected ([see example](slug:selection_treeview#toc-modifying-the-selection)).
      */
     selectionChange: EventEmitter<TreeItem>;
     /**
-     * Fires when the value of the built-in filter input element changes.
+     * Fires when the value of the built-in filter input changes.
      */
     filterChange: EventEmitter<string>;
     /**
-     * Fires when the user clicks a TreeView node.
+     * Fires when a TreeView node is clicked.
      */
     nodeClick: EventEmitter<NodeClickEvent>;
     /**
-     * Fires when the user double clicks a TreeView node.
+     * Fires when a TreeView node is double-clicked.
      */
     nodeDblClick: EventEmitter<NodeClickEvent>;
     /**
@@ -188,116 +194,82 @@ export declare class TreeViewComponent implements OnChanges, OnInit, AfterViewIn
     /**
      * A function that defines how to track node changes.
      * By default, the TreeView tracks the nodes by data item object reference.
-     *
-     * @example
-     * ```ts
-     *  @Component({
-     *      selector: 'my-app',
-     *      template: `
-     *          <kendo-treeview
-     *              [nodes]="data"
-     *              textField="text"
-     *              [trackBy]="trackBy"
-     *          >
-     *          </kendo-treeview>
-     *      `
-     *  })
-     *  export class AppComponent {
-     *      public data: any[] = [
-     *          { text: "Furniture" },
-     *          { text: "Decor" }
-     *      ];
-     *
-     *      public trackBy(index: number, item: any): any {
-     *          return item.text;
-     *      }
-     *  }
-     * ```
      */
     trackBy: TrackByFunction<object>;
     /**
-     * The nodes which will be displayed by the TreeView
-     * ([see example]({% slug databinding_treeview %})).
+     * The nodes displayed by the TreeView ([see example](slug:databinding_treeview)).
      */
     set nodes(value: any[]);
     get nodes(): any[];
     /**
-     * The fields of the data item that provide the text content of the nodes
-     * ([see example]({% slug databinding_treeview %})). If the `textField` input is set
-     * to an array, each hierarchical level uses the field that corresponds to the same
-     * index in the array, or the last item in the array.
+     * The fields of the data item that provide the text content of the nodes ([see example](slug:databinding_treeview)).
+     * If set to an array, each level uses the field at the same index or the last item in the array.
      */
     textField: string | string[];
     /**
-     * A function which determines if a specific node has child nodes
-     * ([see example]({% slug databinding_treeview %})).
+     * A function that determines if a node has child nodes ([see example](slug:databinding_treeview)).
      */
     get hasChildren(): (item: object) => boolean;
     set hasChildren(callback: (item: object) => boolean);
     /**
-     * A function which determines if a specific node is checked
-     * ([see example]({% slug checkboxes_treeview %}#toc-modifying-the-checked-state)).
+     * A function that determines if a node is checked ([see example](slug:checkboxes_treeview#toc-modifying-the-checked-state)).
      */
     get isChecked(): (item: object, index: string) => CheckedState;
     set isChecked(callback: (item: object, index: string) => CheckedState);
     /**
-     * A function which determines if a specific node is disabled.
+     * A function that determines if a node is disabled.
      */
     isDisabled: (item: object, index: string) => boolean;
     /**
-     * A function which determines if a specific node has a checkbox.
-     *
-     * > If there is no checkbox for a node, then this node is not checkable and is excluded from any built-in check functionality.
+     * A function that determines if a node has a checkbox. If there is no checkbox, the node is not checkable and is excluded from built-in check functionality.
      */
     hasCheckbox: (item: object, index: string) => boolean;
     /**
-     * A function which determines if a specific node is expanded.
+     * A function that determines if a node is expanded.
      */
     get isExpanded(): (item: object, index: string) => boolean;
     set isExpanded(callback: (item: object, index: string) => boolean);
     /**
-     * A function which determines if a specific node is selected
-     * ([see example]({% slug selection_treeview %}#toc-modifying-the-selection)).
+     * A function that determines if a node is selected ([see example](slug:selection_treeview#modifying-the-selection)).
      */
     get isSelected(): (item: object, index: string) => boolean;
     set isSelected(callback: (item: object, index: string) => boolean);
     /**
-     * A callback which determines whether a TreeView node should be rendered as hidden. The utility .k-hidden class is used to hide the nodes.
-     * Useful for custom filtering implementations.
+     * A callback that determines whether a TreeView node should be rendered as hidden. Uses the `.k-hidden` utility class. Useful for custom filtering.
+     *
      */
     isVisible: (item: object, index: string) => boolean;
     /**
-     * Determines whether the TreeView keyboard navigable is enabled.
+     * Enables keyboard navigation for the TreeView.
+     *
+     * @default true
      */
     navigable: boolean;
     /**
-     * A function which provides the child nodes for a given parent node
-     * ([see example]({% slug databinding_treeview %})).
+     * A function that provides the child nodes for a given parent node ([see example](slug:databinding_treeview)).
      */
     children: (item: object) => Observable<object[]>;
     /**
-     * Indicates whether the child nodes will be fetched on node expand or will be initially prefetched.
+     * Indicates whether child nodes are fetched on expand or initally prefetched.
+     *
      * @default true
      */
     loadOnDemand: boolean;
     /**
-     * Renders the built-in input element for filtering the TreeView.
-     * If set to `true`, the component emits the `filterChange` event, which can be used to [filter the TreeView manually]({% slug filtering_treeview %}#toc-manual-filtering).
-     * A built-in filtering implementation is available to use with the [`kendoTreeViewHierarchyBinding`]({% slug api_treeview_hierarchybindingdirective %}) and [`kendoTreeViewFlatDataBinding`]({% slug api_treeview_flatdatabindingdirective %}) directives.
+     * Renders the built-in input element for filtering. If `true`, emits the `filterChange` event that can be handled for [manual filtering](slug:filtering_treeview#toc-manual-filtering).
+     * Built-in filtering is available with [`kendoTreeViewHierarchyBinding`](slug:api_treeview_hierarchybindingdirective) and [`kendoTreeViewFlatDataBinding`](slug:api_treeview_flatdatabindingdirective) directives.
+     *
+     * @default false
      */
     filterable: boolean;
     /**
-     * Sets an initial value of the built-in input element used for filtering.
+     * Sets the initial value of the built-in filter input.
      */
     filter: string;
     /**
      * Sets the size of the component.
      *
-     * The possible values are:
-     * * `small`
-     * * `medium` (default)
-     * * `large`
-     * * `none`
+     * @default 'medium'
      */
     set size(size: TreeViewSize);
     get size(): TreeViewSize;
@@ -307,7 +279,8 @@ export declare class TreeViewComponent implements OnChanges, OnInit, AfterViewIn
      */
     get treeviewId(): string;
     /**
-     * Indicates whether only parent nodes should be disabled or their child nodes as well
+     * Indicates whether only parent nodes should be disabled or their child nodes as well.
+     *
      * @default false
      */
     disableParentNodesOnly: boolean;
@@ -345,47 +318,22 @@ export declare class TreeViewComponent implements OnChanges, OnInit, AfterViewIn
      */
     blur(): void;
     /**
-     * Focuses the first focusable item in the TreeView component if no hierarchical index is provided.
-     *
-     * @example
-     * ```ts
-     * import { Component } from '@angular/core';
-     *
-     *  @Component({
-     *      selector: 'my-app',
-     *      template: `
-     *      <button (click)="treeview.focus('1')">Focuses the second node</button>
-     *      <kendo-treeview
-     *          #treeview
-     *          [nodes]="data"
-     *          textField="text"
-     *      >
-     *      </kendo-treeview>
-     *  `
-     *  })
-     *  export class AppComponent {
-     *      public data: any[] = [
-     *          { text: "Furniture" },
-     *          { text: "Decor" }
-     *      ];
-     *  }
-     * ```
+     * Focuses the first focusable item in the TreeView if no hierarchical index is provided.
      */
     focus(index?: string): void;
     /**
-     * Based on the specified index, returns the TreeItemLookup node.
+     * Returns the `TreeItemLookup` node for the specified index.
      *
      * @param index - The index of the node.
-     * @returns {TreeItemLookup} - The item that was searched (looked up).
+     * @returns {TreeItemLookup} - The looked up item.
      */
     itemLookup(index: string): TreeItemLookup;
     /**
-     * Triggers the [`children`]({% slug api_treeview_treeviewcomponent %}#toc-children) function for every expanded node,
-     * causing all rendered child nodes to be fetched again.
+     * Calls the [`children`](slug:api_treeview_treeviewcomponent#children) function for every expanded node and fetches all rendered child nodes again.
      */
     rebindChildren(): void;
     /**
-     * Triggers the `expand` event for the provided node and displays it's loading indicator.
+     * Triggers the `expand` event for the provided node and shows its loading indicator.
      */
     expandNode(item: any, index: string): void;
     /**
@@ -393,20 +341,16 @@ export declare class TreeViewComponent implements OnChanges, OnInit, AfterViewIn
      */
     collapseNode(item: any, index: string): void;
     /**
-     * Gets the current page size of the checked data item children collection
-     * ([see example]({% slug loadmorebutton_treeview %}#toc-managing-page-sizes)).
-     *
-     * > Since the root nodes collection is not associated with any parent data item, pass `null` as `dataItem` param to get its page size.
+     * Gets the current page size of the data item's children collection ([see example](slug:loadmorebutton_treeview#managing-page-sizes)).
+     * Pass `null` as `dataItem` to get the root collection's page size.
      *
      * @param dataItem {any} - The parent data item of the targeted collection.
-     * @returns {number} - The page size of the checked data item children collection.
+     * @returns {number} - The page size of the data item's children collection.
      */
     getNodePageSize(dataItem: any): number;
     /**
-     * Sets the page size of the targeted data item children collection
-     * ([see example]({% slug loadmorebutton_treeview %}#toc-managing-page-sizes)).
-     *
-     * > Since the root nodes collection is not associated with any parent data item, pass `null` as `dataItem` param to target its page size.
+     * Sets the page size of the data item's children collection ([see example](slug:loadmorebutton_treeview#managing-page-sizes)).
+     * Pass `null` as `dataItem` to set the root collection's page size.
      *
      * @param dataItem {any} - The parent data item of the targeted collection.
      * @param pageSize {number} - The new page size.

package/treeview.module.d.ts

@@ -20,6 +20,21 @@ import * as i14 from "./load-more/load-more-button-template.directive";
 import * as i15 from "./localization/custom-messages.component";
 /**
  * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the TreeView component.
+ *
+ * @example
+ * ```ts
+ * import { NgModule } from '@angular/core';
+ * import { BrowserModule } from '@angular/platform-browser';
+ * import { TreeViewModule } from '@progress/kendo-angular-treeview';
+ * import { AppComponent } from './app.component';
+ *
+ * @NgModule({
+ *   imports: [BrowserModule, TreeViewModule],
+ *   declarations: [AppComponent],
+ *   bootstrap: [AppComponent]
+ * })
+ * export class AppModule {}
+ * ```
  */
 export declare class TreeViewModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<TreeViewModule, never>;