Interface TreeProps<T, K>

Public

interface TreeProps<T, K> {
    actions?: TreeNodeActionItem<T, K>[];
    addText?: ReactNode;
    allowDragOver?: ((event: DragEvent<HTMLDivElement>, dropToNode: TreeNodeType<T, K>, draggedNode?: TreeNodeType<T, K>) => boolean);
    canAdd?: boolean;
    canHasChildren?: boolean | TreeNodeConditionFunc<T, K>;
    canSelectDisabled?: boolean;
    colorScheme?: ColorScheme;
    columns: TreeColumn<T, K>[];
    cursorKey?: string;
    disabledNodes?: K[];
    externalDraggedNode?: TreeNodeType<T, K>;
    filter?: ((node: TreeNodeType<T, K>) => boolean);
    flatNodes?: T[];
    isActionsEnabled?: ((node: TreeNodeType<T, K>) => boolean);
    isAddButtonDisabled?: boolean;
    isAutoHeightFill?: boolean;
    isDeletable?: boolean | TreeNodeConditionFunc<T, K>;
    isDraggable?: boolean;
    isEditable?: boolean | TreeNodeConditionFunc<T, K>;
    isLoading?: boolean;
    isStriped?: boolean;
    maxRowsBeforeOverflow?: number;
    nodeRenderer?: ((node: TreeNodeType<T, K>, nodeProps: TreeNodeProps<T, K>, defaultRenderer: ((node: TreeNodeType<T, K>, props: TreeNodeProps<T, K>) => ReactElement<any, string | JSXElementConstructor<any>>)) => ReactElement<any, string | JSXElementConstructor<any>>);
    nodes: TreeNodeType<T, K>[];
    onAddNode?: (() => void);
    onBeforeNodeSelect?: ((node: TreeNodeType<T, K>) => boolean);
    onDragEnd?: ((event: DragEvent<HTMLDivElement>) => void);
    onDragStart?: ((event: DragEvent<HTMLDivElement>, node: TreeNodeType<T, K>) => void);
    onDrop?: ((event: DragEvent<HTMLDivElement>, node: TreeNodeType<T, K>) => void);
    onEdit?: ((node: TreeNodeType<T, K>, newValue: string, cellId: string) => void);
    onMoveNode?: ((node: TreeNodeType<T, K>, parentNode?: TreeNodeType<T, K>, previousNode?: TreeNodeType<T, K>) => void);
    onNodeCollapse?: ((node: TreeNodeType<T, K>) => void);
    onNodeDelete?: ((node: TreeNodeType<T, K>) => void);
    onNodeDoubleClick?: ((node: TreeNodeType<T, K>, event: SyntheticEvent<HTMLDivElement, Event>) => void);
    onNodeExpand?: ((node: TreeNodeType<T, K>) => void);
    onNodeMouseEnter?: ((node: TreeNodeType<T, K>) => void);
    onNodeMouseLeave?: ((node: TreeNodeType<T, K>) => void);
    onNodeSelect?: ((node: TreeNodeType<T, K>) => void);
    rightExtraItem?: ((nodeData: T) => ReactNode);
    selectedNodes: K[];
}

Type Parameters

Properties

actions? addText? allowDragOver? canAdd? canHasChildren? canSelectDisabled? colorScheme? columns cursorKey? disabledNodes? externalDraggedNode? filter? flatNodes? isActionsEnabled? isAddButtonDisabled? isAutoHeightFill? isDeletable? isDraggable? isEditable? isLoading? isStriped? maxRowsBeforeOverflow? nodeRenderer? nodes onAddNode? onBeforeNodeSelect? onDragEnd? onDragStart? onDrop? onEdit? onMoveNode? onNodeCollapse? onNodeDelete? onNodeDoubleClick? onNodeExpand? onNodeMouseEnter? onNodeMouseLeave? onNodeSelect? rightExtraItem? selectedNodes

Properties

Optionalactions

actions?: TreeNodeActionItem<T, K>[]

OptionaladdText

addText?: ReactNode

OptionalallowDragOver

allowDragOver?: ((event: DragEvent<HTMLDivElement>, dropToNode: TreeNodeType<T, K>, draggedNode?: TreeNodeType<T, K>) => boolean)

OptionalcanAdd

canAdd?: boolean

OptionalcanHasChildren

canHasChildren?: boolean | TreeNodeConditionFunc<T, K>

OptionalcanSelectDisabled

canSelectDisabled?: boolean

OptionalcolorScheme

colorScheme?: ColorScheme

columns

columns: TreeColumn<T, K>[]

OptionalcursorKey

cursorKey?: string

OptionaldisabledNodes

disabledNodes?: K[]

OptionalexternalDraggedNode

externalDraggedNode?: TreeNodeType<T, K>

Optionalfilter

filter?: ((node: TreeNodeType<T, K>) => boolean)

OptionalflatNodes

flatNodes?: T[]

OptionalisActionsEnabled

isActionsEnabled?: ((node: TreeNodeType<T, K>) => boolean)

OptionalisAddButtonDisabled

isAddButtonDisabled?: boolean

OptionalisAutoHeightFill

isAutoHeightFill?: boolean

OptionalisDeletable

isDeletable?: boolean | TreeNodeConditionFunc<T, K>

OptionalisDraggable

isDraggable?: boolean

OptionalisEditable

isEditable?: boolean | TreeNodeConditionFunc<T, K>

OptionalisLoading

isLoading?: boolean

OptionalisStriped

isStriped?: boolean

OptionalmaxRowsBeforeOverflow

maxRowsBeforeOverflow?: number

OptionalnodeRenderer

nodeRenderer?: ((node: TreeNodeType<T, K>, nodeProps: TreeNodeProps<T, K>, defaultRenderer: ((node: TreeNodeType<T, K>, props: TreeNodeProps<T, K>) => ReactElement<any, string | JSXElementConstructor<any>>)) => ReactElement<any, string | JSXElementConstructor<any>>)

nodes

nodes: TreeNodeType<T, K>[]

OptionalonAddNode

onAddNode?: (() => void)

OptionalonBeforeNodeSelect

onBeforeNodeSelect?: ((node: TreeNodeType<T, K>) => boolean)

OptionalonDragEnd

onDragEnd?: ((event: DragEvent<HTMLDivElement>) => void)

OptionalonDragStart

onDragStart?: ((event: DragEvent<HTMLDivElement>, node: TreeNodeType<T, K>) => void)

OptionalonDrop

onDrop?: ((event: DragEvent<HTMLDivElement>, node: TreeNodeType<T, K>) => void)

OptionalonEdit

onEdit?: ((node: TreeNodeType<T, K>, newValue: string, cellId: string) => void)

OptionalonMoveNode

onMoveNode?: ((node: TreeNodeType<T, K>, parentNode?: TreeNodeType<T, K>, previousNode?: TreeNodeType<T, K>) => void)

OptionalonNodeCollapse

onNodeCollapse?: ((node: TreeNodeType<T, K>) => void)

OptionalonNodeDelete

onNodeDelete?: ((node: TreeNodeType<T, K>) => void)

OptionalonNodeDoubleClick

onNodeDoubleClick?: ((node: TreeNodeType<T, K>, event: SyntheticEvent<HTMLDivElement, Event>) => void)

OptionalonNodeExpand

onNodeExpand?: ((node: TreeNodeType<T, K>) => void)

OptionalonNodeMouseEnter

onNodeMouseEnter?: ((node: TreeNodeType<T, K>) => void)

OptionalonNodeMouseLeave

onNodeMouseLeave?: ((node: TreeNodeType<T, K>) => void)

OptionalonNodeSelect

onNodeSelect?: ((node: TreeNodeType<T, K>) => void)

OptionalrightExtraItem

rightExtraItem?: ((nodeData: T) => ReactNode)

selectedNodes

selectedNodes: K[]

On This Page

Properties