choerodon-ui/es/tree/index.d.ts

An enterprise-class UI design language and React-based implementation

import React, { Component, CSSProperties, DragEvent, MouseEvent, ReactElement, ReactNode } from 'react';
import DirectoryTree from './DirectoryTree';
import { TreeNode, TreeProps as RcTreeProps } from '../rc-components/tree';
import { TreeNodeProps } from '../rc-components/tree/TreeNode';
import { DraggableProps } from '../rc-components/tree/contextTypes';
import { DataNode, EventDataNode, Key } from '../rc-components/tree/interface';
import ConfigContext, { ConfigContextValue } from '../config-provider/ConfigContext';
export { TreeNode };
export { EventDataNode, DataNode, TreeNodeProps };
export { ExpandAction as DirectoryTreeExpandAction, DirectoryTreeProps } from './DirectoryTree';
export interface C7ndTreeNodeAttribute {
    eventKey: string;
    prefixCls: string;
    className: string;
    expanded: boolean;
    selected: boolean;
    checked: boolean;
    halfChecked: boolean;
    children: ReactNode;
    title: ReactNode;
    pos: string;
    dragOver: boolean;
    dragOverGapTop: boolean;
    dragOverGapBottom: boolean;
    isLeaf: boolean;
    selectable: boolean;
    disabled: boolean;
    disableCheckbox: boolean;
}
export interface C7nTreeNodeProps {
    className?: string;
    checkable?: boolean;
    disabled?: boolean;
    disableCheckbox?: boolean;
    title?: string | ReactNode;
    key?: string;
    eventKey?: string;
    isLeaf?: boolean;
    checked?: boolean;
    expanded?: boolean;
    loading?: boolean;
    selected?: boolean;
    selectable?: boolean;
    icon?: ((treeNode: C7ndTreeNodeAttribute) => ReactNode) | ReactNode;
    children?: ReactNode;
    [customProp: string]: any;
}
export declare type C7nTreeNode = Component<C7nTreeNodeProps, {}>;
export interface C7nTreeNodeBaseEvent {
    node: C7nTreeNode;
    nativeEvent: MouseEvent;
}
export interface C7nTreeNodeCheckedEvent extends C7nTreeNodeBaseEvent {
    event: 'check';
    checked?: boolean;
    checkedNodes?: C7nTreeNode[];
}
export interface C7nTreeNodeSelectedEvent extends C7nTreeNodeBaseEvent {
    event: 'select';
    selected?: boolean;
    selectedNodes?: DataNode[];
}
export interface C7nTreeNodeExpandedEvent extends C7nTreeNodeBaseEvent {
    expanded?: boolean;
}
export interface C7nTreeNodeMouseEvent {
    node: C7nTreeNode;
    event: DragEvent<HTMLElement>;
}
export interface C7nTreeNodeDragEnterEvent extends C7nTreeNodeMouseEvent {
    expandedKeys: string[];
}
export interface C7nTreeNodeDropEvent {
    node: C7nTreeNode;
    dragNode: C7nTreeNode;
    dragNodesKeys: string[];
    dropPosition: number;
    dropToGap?: boolean;
    event: MouseEvent<HTMLElement>;
}
export declare type TreeNodeNormal = DataNode;
export interface TreeProps extends Omit<RcTreeProps, 'prefixCls' | 'showLine'> {
    showLine?: boolean | {
        showLeafIcon: boolean;
    };
    className?: string;
    /** 是否支持多选 */
    multiple?: boolean;
    /** 是否自动展开父节点 */
    autoExpandParent?: boolean;
    /** checkable状态下节点选择完全受控（父子节点选中状态不再关联） */
    checkStrictly?: boolean;
    /** 是否支持选中 */
    checkable?: boolean;
    /** 是否禁用树 */
    disabled?: boolean;
    /** 默认展开所有树节点 */
    defaultExpandAll?: boolean;
    /** 默认展开对应树节点 */
    defaultExpandParent?: boolean;
    /** 默认展开指定的树节点 */
    defaultExpandedKeys?: Key[];
    /** （受控）展开指定的树节点 */
    expandedKeys?: Key[];
    /** （受控）选中复选框的树节点 */
    checkedKeys?: Key[] | {
        checked: Key[];
        halfChecked: Key[];
    };
    /** 默认选中复选框的树节点 */
    defaultCheckedKeys?: Key[];
    /** （受控）设置选中的树节点 */
    selectedKeys?: Key[];
    /** 默认选中的树节点 */
    defaultSelectedKeys?: Key[];
    selectable?: boolean;
    loadedKeys?: string[];
    /** 设置节点可拖拽（IE>8） */
    draggable?: ((node?: DataNode) => boolean) | boolean | DraggableProps;
    style?: CSSProperties;
    showIcon?: boolean;
    icon?: ((nodeProps: C7ndTreeNodeAttribute) => ReactNode) | ReactNode;
    switcherIcon?: ReactElement<any>;
    prefixCls?: string;
    children?: ReactNode;
    blockNode?: boolean;
}
export default class Tree extends Component<TreeProps, any> {
    static displayName: string;
    static get contextType(): typeof ConfigContext;
    static TreeNode: React.FC<TreeNodeProps>;
    static DirectoryTree: typeof DirectoryTree;
    static defaultProps: {
        checkable: boolean;
        showIcon: boolean;
        openAnimation: {
            enter(node: HTMLElement, done: () => void): any;
            leave(node: HTMLElement, done: () => void): any;
            appear(node: HTMLElement, done: () => void): any;
        };
    };
    context: ConfigContextValue;
    renderSwitcherIcon: ({ isLeaf, loading }: C7nTreeNodeProps) => JSX.Element | null;
    tree: any;
    setTreeRef: (node: any) => void;
    getPrefixCls(): string;
    onKeyDown(e: any): any;
    render(): JSX.Element;
}