添加测试信息
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
|
||||
## 1. 组件概述
|
||||
**BimTree** 是一个通用的树形组件,支持多级嵌套、复选框、图标和自定义内容。它通常用于展示模型结构、文件目录或层级列表。
|
||||
该组件设计为被包裹在容器(如 Dialog)中,并通过 `TreeManager` 进行创建和管理。
|
||||
该组件设计为被包裹在容器(如 Dialog)中,并通过 `ModelTreeManager` 进行创建和管理。
|
||||
|
||||
## 2. 组件类 API (BimTree)
|
||||
`src/components/tree/index.ts`
|
||||
@@ -15,11 +15,29 @@
|
||||
* `getCheckedNodes(includeHalfChecked?: boolean)`: 获取当前所有被勾选的节点配置列表。
|
||||
* `getNode(id: string)`: 获取指定 ID 的节点实例。
|
||||
|
||||
## 3. Manager API (TreeManager)
|
||||
`src/managers/tree-manager.ts`
|
||||
## 3. Manager API (ModelTreeManager)
|
||||
|
||||
* `create(options: TreeOptions)`: 创建并返回一个新的 BimTree 实例。
|
||||
* `options`: 参见 `TreeOptions` 类型定义。
|
||||
`ModelTreeManager` 负责创建和管理 `BimTree` 实例。
|
||||
|
||||
### 方法
|
||||
|
||||
#### `createTree(options: TreeOptions): BimTree`
|
||||
创建一个新的树组件实例。
|
||||
|
||||
- **参数**: `options` (TreeOptions) - 树组件配置
|
||||
- **返回**: `BimTree` - 树组件实例
|
||||
- **功能**:
|
||||
- 实例化组件
|
||||
- 自动绑定组件事件到全局事件总线 (`ui:tree-node-check`, `ui:tree-node-select` 等)
|
||||
- 初始化组件
|
||||
|
||||
#### `showStructTree(data: TreeNodeConfig[], title: string): { tree: BimTree, dialog: BimDialog }`
|
||||
显示带复选框的模型结构树弹窗。
|
||||
|
||||
#### `showSimpleTree(data: TreeNodeConfig[], title: string): { tree: BimTree, dialog: BimDialog }`
|
||||
显示简单的树形弹窗 (无复选框)。
|
||||
|
||||
---
|
||||
|
||||
## 4. 类型定义
|
||||
`src/components/tree/types.ts`
|
||||
@@ -42,6 +60,11 @@ interface TreeOptions {
|
||||
checkStrictly?: boolean; // 是否父子联动 (默认 true)
|
||||
defaultExpandAll?: boolean;
|
||||
indent?: number;
|
||||
|
||||
// 事件回调
|
||||
onNodeCheck?: (node: BimTreeNode) => void;
|
||||
onNodeSelect?: (node: BimTreeNode) => void;
|
||||
onNodeExpand?: (node: BimTreeNode) => void;
|
||||
}
|
||||
```
|
||||
|
||||
@@ -73,7 +96,8 @@ interface TreeOptions {
|
||||
|
||||
## 8. 使用示例
|
||||
```typescript
|
||||
const tree = engine.tree.create({
|
||||
// 通过 ModelTreeManager 创建
|
||||
const tree = engine.modelTree.createTree({
|
||||
data: [
|
||||
{ id: 'root', label: 'tree.root', children: [...] }
|
||||
],
|
||||
|
||||
Reference in New Issue
Block a user