Search
    Preparing search index...

    Interface TreeProps<T, K>

    Свойства компонента дерева

    interface TreeProps<T, K extends TreeNodeKeyType = TreeNodeKeyType> {
        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,
        ) => ReactElement;
        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>,
        ) => 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

    Index

    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

    actions?: TreeNodeActionItem<T, K>[]

    Массив действий для узлов.

    addText?: ReactNode

    Текст кнопки добавления.

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

    Функция, позволяющая настроить возможность дропа для узла.

    Type declaration

    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

    Функция фильтрации узлов.

    Type declaration

    flatNodes?: T[]

    Плоский массив узлов дерева.

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

    Функция проверки включенных действий для узла.

    Type declaration

    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,
    ) => ReactElement

    Кастомный рендерер узла.

    Type declaration

    nodes: TreeNodeType<T, K>[]

    Массив узлов дерева.

    onAddNode?: () => void

    Срабатывает при добавлении узла.

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

    Вызывается перед выбором узла, возвращает разрешение или запрет выбора.

    Type declaration

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

    Срабатывает при окончании перетаскивания.

    Type declaration

      • (event: DragEvent<HTMLDivElement>): void

      • Parameters

        • event: DragEvent<HTMLDivElement>

          Событие drag.

        Returns void

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

    Срабатывает при начале перетаскивания узла.

    Type declaration

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

    Срабатывает при броске перетаскиваемого узла.

    Type declaration

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

    Срабатывает при сохранении редактируемого узла.

    Type declaration

      • (node: TreeNodeType<T, K>, newValue: string, cellId: string): void

      • Parameters

        • node: TreeNodeType<T, K>

          Редактируемый узел.

        • newValue: string

          Новое значение.

        • cellId: string

          Идентификатор ячейки.

        Returns void

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

    Срабатывает при перемещении узла в новое место.

    Type declaration

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

    Срабатывает при сворачивании узла.

    Type declaration

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

    Срабатывает при удалении узла.

    Type declaration

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

    Срабатывает при двойном клике по узлу.

    Type declaration

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

    Срабатывает при раскрытии узла.

    Type declaration

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

    Срабатывает при наведении курсора на узел.

    Type declaration

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

    Срабатывает при уходе курсора с узла.

    Type declaration

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

    Срабатывает при выборе узла.

    Type declaration

    rightExtraItem?: (nodeData: T) => ReactNode

    Функция рендера дополнительной области справа в узле.

    Type declaration

    selectedNodes: K[]

    Массив ключей выбранных узлов.

    On This Page

    Properties