@atlaskit/tree/dist/cjs/components/Tree/Tree-types.d.ts

A React Component for displaying expandable and sortable tree hierarchies

import { ReactNode } from 'react';
import { DraggableLocation, DraggableId, DroppableId } from 'react-beautiful-dnd-next';
import { TreeData, Path, ItemId, FlattenedTree, TreeSourcePosition, TreeDestinationPosition } from '../../types';
import { RenderItemParams } from '../TreeItem/TreeItem-types';
export declare type Props = {
    /** The tree data structure. */
    tree: TreeData;
    /** Function that will be called when a parent item needs to be expanded. */
    onExpand: (itemId: ItemId, path: Path) => void;
    /** Function that will be called when a parent item needs to be collapsed. */
    onCollapse: (itemId: ItemId, path: Path) => void;
    /** Function that will be called when the user starts dragging. */
    onDragStart: (itemId: ItemId) => void;
    /** Function that will be called when the user finishes dragging. */
    onDragEnd: (sourcePosition: TreeSourcePosition, destinationPosition?: TreeDestinationPosition) => void;
    /** Function that will be called to render a single item. */
    renderItem: (item: RenderItemParams) => ReactNode;
    /** Number of pixel is used to scaffold the tree by the consumer. */
    offsetPerLevel: number;
    /** Boolean to turn on drag&drop re-ordering on the tree */
    isDragEnabled: boolean;
    /** Boolean to turn on hovering while dragging */
    isNestingEnabled: boolean;
};
export declare type State = {
    /** The flattened tree data structure transformed from props.tree */
    flattenedTree: FlattenedTree;
    draggedItemId?: ItemId;
};
export declare type Combine = {
    draggableId: DraggableId;
    droppableId: DroppableId;
};
export declare type DragState = {
    source: DraggableLocation;
    mode: string;
    destination?: DraggableLocation;
    horizontalLevel?: number;
    combine?: Combine;
};