@ant-design/graphs/src/components/indented-tree/types.ts

A React graph library based on Graphin

import type { GraphData, NodeData, TreeData } from '@antv/g6';
import type { GraphOptions } from '../../types';

export interface IndentedTreeOptions extends Omit<GraphOptions, 'data'> {
  /**
   * The data.
   * It can be either tree data or graph data that conforms to a tree structure.
   */
  data?: GraphData | TreeData;
  /**
   * The default expand level. If not set, all nodes will be expanded.
   */
  defaultExpandLevel?: number;
  /**
   * The type of the mind map
   * @default 'default'
   */
  type?: 'default' | 'linear' | 'boxed';
  /**
   * The direction of the mind map.
   * @default 'right'
   */
  direction?: 'left' | 'right' | 'alternate';
  /**
   * The minimum width of the tree nodes. If the text of a tree node is too short, it will be centered.
   * @default 0
   */
  nodeMinWidth?: number;
  /**
   * The maximum width of the tree nodes. If the text of a tree node is too long, it will be wrapped.
   * @default 300
   */
  nodeMaxWidth?: number;
  /**
   * Selects a field from the data to use as the label for the node.
   * If a string is provided, it will select the field as `data[labelField]`.
   * If a function is provided, it will call the function with the data and use the returned value.
   * @default (data) => data.id
   */
  labelField?: string | ((data: NodeData) => string);
}