Interface TreeProps<T>

interface TreeProps<T> {
    activeKey?: null | Key;
    allowDrop?: AllowDrop<T>;
    autoExpandParent?: boolean;
    blockNode?: boolean;
    checkStrictly?: boolean;
    checkable?: boolean;
    checkedKeys?: Key[] | {
        checked: Key[];
        halfChecked: Key[];
    };
    children?: ReactNode;
    className?: string;
    defaultCheckedKeys?: Key[];
    defaultExpandAll?: boolean;
    defaultExpandParent?: boolean;
    defaultExpandedKeys?: Key[];
    defaultSelectedKeys?: Key[];
    disabled?: boolean;
    draggable?: boolean | DraggableFn | DraggableConfig;
    dropIndicatorRender?: ((props) => ReactNode);
    expandAction?: ExpandAction;
    expandedKeys?: Key[];
    fieldNames?: FieldNames;
    filterAntTreeNode?: ((node) => boolean);
    filterTreeNode?: ((treeNode) => boolean);
    focusable?: boolean;
    height?: number;
    icon?: null | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | PromiseLikeOfReactNode | ((nodeProps) => ReactNode) | ((props) => ReactNode);
    itemHeight?: number;
    itemScrollOffset?: number;
    loadData?: ((treeNode) => Promise<any>);
    loadedKeys?: Key[];
    motion?: any;
    multiple?: boolean;
    onActiveChange?: ((key) => void);
    onBlur?: FocusEventHandler<HTMLDivElement>;
    onCheck?: ((checked, info) => void);
    onClick?: NodeMouseEventHandler<T>;
    onContextMenu?: MouseEventHandler<HTMLDivElement>;
    onDoubleClick?: NodeMouseEventHandler<T>;
    onDragEnd?: ((info) => void);
    onDragEnter?: ((info) => void);
    onDragLeave?: ((info) => void);
    onDragOver?: ((info) => void);
    onDragStart?: ((info) => void);
    onDrop?: ((info) => void);
    onExpand?: ((expandedKeys, info) => void);
    onFocus?: FocusEventHandler<HTMLDivElement>;
    onKeyDown?: KeyboardEventHandler<HTMLDivElement>;
    onLoad?: ((loadedKeys, info) => void);
    onMouseEnter?: ((info) => void);
    onMouseLeave?: ((info) => void);
    onRightClick?: ((info) => void);
    onScroll?: UIEventHandler<HTMLElement>;
    onSelect?: ((selectedKeys, info) => void);
    prefixCls?: string;
    rootClassName?: string;
    rootStyle?: CSSProperties;
    selectable?: boolean;
    selectedKeys?: Key[];
    showIcon?: boolean;
    showLine?: boolean | {
        showLeafIcon: TreeLeafIcon;
    };
    style?: CSSProperties;
    switcherIcon?: null | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | PromiseLikeOfReactNode | ((props) => ReactNode) | ((props) => ReactNode);
    tabIndex?: number;
    titleRender?: ((node) => ReactNode);
    treeData?: T[];
    virtual?: boolean;
}

Type Parameters

Hierarchy

  • Omit<RcTreeProps<T>, "prefixCls" | "showLine" | "direction" | "draggable" | "icon" | "switcherIcon">
    • TreeProps

Properties

activeKey? allowDrop? autoExpandParent? blockNode? checkStrictly? checkable? checkedKeys? children? className? defaultCheckedKeys? defaultExpandAll? defaultExpandParent? defaultExpandedKeys? defaultSelectedKeys? disabled? draggable? dropIndicatorRender? expandAction? expandedKeys? fieldNames? filterAntTreeNode? filterTreeNode? focusable? height? icon? itemHeight? itemScrollOffset? loadData? loadedKeys? motion? multiple? onActiveChange? onBlur? onCheck? onClick? onContextMenu? onDoubleClick? onDragEnd? onDragEnter? onDragLeave? onDragOver? onDragStart? onDrop? onExpand? onFocus? onKeyDown? onLoad? onMouseEnter? onMouseLeave? onRightClick? onScroll? onSelect? prefixCls? rootClassName? rootStyle? selectable? selectedKeys? showIcon? showLine? style? switcherIcon? tabIndex? titleRender? treeData? virtual?

Properties

Optional activeKey

activeKey?: null | Key

Optional allowDrop

allowDrop?: AllowDrop<T>

Optional autoExpandParent

autoExpandParent?: boolean

Whether to automatically expand the parent node

Optional blockNode

blockNode?: boolean

Optional checkStrictly

checkStrictly?: boolean

Node selection in Checkable state is fully controlled (the selected state of parent and child nodes is no longer associated)

Optional checkable

checkable?: boolean

Whether to support selection

Optional checkedKeys

checkedKeys?: Key[] | {
    checked: Key[];
    halfChecked: Key[];
}

(Controlled) Tree node with checked checkbox

Type declaration

  • checked: Key[]
  • halfChecked: Key[]

Optional children

children?: ReactNode

Optional className

className?: string

Optional defaultCheckedKeys

defaultCheckedKeys?: Key[]

Tree node with checkbox checked by default

Optional defaultExpandAll

defaultExpandAll?: boolean

Expand all tree nodes by default

Optional defaultExpandParent

defaultExpandParent?: boolean

Expand the corresponding tree node by default

Optional defaultExpandedKeys

defaultExpandedKeys?: Key[]

Expand the specified tree node by default

Optional defaultSelectedKeys

defaultSelectedKeys?: Key[]

Tree node selected by default

Optional disabled

disabled?: boolean

whether to disable the tree

Optional draggable

draggable?: boolean | DraggableFn | DraggableConfig

Set the node to be draggable (IE>8)

Optional dropIndicatorRender

dropIndicatorRender?: ((props) => ReactNode)

Type declaration

    • (props): ReactNode

    • Parameters

      • props: {
            direction: Direction;
            dropLevelOffset: number;
            dropPosition: 0 | 1 | -1;
            indent: number;
            prefixCls: string;
        }
        • direction: Direction
        • dropLevelOffset: number
        • dropPosition: 0 | 1 | -1
        • indent: number
        • prefixCls: string

      Returns ReactNode

Optional expandAction

expandAction?: ExpandAction

Optional expandedKeys

expandedKeys?: Key[]

(Controlled) Expand the specified tree node

Optional fieldNames

fieldNames?: FieldNames

Optional filterAntTreeNode

filterAntTreeNode?: ((node) => boolean)

Click on the tree node to trigger

Type declaration

    • (node): boolean

    • Click on the tree node to trigger

      Parameters

      • node: AntTreeNode

      Returns boolean

Optional filterTreeNode

filterTreeNode?: ((treeNode) => boolean)

Type declaration

    • (treeNode): boolean

    • Parameters

      • treeNode: EventDataNode<T>

      Returns boolean

Optional focusable

focusable?: boolean

Optional height

height?: number

Optional icon

icon?: null | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | PromiseLikeOfReactNode | ((nodeProps) => ReactNode) | ((props) => ReactNode)

Type declaration

    • (nodeProps): ReactNode

    • Parameters

      • nodeProps: AntdTreeNodeAttribute

      Returns ReactNode

Type declaration

    • (props): ReactNode

    • Parameters

      Returns ReactNode

Optional itemHeight

itemHeight?: number

Optional itemScrollOffset

itemScrollOffset?: number

Optional loadData

loadData?: ((treeNode) => Promise<any>)

Type declaration

    • (treeNode): Promise<any>

    • Parameters

      • treeNode: EventDataNode<T>

      Returns Promise<any>

Optional loadedKeys

loadedKeys?: Key[]

Optional motion

motion?: any

Optional multiple

multiple?: boolean

Whether to support multiple selection

Optional onActiveChange

onActiveChange?: ((key) => void)

Used for rc-tree-select only. Do not use in your production code directly since this will be refactor.

Type declaration

    • (key): void

    • Used for rc-tree-select only. Do not use in your production code directly since this will be refactor.

      Parameters

      • key: Key

      Returns void

Optional onBlur

onBlur?: FocusEventHandler<HTMLDivElement>

Optional onCheck

onCheck?: ((checked, info) => void)

Type declaration

    • (checked, info): void

    • Parameters

      • checked: Key[] | {
            checked: Key[];
            halfChecked: Key[];
        }
      • info: CheckInfo<T>

      Returns void

Optional onClick

onClick?: NodeMouseEventHandler<T>

Optional onContextMenu

onContextMenu?: MouseEventHandler<HTMLDivElement>

Optional onDoubleClick

onDoubleClick?: NodeMouseEventHandler<T>

Optional onDragEnd

onDragEnd?: ((info) => void)

Type declaration

    • (info): void

    • Parameters

      • info: NodeDragEventParams<T>

      Returns void

Optional onDragEnter

onDragEnter?: ((info) => void)

Type declaration

    • (info): void

    • Parameters

      • info: NodeDragEventParams<T> & {
            expandedKeys: Key[];
        }

      Returns void

Optional onDragLeave

onDragLeave?: ((info) => void)

Type declaration

    • (info): void

    • Parameters

      • info: NodeDragEventParams<T>

      Returns void

Optional onDragOver

onDragOver?: ((info) => void)

Type declaration

    • (info): void

    • Parameters

      • info: NodeDragEventParams<T>

      Returns void

Optional onDragStart

onDragStart?: ((info) => void)

Type declaration

    • (info): void

    • Parameters

      • info: NodeDragEventParams<T>

      Returns void

Optional onDrop

onDrop?: ((info) => void)

Type declaration

    • (info): void

    • Parameters

      • info: NodeDragEventParams<T> & {
            dragNode: EventDataNode<T>;
            dragNodesKeys: Key[];
            dropPosition: number;
            dropToGap: boolean;
        }

      Returns void

Optional onExpand

onExpand?: ((expandedKeys, info) => void)

Type declaration

    • (expandedKeys, info): void

    • Parameters

      • expandedKeys: Key[]
      • info: {
            expanded: boolean;
            nativeEvent: MouseEvent;
            node: EventDataNode<T>;
        }
        • expanded: boolean
        • nativeEvent: MouseEvent
        • node: EventDataNode<T>

      Returns void

Optional onFocus

onFocus?: FocusEventHandler<HTMLDivElement>

Optional onKeyDown

onKeyDown?: KeyboardEventHandler<HTMLDivElement>

Optional onLoad

onLoad?: ((loadedKeys, info) => void)

Type declaration

    • (loadedKeys, info): void

    • Parameters

      • loadedKeys: Key[]
      • info: {
            event: "load";
            node: EventDataNode<T>;
        }
        • event: "load"
        • node: EventDataNode<T>

      Returns void

Optional onMouseEnter

onMouseEnter?: ((info) => void)

Type declaration

    • (info): void

    • Parameters

      • info: NodeMouseEventParams<T>

      Returns void

Optional onMouseLeave

onMouseLeave?: ((info) => void)

Type declaration

    • (info): void

    • Parameters

      • info: NodeMouseEventParams<T>

      Returns void

Optional onRightClick

onRightClick?: ((info) => void)

Type declaration

    • (info): void

    • Parameters

      Returns void

Optional onScroll

onScroll?: UIEventHandler<HTMLElement>

Optional onSelect

onSelect?: ((selectedKeys, info) => void)

Type declaration

    • (selectedKeys, info): void

    • Parameters

      • selectedKeys: Key[]
      • info: {
            event: "select";
            nativeEvent: MouseEvent;
            node: EventDataNode<T>;
            selected: boolean;
            selectedNodes: T[];
        }
        • event: "select"
        • nativeEvent: MouseEvent
        • node: EventDataNode<T>
        • selected: boolean
        • selectedNodes: T[]

      Returns void

Optional prefixCls

prefixCls?: string

Optional rootClassName

rootClassName?: string

Optional rootStyle

rootStyle?: CSSProperties

Optional selectable

selectable?: boolean

Optional selectedKeys

selectedKeys?: Key[]

(Controlled) Set the selected tree node

Optional showIcon

showIcon?: boolean

Optional showLine

showLine?: boolean | {
    showLeafIcon: TreeLeafIcon;
}

Type declaration

  • showLeafIcon: TreeLeafIcon

Optional style

style?: CSSProperties

Optional switcherIcon

switcherIcon?: null | string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | PromiseLikeOfReactNode | ((props) => ReactNode) | ((props) => ReactNode)

Type declaration

    • (props): ReactNode

    • Parameters

      Returns ReactNode

Type declaration

    • (props): ReactNode

    • Parameters

      Returns ReactNode

Optional tabIndex

tabIndex?: number

Optional titleRender

titleRender?: ((node) => ReactNode)

Type declaration

    • (node): ReactNode

    • Parameters

      • node: T

      Returns ReactNode

Optional treeData

treeData?: T[]

Optional virtual

virtual?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc