Search
    Preparing search index...

    Interface TreeNodeProps<T, K>

    Свойства узла дерева.

    interface TreeNodeProps<T, K extends TreeNodeKeyType = TreeNodeKeyType> {
        actions: TreeNodeActionItem<T, K>[];
        allowDragOver?: (
            event: DragEvent<HTMLDivElement>,
            dropToNode: TreeNodeType<T, K>,
            draggedNode?: TreeNodeType<T, K>,
        ) => boolean;
        canHasChildren?: boolean | TreeNodeConditionFunc<T, K>;
        canSelectDisabled: boolean;
        cellContentRenderer?: (
            node: TreeNodeType<T, K>,
            column: TreeColumn<T, K>,
            defaultRenderer: (
                node: TreeNodeType<T, K>,
                column: TreeColumn<T, K>,
            ) => ReactElement,
        ) => ReactElement;
        childrenRenderer?: (
            node: TreeNodeType<T, K>,
            nodeProps: TreeNodeProps<T, K>,
            defaultRenderer: (
                node: TreeNodeType<T, K>,
                props: TreeNodeProps<T, K>,
            ) => ReactElement,
        ) => ReactElement;
        columns: TreeColumn<T, K>[];
        contentRenderer?: (
            node: TreeNodeType<T, K>,
            nodeProps: TreeNodeProps<T, K>,
            defaultRenderer: (
                node: TreeNodeType<T, K>,
                props: TreeNodeProps<T, K>,
            ) => ReactElement,
        ) => ReactElement;
        cursorKey?: string;
        disabledItems?: StringKeyMap<any>;
        draggedNode?: TreeNodeType<T, K>;
        filter?: (node: TreeNodeType<T, K>) => boolean;
        gridSizes?: string[];
        hideExpand?: boolean;
        isActionsEnabled?: (node: TreeNodeType<T, K>) => boolean;
        isDeletable?: boolean | TreeNodeConditionFunc<T, K>;
        isDisabled?: boolean | TreeNodeConditionFunc<T, K>;
        isDraggable?: boolean;
        isEditable?: boolean | TreeNodeConditionFunc<T, K>;
        isExpanded: boolean;
        isLastChild: boolean;
        isLoading?: boolean;
        isRoot?: boolean;
        isSelected?: boolean | TreeNodeConditionFunc<T, K>;
        lastChildStreak: number;
        level: number;
        node: TreeNodeType<T, K>;
        onBackwardDrop?: (
            event: DragEvent,
            node: TreeNodeType<T, K>,
            dropConfig: TreeNodeDropConfig<T, K>,
        ) => void;
        onBeforeNodeSelect?: (node: TreeNodeType<T, K>) => boolean;
        onDragEnd?: (event: DragEvent<HTMLDivElement>) => void;
        onDragStart?: (
            event: DragEvent<HTMLDivElement>,
            node: TreeNodeType<T, K>,
        ) => void;
        onEdit?: (
            node: TreeNodeType<T, K>,
            newValue: string,
            cellId: string,
        ) => 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;
        preventChildrenRender?: boolean;
        rightExtraItem?: (nodeData: T) => ReactNode;
        selectedItems?: StringKeyMap<any>;
        size?: MIDDLE | LARGE;
        skipServiceColumns?: number;
    }

    Type Parameters

    Index

    Properties

    actions allowDragOver? canHasChildren? canSelectDisabled cellContentRenderer? childrenRenderer? columns contentRenderer? cursorKey? disabledItems? draggedNode? filter? gridSizes? hideExpand? isActionsEnabled? isDeletable? isDisabled? isDraggable? isEditable? isExpanded isLastChild isLoading? isRoot? isSelected? lastChildStreak level node onBackwardDrop? onBeforeNodeSelect? onDragEnd? onDragStart? onEdit? onNodeCollapse? onNodeDelete? onNodeDoubleClick? onNodeExpand? onNodeMouseEnter? onNodeMouseLeave? onNodeSelect? preventChildrenRender? rightExtraItem? selectedItems? size? skipServiceColumns?

    Properties

    actions: TreeNodeActionItem<T, K>[]

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

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

    Позволяет проверить возможность дропа другим узлом.

    Type declaration

    canHasChildren?: boolean | TreeNodeConditionFunc<T, K>

    Признак возможности иметь дочерние узлы или функция, определяющая это.

    canSelectDisabled: boolean

    Можно ли выбирать отключенные узлы.

    cellContentRenderer?: (
        node: TreeNodeType<T, K>,
        column: TreeColumn<T, K>,
        defaultRenderer: (
            node: TreeNodeType<T, K>,
            column: TreeColumn<T, K>,
        ) => ReactElement,
    ) => ReactElement

    Функция для кастомного рендеринга содержимого ячейки.

    Type declaration

    childrenRenderer?: (
        node: TreeNodeType<T, K>,
        nodeProps: TreeNodeProps<T, K>,
        defaultRenderer: (
            node: TreeNodeType<T, K>,
            props: TreeNodeProps<T, K>,
        ) => ReactElement,
    ) => ReactElement

    Функция для кастомного рендеринга дочерних узлов.

    Type declaration

    columns: TreeColumn<T, K>[]

    Массив колонок для отображения данных узла.

    contentRenderer?: (
        node: TreeNodeType<T, K>,
        nodeProps: TreeNodeProps<T, K>,
        defaultRenderer: (
            node: TreeNodeType<T, K>,
            props: TreeNodeProps<T, K>,
        ) => ReactElement,
    ) => ReactElement

    Функция для кастомного рендеринга содержимого ущла.

    Type declaration

    cursorKey?: string

    Ключ узла, связанный с позицией курсора.

    disabledItems?: StringKeyMap<any>

    Отключенные элементы

    Следует использовать isDisabled

    @universe-platform/uikit 2.0.0

    @universe-ee/sdk 6.16.0

    @universe-dg/sdk 2.16.0

    draggedNode?: TreeNodeType<T, K>

    Текущий перемещаемый узел.

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

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

    Type declaration

    gridSizes?: string[]

    Настройки CSS Grid колонок

    hideExpand?: boolean

    Признак скрытия управляющего элемента разворачивания.

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

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

    Type declaration

    isDeletable?: boolean | TreeNodeConditionFunc<T, K>

    Признак возможности удаления узла или функция, определяющая удаляемый узел.

    isDisabled?: boolean | TreeNodeConditionFunc<T, K>

    Признак отключенности узла или функция, определяющая отключенный узел.

    isDraggable?: boolean

    Признак возможности перетаскивания узла.

    isEditable?: boolean | TreeNodeConditionFunc<T, K>

    Признак возможности редактирования узла или функция, определяющая редактируемый узел.

    isExpanded: boolean

    Признак состояния узла (развернут/свернут).

    isLastChild: boolean

    Является ли текущий узел последним дочерним.

    isLoading?: boolean

    Признак загрузки узла.

    isRoot?: boolean

    Является ли узел корневым.

    isSelected?: boolean | TreeNodeConditionFunc<T, K>

    Признак выбранного узла или функция, проверяющая выбор узла.

    lastChildStreak: number

    Длина последовательности последних дочерних узлов.

    level: number

    Текущий уровень вложенности узла.

    node: TreeNodeType<T, K>

    Узел дерева.

    onBackwardDrop?: (
        event: DragEvent,
        node: TreeNodeType<T, K>,
        dropConfig: TreeNodeDropConfig<T, K>,
    ) => void

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

    Type declaration

    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

    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

    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

    preventChildrenRender?: boolean

    Признак предотвращения рендеринга дочерних узлов.

    rightExtraItem?: (nodeData: T) => ReactNode

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

    Type declaration

    selectedItems?: StringKeyMap<any>

    Выбранные элементы

    Следует использовать isSelected

    @universe-platform/uikit 2.0.0

    @universe-ee/sdk 6.16.0

    @universe-dg/sdk 2.16.0

    size?: MIDDLE | LARGE

    Высота узла

    skipServiceColumns?: number

    Количество левых CSS Grid колонок, которое необходимо добавить для рендера левой колонки узла

    On This Page

    Properties