@progress/kendo-vue-treeview 3.3.3 → 3.3.5-dev.202206141337

package/dist/npm/TreeViewDragClue.js

@@ -26,7 +26,10 @@ var Vue = require("vue");
 var allVue = Vue;
 var gh = allVue.h;
 
-var kendo_vue_common_1 = require("@progress/kendo-vue-common"); // tslint:enable:max-line-length
+var kendo_vue_common_1 = require("@progress/kendo-vue-common");
+/**
+ * @hidden
+ */
 
 
 var TreeViewDragClueVue2 = {
@@ -84,5 +87,31 @@ var TreeViewDragClueVue2 = {
   }
 };
 exports.TreeViewDragClueVue2 = TreeViewDragClueVue2;
+/**
+ * Represents the Kendo UI for Vue Native TreeViewDragClue component which renders a clue when an item is dragged.
+ *
+ *
+ *  ## Methods
+ *
+ *  ### hide
+ *  Hides the TreeViewDragClue component.
+ *
+ *  ### show
+ *  Displays the TreeViewDragClue component.
+ *
+ *  #### Parameters
+ *  ##### top <span class='code'>number</span>
+ *  The `top` CSS position of the component.
+ *
+ *  ##### left <span class='code'>number</span>
+ *  The `left` CSS position of the component.
+ *
+ *  ##### text <span class='code'>string</span>
+ *  The text of the component.
+ *
+ *  ##### operationClassName <span class='code'>string</span>
+ *  The CSS class name which is related to the specific drop operation.
+ */
+
 var TreeViewDragClue = TreeViewDragClueVue2;
 exports.TreeViewDragClue = TreeViewDragClue;

package/dist/npm/TreeViewItem.d.ts

@@ -64,6 +64,12 @@ export interface TreeViewItemData {
  */
 export interface TreeViewItemAll extends Vue, TreeViewItemMethods, TreeViewItemData, TreeViewItemComputed, TreeViewItemState {
 }
+/**
+ * @hidden
+ */
 declare let TreeViewItemVue2: ComponentOptions<TreeViewItemAll, DefaultData<TreeViewItemData>, DefaultMethods<TreeViewItemAll>, TreeViewItemComputed, RecordPropsDefinition<TreeViewItemProps>>;
+/**
+ * @hidden
+ */
 declare const TreeViewItem: DefineComponent<TreeViewItemProps, any, TreeViewItemData, TreeViewItemComputed, TreeViewItemMethods, {}, {}, {}, string, TreeViewItemProps, TreeViewItemProps, {}>;
 export { TreeViewItem, TreeViewItemVue2 };

package/dist/npm/TreeViewItem.js

@@ -36,7 +36,10 @@ var kendo_vue_animation_1 = require("@progress/kendo-vue-animation");
 
 var consts_1 = require("./utils/consts");
 
-var sizeMap = kendo_vue_common_1.kendoThemeMaps.sizeMap; // tslint:enable:max-line-length
+var sizeMap = kendo_vue_common_1.kendoThemeMaps.sizeMap;
+/**
+ * @hidden
+ */
 
 var TreeViewItemVue2 = {
   name: 'KendoTreeViewItem',
@@ -406,5 +409,9 @@ var TreeViewItemVue2 = {
   }
 };
 exports.TreeViewItemVue2 = TreeViewItemVue2;
+/**
+ * @hidden
+ */
+
 var TreeViewItem = TreeViewItemVue2;
 exports.TreeViewItem = TreeViewItem;

package/dist/npm/TreeViewProps.d.ts

@@ -1,6 +1,6 @@
 import * as events from './events';
 /**
- * Represents the props of the [KendoReact TreeView component]({% slug overview_treeview %}).
+ * Represents the props of the [Kendo UI for Vue TreeView component]({% slug overview_treeview %}).
  */
 export interface TreeViewProps {
     /**

package/dist/npm/additionalTypes.ts

@@ -2,9 +2,20 @@
 import { DefineComponent } from 'vue';
 // @ts-ignore
 import * as Vue from 'vue';
+
+/**
+ * @hidden
+ */
 // @ts-ignore
 type Vue2type = Vue.default;
+
+/**
+ * @hidden
+ */
 // @ts-ignore
 import { RecordPropsDefinition, ComponentOptions } from 'vue/types/options';
+/**
+ * @hidden
+ */
 // @ts-ignore
 export { DefineComponent, RecordPropsDefinition, ComponentOptions, Vue2type };

package/dist/npm/handleTreeViewCheckChange.d.ts

@@ -18,50 +18,28 @@ export interface TreeViewCheckChangeSettings {
     checkParents?: boolean;
 }
 /**
+ *
  * A helper function which updates the check descriptor.
  *
- * @param event - The event that triggered the change.
- * @param check - The check descriptor that will be updated.
- * @param data - The TreeView items.
- * @param settings - The additional settings that configure the update of the check descriptor.
- * @param childrenField - The field that points to the dataItem sub items. Defaults to `items`.
- * The default behavior allows the selection of multiple items.
- * @returns - The updated copy of the input check descriptor.
  *
- * @example
- * ```jsx
- * class App extends React.Component {
- *    state = { check: [], items: tree };
- *    render() {
- *        return (
- *            <div>
- *                <TreeView
- *                    checkboxes={true} onCheckChange={this.onCheckChange}
- *                    data={processTreeViewItems(this.state.items, { check: this.state.check })}
- *                />
- *                <div style={{ marginTop: 5 }}>
- *                    <i>Press SPACE to check/uncheck the active item</i>
- *                    <div className="example-config">
- *                        Checked Indices: {this.state.check.join(",")}
- *                    </div>
- *                </div>
- *            </div>
- *        );
- *    }
- *    onCheckChange = (event) => {
- *        this.setState({ check: handleTreeViewCheckChange(event, this.state.check, this.state.items) });
- *    }
- * }
+ *  #### Parameters
+ *  ##### event <span class='code'>[TreeViewExpandChangeEvent]({% slug api_treeview_treeviewexpandchangeevent %})</span>
+ *  The event that triggered the change.
+ *
+ *  ##### check <span class='code'>string[] | [TreeViewCheckDescriptor]({% slug api_treeview_treeviewcheckdescriptor %})</span>
+ *  The check descriptor that will be updated.
+ *
+ *  ##### data? <span class='code'>any[] | null</span>
+ *  The TreeView items.
+ *
+ *  ##### settings <span class='code'>[TreeViewCheckChangeSettings]({% slug api_treeview_treeviewcheckchangesettings %})</span>
+ *  The additional settings that configure the update of the check descriptor.
  *
- * const tree = [ {
- *    text: 'Furniture', expanded: true, items: [
- *        { text: 'Tables & Chairs' }, { text: 'Sofas' }, { text: 'Occasional Furniture' } ]
- * }, {
- *    text: 'Decor', expanded: true, items: [
- *        { text: 'Bed Linen' }, { text: 'Curtains & Blinds' }, { text: 'Carpets' } ]
- * } ];
+ *  ##### childrenField? <span class='code'>string</span>
+ *  The field that points to the dataItem sub items. Defaults to `items`.
+ *  The default behavior allows the selection of multiple items.
  *
- * ReactDOM.render(<App />, document.querySelector('my-app'));
- * ```
+ *  #### Returns
+ *  <span class='code'>any</span> - The updated copy of the input check descriptor.
  */
 export declare function handleTreeViewCheckChange(event: TreeViewExpandChangeEvent, check: string[] | TreeViewCheckDescriptor, data?: any[] | null, settings?: TreeViewCheckChangeSettings, childrenField?: string): any;

package/dist/npm/handleTreeViewCheckChange.js

@@ -33,51 +33,29 @@ var itemIdUtils_1 = require("./utils/itemIdUtils");
 var misc_1 = require("./utils/misc");
 var consts_1 = require("./utils/consts");
 /**
+ *
  * A helper function which updates the check descriptor.
  *
- * @param event - The event that triggered the change.
- * @param check - The check descriptor that will be updated.
- * @param data - The TreeView items.
- * @param settings - The additional settings that configure the update of the check descriptor.
- * @param childrenField - The field that points to the dataItem sub items. Defaults to `items`.
- * The default behavior allows the selection of multiple items.
- * @returns - The updated copy of the input check descriptor.
  *
- * @example
- * ```jsx
- * class App extends React.Component {
- *    state = { check: [], items: tree };
- *    render() {
- *        return (
- *            <div>
- *                <TreeView
- *                    checkboxes={true} onCheckChange={this.onCheckChange}
- *                    data={processTreeViewItems(this.state.items, { check: this.state.check })}
- *                />
- *                <div style={{ marginTop: 5 }}>
- *                    <i>Press SPACE to check/uncheck the active item</i>
- *                    <div className="example-config">
- *                        Checked Indices: {this.state.check.join(",")}
- *                    </div>
- *                </div>
- *            </div>
- *        );
- *    }
- *    onCheckChange = (event) => {
- *        this.setState({ check: handleTreeViewCheckChange(event, this.state.check, this.state.items) });
- *    }
- * }
+ *  #### Parameters
+ *  ##### event <span class='code'>[TreeViewExpandChangeEvent]({% slug api_treeview_treeviewexpandchangeevent %})</span>
+ *  The event that triggered the change.
+ *
+ *  ##### check <span class='code'>string[] | [TreeViewCheckDescriptor]({% slug api_treeview_treeviewcheckdescriptor %})</span>
+ *  The check descriptor that will be updated.
+ *
+ *  ##### data? <span class='code'>any[] | null</span>
+ *  The TreeView items.
+ *
+ *  ##### settings <span class='code'>[TreeViewCheckChangeSettings]({% slug api_treeview_treeviewcheckchangesettings %})</span>
+ *  The additional settings that configure the update of the check descriptor.
  *
- * const tree = [ {
- *    text: 'Furniture', expanded: true, items: [
- *        { text: 'Tables & Chairs' }, { text: 'Sofas' }, { text: 'Occasional Furniture' } ]
- * }, {
- *    text: 'Decor', expanded: true, items: [
- *        { text: 'Bed Linen' }, { text: 'Curtains & Blinds' }, { text: 'Carpets' } ]
- * } ];
+ *  ##### childrenField? <span class='code'>string</span>
+ *  The field that points to the dataItem sub items. Defaults to `items`.
+ *  The default behavior allows the selection of multiple items.
  *
- * ReactDOM.render(<App />, document.querySelector('my-app'));
- * ```
+ *  #### Returns
+ *  <span class='code'>any</span> - The updated copy of the input check descriptor.
  */
 function handleTreeViewCheckChange(event, check, data, settings, childrenField) {
     if (settings === void 0) { settings = {}; }

package/dist/npm/main.d.ts

@@ -1,12 +1,12 @@
 import { TreeView } from './TreeView';
 import { TreeViewItemClickEvent, TreeViewExpandChangeEvent, TreeViewCheckChangeEvent, TreeViewItemDragOverEvent, TreeViewItemDragStartEvent, TreeViewItemDragEndEvent } from './events';
-import processTreeViewItems from './processTreeViewItems';
-import moveTreeViewItem from './moveTreeViewItem';
+import { processTreeViewItems } from './processTreeViewItems';
+import { moveTreeViewItem } from './moveTreeViewItem';
 import { handleTreeViewCheckChange, TreeViewCheckChangeSettings } from './handleTreeViewCheckChange';
 import { TreeViewOperationDescriptor, TreeViewOperationDescriptors, TreeViewCheckDescriptor } from './TreeViewOperationDescriptors';
 import { ItemRenderProps } from './ItemRenderProps';
 import { TreeViewProps } from './TreeViewProps';
 import { TreeViewDragClue } from './TreeViewDragClue';
-import TreeViewDragAnalyzer from './TreeViewDragAnalyzer';
+import { TreeViewDragAnalyzer } from './TreeViewDragAnalyzer';
 import { TreeViewItem } from './TreeViewItem';
 export { TreeViewItem, TreeView, processTreeViewItems, handleTreeViewCheckChange, TreeViewCheckChangeSettings, TreeViewItemClickEvent, TreeViewExpandChangeEvent, TreeViewCheckChangeEvent, TreeViewItemDragOverEvent, TreeViewItemDragStartEvent, TreeViewItemDragEndEvent, TreeViewOperationDescriptor, TreeViewOperationDescriptors, TreeViewCheckDescriptor, TreeViewProps, ItemRenderProps, TreeViewDragClue, moveTreeViewItem, TreeViewDragAnalyzer };

package/dist/npm/main.js

@@ -4,14 +4,14 @@ exports.TreeViewDragAnalyzer = exports.moveTreeViewItem = exports.TreeViewDragCl
 var TreeView_1 = require("./TreeView");
 Object.defineProperty(exports, "TreeView", { enumerable: true, get: function () { return TreeView_1.TreeView; } });
 var processTreeViewItems_1 = require("./processTreeViewItems");
-exports.processTreeViewItems = processTreeViewItems_1.default;
+Object.defineProperty(exports, "processTreeViewItems", { enumerable: true, get: function () { return processTreeViewItems_1.processTreeViewItems; } });
 var moveTreeViewItem_1 = require("./moveTreeViewItem");
-exports.moveTreeViewItem = moveTreeViewItem_1.default;
+Object.defineProperty(exports, "moveTreeViewItem", { enumerable: true, get: function () { return moveTreeViewItem_1.moveTreeViewItem; } });
 var handleTreeViewCheckChange_1 = require("./handleTreeViewCheckChange");
 Object.defineProperty(exports, "handleTreeViewCheckChange", { enumerable: true, get: function () { return handleTreeViewCheckChange_1.handleTreeViewCheckChange; } });
 var TreeViewDragClue_1 = require("./TreeViewDragClue");
 Object.defineProperty(exports, "TreeViewDragClue", { enumerable: true, get: function () { return TreeViewDragClue_1.TreeViewDragClue; } });
 var TreeViewDragAnalyzer_1 = require("./TreeViewDragAnalyzer");
-exports.TreeViewDragAnalyzer = TreeViewDragAnalyzer_1.default;
+Object.defineProperty(exports, "TreeViewDragAnalyzer", { enumerable: true, get: function () { return TreeViewDragAnalyzer_1.TreeViewDragAnalyzer; } });
 var TreeViewItem_1 = require("./TreeViewItem");
 Object.defineProperty(exports, "TreeViewItem", { enumerable: true, get: function () { return TreeViewItem_1.TreeViewItem; } });

package/dist/npm/moveTreeViewItem.d.ts

@@ -1,109 +1,43 @@
 /**
  *  A helper function which moves a TreeView item in an immutable way.
  *
- * @param sourceItemHierarchicalIndex - The hierarchical index of the item that will be moved.
- * @param sourceData - The tree which contains the item that will be moved.
- * @param operation - The specific move operation.
  *
- * The available options are:
- *  * `before`—Indicates that the source item will become the previous sibling of the target item.
- *  * `after`—Indicates that the source item will become the next sibling of the target item.
- *  * `child`—Indicates that the source item will become a child of the target item.
- * @param targetItemHierarchicalIndex - The hierarchical index of the item next to which the source item will be moved.
- * @param targetData - The tree which contains the target item.
- * If the argument is skipped, then the move operation will be executed within the same tree.
- * Setting the `sourceData` and `targetData` arguments to the same tree is also supported.
- * @param childrenField - The field that points to the dataItem sub items. Defaults to `items`.
- * @returns - The updated copies of the `sourceData` and `targetData` input arguments.
- * If `targetData` is not passed, then only the updated copy of the `sourceData` will be returned.
  *
- * @example
- * ```jsx
- * class App extends React.Component {
- *     dragClue;
- *     state = { tree };
+ *  #### Parameters
+ *  ##### sourceItemHierarchicalIndex <span class='code'>string</span>
+ *  The hierarchical index of the item that will be moved.
  *
- *     render() {
- *         return (
- *             <div>
- *                 <TreeView data={this.state.tree} draggable={true}
- *                     onItemDragOver={this.onItemDragOver} onItemDragEnd={this.onItemDragEnd} />
- *                 <TreeViewDragClue ref={dragClue => this.dragClue = dragClue} />
- *             </div>
- *         );
- *     }
+ *  ##### sourceData <span class='code'>any[] | null | undefined</span>
+ *  The tree which contains the item that will be moved.
  *
- *     onItemDragOver = (event) => {
- *         this.dragClue.show(event.pageY + 10, event.pageX, event.item.text, this.getClueClassName(event));
- *     }
- *     onItemDragEnd = (event) => {
- *         this.dragClue.hide();
- *         const eventAnalyzer = new TreeViewDragAnalyzer(event).init();
+ *  ##### operation <span class='code'>"before" | "after" | "child"</span>
+ *  The specific move operation.
  *
- *         if (eventAnalyzer.isDropAllowed) {
- *             const updatedTree = moveTreeViewItem(
- *                 event.itemHierarchicalIndex,
- *                 this.state.tree,
- *                 eventAnalyzer.getDropOperation(),
- *                 eventAnalyzer.destinationMeta.itemHierarchicalIndex,
- *             );
+ *  The available options are:
+ *   * `before`&mdash;Indicates that the source item will become the previous sibling of the target item.
+ *   * `after`&mdash;Indicates that the source item will become the next sibling of the target item.
+ *   * `child`&mdash;Indicates that the source item will become a child of the target item.
  *
- *             this.setState({ tree: updatedTree });
- *         }
- *     }
- *     getClueClassName(event) {
- *         const eventAnalyzer = new TreeViewDragAnalyzer(event).init();
- *         const itemIndex = eventAnalyzer.destinationMeta.itemHierarchicalIndex;
+ *  ##### targetItemHierarchicalIndex <span class='code'>string</span>
+ *  The hierarchical index of the item next to which the source item will be moved.
  *
- *         if (eventAnalyzer.isDropAllowed) {
- *             switch (eventAnalyzer.getDropOperation()) {
- *                 case 'child':
- *                     return 'k-i-plus';
- *                 case 'before':
- *                     return itemIndex === '0' || itemIndex.endsWith(`${SEPARATOR}0`) ?
- *                         'k-i-insert-up' : 'k-i-insert-middle';
- *                 case 'after':
- *                     const siblings = getSiblings(itemIndex, this.state.tree);
- *                     const lastIndex = Number(itemIndex.split(SEPARATOR).pop());
+ *  ##### targetData? <span class='code'>any[] | null</span>
+ *  The tree which contains the target item.
+ *  If the argument is skipped, then the move operation will be executed within the same tree.
+ *  Setting the `sourceData` and `targetData` arguments to the same tree is also supported.
  *
- *                     return lastIndex < siblings.length - 1 ? 'k-i-insert-middle' : 'k-i-insert-down';
- *                 default:
- *                     break;
- *             }
- *         }
+ *  ##### childrenField? <span class='code'>string</span>
+ *  The field that points to the dataItem sub items. Defaults to `items`.
  *
- *         return 'k-i-cancel';
- *     }
- * }
- *
- * function getSiblings(itemIndex, data) {
- *     let result = data;
- *
- *     const indices = itemIndex.split(SEPARATOR).map(index => Number(index));
- *     for (let i = 0; i < indices.length - 1; i++) {
- *         result = result[indices[i]].items;
- *     }
- *
- *     return result;
- * }
- *
- * const SEPARATOR = '_';
- * const tree = [{
- *     text: 'Furniture', expanded: true, items: [
- *         { text: 'Tables & Chairs', expanded: true },
- *         { text: 'Sofas', expanded: true },
- *         { text: 'Occasional Furniture', expanded: true }]
- * }, {
- *     text: 'Decor', expanded: true, items: [
- *         { text: 'Bed Linen', expanded: true },
- *         { text: 'Curtains & Blinds', expanded: true },
- *         { text: 'Carpets', expanded: true }]
- * }];
- *
- * ReactDOM.render(<App />, document.querySelector('my-app'));
- * ```
+ *  #### Returns
+ *  <span class='code'>any[] | { sourceData: any[]; targetData: any[]; }</span> - The updated copies of the `sourceData` and `targetData` input arguments.
+ *  If `targetData` is not passed, then only the updated copy of the `sourceData` will be returned.
  */
-export default function moveTreeViewItem(sourceItemHierarchicalIndex: string, sourceData: any[] | null | undefined, operation: 'before' | 'after' | 'child', targetItemHierarchicalIndex: string, targetData?: any[] | null, childrenField?: string): any[] | {
+declare const moveTreeViewItem: (sourceItemHierarchicalIndex: string, sourceData: any[] | null | undefined, operation: 'before' | 'after' | 'child', targetItemHierarchicalIndex: string, targetData?: any[] | null, childrenField?: string) => any[] | {
     sourceData: any[];
     targetData: any[];
 };
+/**
+ * @hidden
+ */
+export { moveTreeViewItem };

package/dist/npm/moveTreeViewItem.js

@@ -1,114 +1,45 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.moveTreeViewItem = void 0;
 var itemUtils_1 = require("./utils/itemUtils");
 var itemIdUtils_1 = require("./utils/itemIdUtils");
 var consts_1 = require("./utils/consts");
 /**
  *  A helper function which moves a TreeView item in an immutable way.
  *
- * @param sourceItemHierarchicalIndex - The hierarchical index of the item that will be moved.
- * @param sourceData - The tree which contains the item that will be moved.
- * @param operation - The specific move operation.
  *
- * The available options are:
- *  * `before`—Indicates that the source item will become the previous sibling of the target item.
- *  * `after`—Indicates that the source item will become the next sibling of the target item.
- *  * `child`—Indicates that the source item will become a child of the target item.
- * @param targetItemHierarchicalIndex - The hierarchical index of the item next to which the source item will be moved.
- * @param targetData - The tree which contains the target item.
- * If the argument is skipped, then the move operation will be executed within the same tree.
- * Setting the `sourceData` and `targetData` arguments to the same tree is also supported.
- * @param childrenField - The field that points to the dataItem sub items. Defaults to `items`.
- * @returns - The updated copies of the `sourceData` and `targetData` input arguments.
- * If `targetData` is not passed, then only the updated copy of the `sourceData` will be returned.
  *
- * @example
- * ```jsx
- * class App extends React.Component {
- *     dragClue;
- *     state = { tree };
+ *  #### Parameters
+ *  ##### sourceItemHierarchicalIndex <span class='code'>string</span>
+ *  The hierarchical index of the item that will be moved.
  *
- *     render() {
- *         return (
- *             <div>
- *                 <TreeView data={this.state.tree} draggable={true}
- *                     onItemDragOver={this.onItemDragOver} onItemDragEnd={this.onItemDragEnd} />
- *                 <TreeViewDragClue ref={dragClue => this.dragClue = dragClue} />
- *             </div>
- *         );
- *     }
+ *  ##### sourceData <span class='code'>any[] | null | undefined</span>
+ *  The tree which contains the item that will be moved.
  *
- *     onItemDragOver = (event) => {
- *         this.dragClue.show(event.pageY + 10, event.pageX, event.item.text, this.getClueClassName(event));
- *     }
- *     onItemDragEnd = (event) => {
- *         this.dragClue.hide();
- *         const eventAnalyzer = new TreeViewDragAnalyzer(event).init();
+ *  ##### operation <span class='code'>"before" | "after" | "child"</span>
+ *  The specific move operation.
  *
- *         if (eventAnalyzer.isDropAllowed) {
- *             const updatedTree = moveTreeViewItem(
- *                 event.itemHierarchicalIndex,
- *                 this.state.tree,
- *                 eventAnalyzer.getDropOperation(),
- *                 eventAnalyzer.destinationMeta.itemHierarchicalIndex,
- *             );
+ *  The available options are:
+ *   * `before`&mdash;Indicates that the source item will become the previous sibling of the target item.
+ *   * `after`&mdash;Indicates that the source item will become the next sibling of the target item.
+ *   * `child`&mdash;Indicates that the source item will become a child of the target item.
  *
- *             this.setState({ tree: updatedTree });
- *         }
- *     }
- *     getClueClassName(event) {
- *         const eventAnalyzer = new TreeViewDragAnalyzer(event).init();
- *         const itemIndex = eventAnalyzer.destinationMeta.itemHierarchicalIndex;
+ *  ##### targetItemHierarchicalIndex <span class='code'>string</span>
+ *  The hierarchical index of the item next to which the source item will be moved.
  *
- *         if (eventAnalyzer.isDropAllowed) {
- *             switch (eventAnalyzer.getDropOperation()) {
- *                 case 'child':
- *                     return 'k-i-plus';
- *                 case 'before':
- *                     return itemIndex === '0' || itemIndex.endsWith(`${SEPARATOR}0`) ?
- *                         'k-i-insert-up' : 'k-i-insert-middle';
- *                 case 'after':
- *                     const siblings = getSiblings(itemIndex, this.state.tree);
- *                     const lastIndex = Number(itemIndex.split(SEPARATOR).pop());
+ *  ##### targetData? <span class='code'>any[] | null</span>
+ *  The tree which contains the target item.
+ *  If the argument is skipped, then the move operation will be executed within the same tree.
+ *  Setting the `sourceData` and `targetData` arguments to the same tree is also supported.
  *
- *                     return lastIndex < siblings.length - 1 ? 'k-i-insert-middle' : 'k-i-insert-down';
- *                 default:
- *                     break;
- *             }
- *         }
+ *  ##### childrenField? <span class='code'>string</span>
+ *  The field that points to the dataItem sub items. Defaults to `items`.
  *
- *         return 'k-i-cancel';
- *     }
- * }
- *
- * function getSiblings(itemIndex, data) {
- *     let result = data;
- *
- *     const indices = itemIndex.split(SEPARATOR).map(index => Number(index));
- *     for (let i = 0; i < indices.length - 1; i++) {
- *         result = result[indices[i]].items;
- *     }
- *
- *     return result;
- * }
- *
- * const SEPARATOR = '_';
- * const tree = [{
- *     text: 'Furniture', expanded: true, items: [
- *         { text: 'Tables & Chairs', expanded: true },
- *         { text: 'Sofas', expanded: true },
- *         { text: 'Occasional Furniture', expanded: true }]
- * }, {
- *     text: 'Decor', expanded: true, items: [
- *         { text: 'Bed Linen', expanded: true },
- *         { text: 'Curtains & Blinds', expanded: true },
- *         { text: 'Carpets', expanded: true }]
- * }];
- *
- * ReactDOM.render(<App />, document.querySelector('my-app'));
- * ```
+ *  #### Returns
+ *  <span class='code'>any[] | { sourceData: any[]; targetData: any[]; }</span> - The updated copies of the `sourceData` and `targetData` input arguments.
+ *  If `targetData` is not passed, then only the updated copy of the `sourceData` will be returned.
  */
-function moveTreeViewItem(sourceItemHierarchicalIndex, sourceData, operation, targetItemHierarchicalIndex, targetData, childrenField) {
+var moveTreeViewItem = function (sourceItemHierarchicalIndex, sourceData, operation, targetItemHierarchicalIndex, targetData, childrenField) {
     var subItemsField = childrenField || consts_1.CHILDREN_FIELD;
     if (!validateInput()) {
         return prepareInputDataForReturn();
@@ -155,5 +86,5 @@ function moveTreeViewItem(sourceItemHierarchicalIndex, sourceData, operation, ta
         }
         return true;
     }
-}
-exports.default = moveTreeViewItem;
+};
+exports.moveTreeViewItem = moveTreeViewItem;

package/dist/npm/package-metadata.js

@@ -8,7 +8,7 @@ exports.packageMetadata = {
     name: '@progress/kendo-vue-treeview',
     productName: 'Kendo UI for Vue',
     productCodes: ['KENDOUIVUE', 'KENDOUICOMPLETE'],
-    publishDate: 1653914332,
+    publishDate: 1655213695,
     version: '',
     licensingDocsUrl: 'https://www.telerik.com/kendo-vue-ui/my-license/?utm_medium=product&utm_source=kendovue&utm_campaign=kendo-ui-vue-purchase-license-keys-warning'
 };

package/dist/npm/processTreeViewItems.d.ts

@@ -1,51 +1,21 @@
 import { TreeViewOperationDescriptors } from './TreeViewOperationDescriptors';
 /**
  * A helper function which applies the specified operation descriptors to the data.
- * * [Expanding and collapsing items]({% slug expansion_ways_treeview %}#toc-using-a-helper-function)
- * * [Selecting and deselecting items]({% slug selection_ways_treeview %}#toc-using-a-helper-function)
- * * [Checking and unchecking items]({% slug check_helper_funcs_treeview %})
+ * [Expanding and collapsing items]({% slug expansion_ways_treeview %}#toc-using-a-helper-function)
+ * [Selecting and deselecting items]({% slug selection_ways_treeview %}#toc-using-a-helper-function)
+ * [Checking and unchecking items]({% slug check_helper_funcs_treeview %})
  *
- * @param data - The data that will be processed.
- * @param operations - The operation descriptors that will be applied to the data.
- * @returns - The processed copy of the input data.
  *
- * @example
- * ```jsx
- * class App extends React.Component {
- *     state = { items: tree, expand: [], select: [], check: [] };
- *     render() {
- *         const { expand, select, check } = this.state;
- *         return (
- *             <TreeView
- *                 data={processTreeViewItems(this.state.items, { expand, select, check })}
- *                 expandIcons={true} onExpandChange={this.onExpandChange} checkboxes={true}
- *                 onCheckChange={event => this.setState({ check: [ event.itemHierarchicalIndex ] })}
- *                 onItemClick={event => this.setState({ select: [ event.itemHierarchicalIndex ] })}
- *             />
- *         );
- *     }
- *     onExpandChange = (event) => {
- *         let expand = this.state.expand.slice();
- *         const index = expand.indexOf(event.itemHierarchicalIndex);
- *         index === -1 ? expand.push(event.itemHierarchicalIndex) : expand.splice(index, 1);
- *         this.setState({ expand });
- *     }
- * }
  *
- * const tree = [{
- *     text: 'Item1',
- *     items: [
- *         { text: 'Item1.1' },
- *         { text: 'Item1.2' },
- *         { text: 'Item1.3', items: [{ text: 'Item1.3.1' }] }]
- * }, {
- *     text: 'Item2', disabled: true,
- *     items: [{ text: 'Item2.1' }, { text: 'Item2.2' }, { text: 'Item2.3' }]
- * }, {
- *     text: 'Item3'
- * }];
+ * #### Parameters
+ * ##### data <span class='code'>any[] | null | undefined</span>
+ * The data that will be processed.
  *
- * ReactDOM.render(<App />, document.querySelector('my-app'));
- * ```
+ * ##### operations <span class='code'>[TreeViewOperationDescriptors]({% slug api_treeview_treeviewoperationdescriptors %})</span>
+ * The operation descriptors that will be applied to the data.
+ *
+ * #### Returns
+ * <span class='code'>any[]</span> - The processed copy of the input data.
  */
-export default function processTreeViewItems(data: any[] | null | undefined, operations: TreeViewOperationDescriptors): any[];
+declare const processTreeViewItems: (data: any[] | null | undefined, operations: TreeViewOperationDescriptors) => any[];
+export { processTreeViewItems };