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

package/esm2022/treeview.module.mjs

@@ -27,6 +27,21 @@ import * as i15 from "./localization/custom-messages.component";
 //IMPORTANT: NgModule export kept for backwards compatibility
 /**
  * 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 class TreeViewModule {
     static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: TreeViewModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });

package/expand.directive.d.ts

@@ -15,8 +15,19 @@ interface ExpandTreeItem extends TreeItem {
     expand: boolean;
 }
 /**
- * A directive which manages the expanded state of the TreeView.
- * ([see example]({% slug expandedstate_treeview %})).
+ * Represents a directive that manages the expanded state of the TreeView
+ * ([see example](slug:expandedstate_treeview)).
+ *
+ * @example
+ * ```html
+ * <kendo-treeview
+ *     kendoTreeViewExpandable
+ *     expandBy="id"
+ *     [(expandedKeys)]="expandedKeys"
+ *     [expandOnFilter]="true"
+ *     [nodes]="data">
+ * </kendo-treeview>
+ * ```
  */
 export declare class ExpandDirective implements OnDestroy, OnChanges {
     protected component: ExpandableComponent;
@@ -25,27 +36,27 @@ export declare class ExpandDirective implements OnDestroy, OnChanges {
      */
     set isExpanded(value: (item: object, index: string) => boolean);
     /**
-     * Defines the item key that will be stored in the `expandedKeys` collection.
+     * Defines the item key stored in the `expandedKeys` collection.
      */
     expandKey: string | ((context: TreeItem) => any);
     /**
-     * Whether or not to auto-expand the nodes leading from the root node to each filter result.
-     * To fine-tune this behavior, pass a [`FilterExpandSettings`]({% slug api_treeview_filterexpandsettings %}) object to this input.
+     * Specifies whether to auto-expand the nodes leading from the root node to each filter result.
+     * To fine-tune this behavior, pass a [`FilterExpandSettings`](slug:api_treeview_filterexpandsettings) object to this input.
      * @default false
      */
     expandOnFilter: boolean | FilterExpandSettings;
     get filterExpandSettings(): FilterExpandSettings;
     /**
-     * Fires when the `expandedKeys` collection was updated.
+     * Fires when the `expandedKeys` collection updates.
      */
     expandedKeysChange: EventEmitter<any[]>;
     /**
-     * Defines the collection that will store the expanded keys.
+     * Defines the collection that stores the expanded keys.
      */
     expandedKeys: any[];
     protected subscriptions: Subscription;
     /**
-     * Reflectes the internal `expandedKeys` state.
+     * Reflects the internal `expandedKeys` state.
      */
     private state;
     private originalExpandedKeys;