rsuite/esm/Tree/Tree.d.ts

A suite of react components

import React from 'react';
import { StandardProps, ItemDataType, RsRefForwardingComponent } from '../@types/common';
import { ListProps } from 'react-virtualized/dist/commonjs/List';
/**
 * Tree Node Drag Type
 */
export declare enum TREE_NODE_DROP_POSITION {
    DRAG_OVER = 0,
    DRAG_OVER_TOP = 1,
    DRAG_OVER_BOTTOM = 2
}
export interface DropData<ItemDataType> {
    /** drag node data */
    dragNode: ItemDataType;
    /** dropNode data */
    dropNode: ItemDataType;
    /** node drop position */
    dropNodePosition: TREE_NODE_DROP_POSITION;
    /** Update Data when drop node */
    createUpdateDataFunction: (data: ItemDataType[]) => ItemDataType[];
}
export interface TreeDragProps<ItemDataType = Record<string, any>> {
    /** Whether the node can  be dragged */
    draggable?: boolean;
    /** Called when scrolling */
    onScroll?: (event: React.SyntheticEvent) => void;
    /** Called when node drag start */
    onDragStart?: (nodeData: ItemDataType, e: React.DragEvent) => void;
    /** Called when node drag enter */
    onDragEnter?: (nodeData: ItemDataType, e: React.DragEvent) => void;
    /** Called when node drag over */
    onDragOver?: (nodeData: ItemDataType, e: React.DragEvent) => void;
    /** Called when node drag leave */
    onDragLeave?: (nodeData: ItemDataType, e: React.DragEvent) => void;
    /** Called when node drag end */
    onDragEnd?: (nodeData: ItemDataType, e: React.DragEvent) => void;
    /** Called when node drop */
    onDrop?: (dropData: DropData<ItemDataType>, e: React.DragEvent) => void;
}
export interface TreeBaseProps<ValueType = string | number, ItemDataType = Record<string, any>> extends StandardProps {
    /** The height of Dropdown */
    height?: number;
    /** Whether display search input box */
    searchable?: boolean;
    /** Display an auxiliary line when the tree node is indented. */
    showIndentLine?: boolean;
    /** Whether using virtualized list */
    virtualized?: boolean;
    /**
     * List-related properties in `react-virtualized`
     * https://github.com/bvaughn/react-virtualized/blob/master/docs/List.md#prop-types
     */
    listProps?: ListProps;
    /** Expand all nodes By default */
    defaultExpandAll?: boolean;
    /** searchKeyword (Controlled) */
    searchKeyword?: string;
    /** Set the option value for the expand node */
    defaultExpandItemValues?: any[];
    /** Set the option value for the expand node with controlled*/
    expandItemValues?: any[];
    /** Callback function for data change */
    onExpand?: (expandItemValues: ItemDataType[], activeNode: ItemDataType, concat: (data: ItemDataType[], children: ItemDataType[]) => ItemDataType[]) => void;
    /** Callback function after selecting tree node */
    onSelect?: (activeNode: ItemDataType, value: ValueType, event: React.SyntheticEvent) => void;
    /** Custom Render tree Node */
    renderTreeNode?: (nodeData: ItemDataType) => React.ReactNode;
    /** Custom Render icon */
    renderTreeIcon?: (nodeData: ItemDataType) => React.ReactNode;
    /** callback fired when search */
    onSearch?: (searchKeyword: string, event: React.KeyboardEvent<HTMLInputElement>) => void;
    /** Called when clean */
    onClean?: (event: React.SyntheticEvent) => void;
    /** Custom search rules. */
    searchBy?: (keyword: string, label: React.ReactNode, item: any) => boolean;
    /** Customizing the Rendering Menu list */
    renderMenu?: (menu: React.ReactNode) => React.ReactNode;
    /** load node children data asynchronously */
    getChildren?: (activeNode: ItemDataType) => ItemDataType[] | Promise<ItemDataType>;
}
export interface TreeProps<ValueType = string | number> extends TreeBaseProps<ValueType, ItemDataType>, TreeDragProps<ItemDataType> {
    /** Tree Data */
    data: ItemDataType[];
    /** Selected value */
    value?: ValueType;
    /** Whether using virtualized list */
    virtualized?: boolean;
    /** Tree data structure Label property name */
    labelKey?: string;
    /** Tree data Structure Value property name */
    valueKey?: string;
    /** Tree data structure Children property name */
    childrenKey?: string;
    /** Default selected Value  */
    defaultValue?: ValueType;
}
declare const Tree: RsRefForwardingComponent<'div', TreeProps>;
export default Tree;