@progress/kendo-react-treeview 7.2.4-develop.3 → 7.2.4-develop.4

package/handleTreeViewCheckChange.d.ts

@@ -1,73 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-import { TreeViewExpandChangeEvent } from './events';
-import { TreeViewCheckDescriptor } from './TreeViewOperationDescriptors';
-/**
- * The settings that configure the update of the check descriptor.
- */
-export interface TreeViewCheckChangeSettings {
-    /**
-     * Determines a selection of a single node at a time.
-     */
-    singleMode?: boolean;
-    /**
-     * Determines if the children checkboxes will be selected when the user selects the parent checkbox.
-     */
-    checkChildren?: boolean;
-    /**
-     * Determines if the parent checkbox will be selected when the user selects all its children checkboxes.
-     */
-    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) });
- *    }
- * }
- *
- * 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' } ]
- * } ];
- *
- * ReactDOM.render(<App />, document.querySelector('my-app'));
- * ```
- */
-export declare function handleTreeViewCheckChange(event: TreeViewExpandChangeEvent, check: string[] | TreeViewCheckDescriptor, data?: any[] | null, settings?: TreeViewCheckChangeSettings, childrenField?: string): any[] | (TreeViewCheckDescriptor & {
-    ids: any[];
-});

package/moveTreeViewItem.d.ts

@@ -1,113 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-/**
- *  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 };
- *
- *     render() {
- *         return (
- *             <div>
- *                 <TreeView data={this.state.tree} draggable={true}
- *                     onItemDragOver={this.onItemDragOver} onItemDragEnd={this.onItemDragEnd} />
- *                 <TreeViewDragClue ref={dragClue => this.dragClue = dragClue} />
- *             </div>
- *         );
- *     }
- *
- *     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();
- *
- *         if (eventAnalyzer.isDropAllowed) {
- *             const updatedTree = moveTreeViewItem(
- *                 event.itemHierarchicalIndex,
- *                 this.state.tree,
- *                 eventAnalyzer.getDropOperation(),
- *                 eventAnalyzer.destinationMeta.itemHierarchicalIndex,
- *             );
- *
- *             this.setState({ tree: updatedTree });
- *         }
- *     }
- *     getClueClassName(event) {
- *         const eventAnalyzer = new TreeViewDragAnalyzer(event).init();
- *         const itemIndex = eventAnalyzer.destinationMeta.itemHierarchicalIndex;
- *
- *         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());
- *
- *                     return lastIndex < siblings.length - 1 ? 'k-i-insert-middle' : 'k-i-insert-down';
- *                 default:
- *                     break;
- *             }
- *         }
- *
- *         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'));
- * ```
- */
-export declare function moveTreeViewItem(sourceItemHierarchicalIndex: string, sourceData: any[] | null | undefined, operation: 'before' | 'after' | 'child', targetItemHierarchicalIndex: string, targetData?: any[] | null, childrenField?: string): any[] | {
-    sourceData: any[] | null | undefined;
-    targetData: any[];
-} | null | undefined;

package/package-metadata.d.ts

@@ -1,9 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-import { PackageMetadata } from '@progress/kendo-licensing';
-/**
- * @hidden
- */
-export declare const packageMetadata: PackageMetadata;

package/processTreeViewItems.d.ts

@@ -1,55 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-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 %})
- *
- * @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'
- * }];
- *
- * ReactDOM.render(<App />, document.querySelector('my-app'));
- * ```
- */
-export declare function processTreeViewItems(data: any[] | null | undefined, operations: TreeViewOperationDescriptors): any[];

package/utils/consts.d.ts

@@ -1,44 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-/**
- * @hidden
- */
-export declare const EXPAND_FIELD = "expanded";
-/**
- * @hidden
- */
-export declare const TEXT_FIELD = "text";
-/**
- * @hidden
- */
-export declare const DISABLED_FIELD = "disabled";
-/**
- * @hidden
- */
-export declare const CHILDREN_FIELD = "items";
-/**
- * @hidden
- */
-export declare const HAS_CHILDREN_FIELD = "hasChildren";
-/**
- * @hidden
- */
-export declare const SELECT_FIELD = "selected";
-/**
- * @hidden
- */
-export declare const CHECK_FIELD = "checked";
-/**
- * @hidden
- */
-export declare const CHECK_INDETERMINATE_FIELD = "checkIndeterminate";
-/**
- * @hidden
- */
-export declare const DOM_KENDO_ITEM_ID_FIELD = "_kendoItemId";
-/**
- * @hidden
- */
-export declare const DOM_KENDO_TREEVIEW_GUID_FIELD = "_kendoTreeViewGuid";

package/utils/getItemIdUponKeyboardNavigation.d.ts

@@ -1,9 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-import { TreeFieldsService } from '@progress/kendo-react-common';
-/**
- * @hidden
- */
-export default function getItemIdUponKeyboardNavigation(item: any, itemId: string, items: any[], keyCode: number, fieldsSvc: TreeFieldsService): any;