From 1fa5cf85866a42c3854e20de4136f456ce0d8fe6 Mon Sep 17 00:00:00 2001 From: jiangchu Date: Mon, 18 Sep 2023 14:47:54 +0800 Subject: [PATCH] :fire: feat: remove controller and bloodNode index.md --- src/BloodNode/index.md | 51 ---------------------------------- src/ProFlowController/index.md | 15 ---------- 2 files changed, 66 deletions(-) delete mode 100644 src/BloodNode/index.md delete mode 100644 src/ProFlowController/index.md diff --git a/src/BloodNode/index.md b/src/BloodNode/index.md deleted file mode 100644 index c291fc7..0000000 --- a/src/BloodNode/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -group: 节点 -title: BloodNode 血缘图节点 -description: 血缘图中的基础节点 ---- - -我们在 ProFlow 中提供了 BloodMap 的基础节点，方便定制样式。 - -## 基础节点 - -## 预览模式 - -BasicNode 组件提供了 `Preview` 子组件用于画布之外的预览。 - - - -## 搭配 Field 组件使用 - -pro-flow-editor 提供 NodeField 组件，可以搭配 BasicNode 使用，两者关系就像 antd 的 Form 和 Form.Item。 - - - -## collapsedKeys 受控折叠与展开 - -搭配 Field 使用时，可以通过 collapsedKeys 和 onCollapsedKeysChange 控制折叠的字段。 - - - -## APIs - -### BasicNode.Preview 预览组件 - -| 属性名 | 类型 | 描述 | 默认值 | 必选 | -| --------------------- | ----------------------------------- | -------------------------- | ------ | ---- | -| title | `string` | 标题 | - | - | -| onTitleChange | `(title: string) => void` | 标题变化时的回调函数 | - | - | -| extra | `ReactNode` | 标题右侧区域 | - | - | -| children | `ReactNode` | 子元素 ReactNode | - | - | -| active | `boolean` | 是否激活状态 | - | - | -| collapsedKeys | `string[]` | 折叠的键数组 | `[]` | - | -| onCollapsedKeysChange | `(collapsedKeys: string[]) => void` | 折叠键数组变化时的回调函数 | - | - | -| style | `CSSProperties` | 自定义样式 | - | - | -| className | `string` | 自定义类名 | - | - | - -### BasicNode 组件 - -在 Preview 基础上： - -| 属性名 | 类型 | 描述 | 默认值 | 必选 | -| ------ | -------- | ------- | ------ | ---- | -| id | `string` | 节点 Id | - | 是 | diff --git a/src/ProFlowController/index.md b/src/ProFlowController/index.md deleted file mode 100644 index 10674ac..0000000 --- a/src/ProFlowController/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -group: 容器组件 -title: ProFlowController 画布控制器 -description: ---- - -我们在 ProFlow 中提供了 BloodMap 的基础节点，方便定制样式。 - -## 基础节点 - -## 预览模式 - -BasicNode 组件提供了 `Preview` 子组件用于画布之外的预览。 - -