# tree-modal LLMs.txt

> 供 LLM 快速理解 `@flatbiz/antd/tree-modal` 的使用方式。

## 模块定位

树节点数据选择，一般用于选择员工等

## 导入方式

```ts
import { TreeModal } from '@flatbiz/antd/tree-modal';
// 也可以从主入口导入：import { ... } from '@flatbiz/antd';
```

## 公开导出

- `HorizontalLayout`
- `TreeModal`
- `SelectItemList`
- `TreeModalContent` - 树节点数据选择，一般用于选择员工等
- `SelectContent`
- `TreeModelSelectItem`
- `TreeModelSelectValue`
- `TreeModalContentProps`
- `TreeModalProps`
- `VerticalLayout`

## 依赖的 antd 能力

`Modal`

## Props / 配置要点

### TreeModelSelectItem

- `label`（必填）：: string
- `value`（必填）：: string | number

### TreeModalContentProps

- `isMultiple`（可选）：: boolean；是否多选，默认值：true
- `forceRender`（可选）：: boolean
- `size`（可选）：: 'small' | 'middle' | 'large'；内置尺寸，根据比例固定高度、宽度，默认：large
- `fieldNames`（可选）：: { label?: string; value?: string; children?: string; }；字段映射
- `onRequest`（可选）：: () => Promise<TPlainObject[]>；接口调用 @deprecated 已过期，使用 serviceConfig
- `serviceConfig`（可选）：: { params?: TPlainObject; requiredParamsKeys?: string[]; onRequest?: (params?: TAny) => TAny; }
- `value`（可选）：: TreeModelSelectValue
- `onChange`（可选）：: (values?: TreeModelSelectItem[]) => void
- `textConfig`（可选）：: { title: string; placeholder?: string; selectQuantityPrompt?: string; }；选择为空提示，例如：请选择
- `treeProps`（可选）：: Pick< TreeWrapperProps, | 'showSearch' | 'searchResultType' | 'searchPlaceholder' | 'searchValue' | 'loadDataFlag' | 'loadDataServiceConfig' | 'icon' | 'disa…

### TreeModalProps

- `children`（可选）：: ReactElement & { onClick?: (e) => void | Promise<void> }
- `modalClassName`（可选）：: string
- `modalWidth`（可选）：: number
- `modalBodyHeight`（可选）：: number
- `disabled`（可选）：: boolean

## 使用规则与行为

- 树节点数据选择，一般用于选择员工等
- 是否多选，默认值：true
- 内置尺寸，根据比例固定高度、宽度，默认：large
- 字段映射
- 接口调用 @deprecated 已过期，使用 serviceConfig
- 选择为空提示，例如：请选择
- 选择数量提示，例如：已选择{total}位用户

## 默认值线索

- `isMultiple => true`

## 基础示例

```tsx
import { TreeModal, type TreeModalContentProps } from '@flatbiz/antd/tree-modal';

const props: TreeModalContentProps = {
  // 按业务传入必要参数
};

<TreeModal {...props} />;
```

## 源码索引

- `src/tree-modal/horizontal.tsx`
- `src/tree-modal/index.ts`
- `src/tree-modal/select-item.tsx`
- `src/tree-modal/select-modal-content.tsx`
- `src/tree-modal/select-modal.tsx`
- `src/tree-modal/tree.tsx`
- `src/tree-modal/types.ts`
- `src/tree-modal/vertical.tsx`

## 给 LLM 的注意事项

- 优先使用 `@flatbiz/antd/tree-modal` 或主入口 `@flatbiz/antd` 的公开导出，不要引用内部实现文件。
- 当 Props 与 antd 原组件同名能力冲突时，以本模块导出的 Props 类型为准。
- 若文档未覆盖某个边缘参数，请读取上方源码索引中的类型定义和 JSDoc。