DefinitelyTyped/rc-tree/index.d.ts

// Type definitions for rc-tree 1.4
// Project: https://github.com/react-component/tree
// Definitions by: John Reilly <https://github.com/johnnyreilly/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.1

import {
    Component,
    Props
} from "react";

export interface TreeNodeProps extends Props<TreeNode> {
    /**
     * additional css class for treeNode
     */
    className?: string;
    /**
     * whether treeNode is disabled
     */
    disabled?: boolean;
    /**
     * whether treeNode's checkbox is disabled
     */
    disableCheckbox?: boolean;
    /**
     * tree / subTree's title
     */
    title?: string | JSX.Element;
    /**
     * it's used with tree props (default)ExpandedKeys / (default)CheckedKeys / (default)SelectedKeys. You'd better set it, and it must be unique in the tree's all treeNodes
     */
    key?: string | number;
    /**
     * whether it is a leaf node
     */
    isLeaf?: boolean;
}

export class TreeNode extends Component<TreeNodeProps, {}> { }

export interface ExpandData {
    expanded: boolean;
    node: TreeNode;
}

export interface CheckData {
    checked: boolean;
    checkedNodes: TreeNode[];
    halfCheckedKeys: string[];
    node: TreeNode;
    event: "check";
}

export interface SelectData {
    selected: boolean;
    selectedNodes: TreeNode[];
    node: TreeNode;
    event: "select";
}


export interface TreeProps extends Props<Tree> {
    /**
     * additional css class of root dom node
     */
    className?: string;
    /**
     * prefix class
     */
    prefixCls?: string;
    /**
     * whether show line
     */
    showLine?: boolean;
    /**
     * whether show icon
     */
    showIcon?: boolean;
    /**
     * whether can be selected
     */
    selectable?: boolean;
    /**
     * whether multiple select
     */
    multiple?: boolean;
    /**
     * whether support checked
     */
    checkable?: boolean | JSX.Element;
    /**
     * default expand all treeNodes
     */
    defaultExpandAll?: boolean;
    /**
     * default expand specific treeNodes
     */
    defaultExpandedKeys?: string[];
    /**
     * control expanding of specific treeNodes
     */
    expandedKeys?: string[];
    /**
     * whether auto expand parent treeNodes
     */
    autoExpandParent?: boolean;
    /**
     * default checked treeNodes
     */
    defaultCheckedKeys?: string[];
    /**
     * Controlled checked treeNodes (After setting, defaultCheckedKeys will not work). Note: parent and children nodes are associated, if the parent node's key exists, it all children node will be checked, and vice versa. When set checkable and checkStrictly, it should be an object, which contains checked array and halfChecked array.
     */
    checkedKeys?: string[] | { checked: string[]; halfChecked: string[] };
    /**
     * check node precisely, parent and children nodes are not associated
     */
    checkStrictly?: boolean;
    /**
     * default selected treeNodes
     */
    defaultSelectedKeys?: string[];
    /**
     * Controlled selected treeNodes(After setting, defaultSelectedKeys will not work)
     */
    selectedKeys?: string[];
    /**
     * fire on treeNode expand or not
     */
    onExpand?: (expandedKeys: string[], e: ExpandData) => void;
    /**
     * click the treeNode/checkbox to fire
     */
    onCheck?: (checkedKeys: string[], e: CheckData) => void;
    /**
     * click the treeNode to fire
     */
    onSelect?: (selectedKeys: string[], e: SelectData) => void;
    /**
     * filter some treeNodes as you need.
     */
    filterTreeNode?: (node: TreeNode) => boolean;
    /**
     * load data asynchronously
     */
    loadData?: (node: TreeNode) => Promise<any>;
    /**
     * whether can drag treeNode.
     */
    draggable?: boolean;
}

export default class Tree extends Component<TreeProps, {}> { }