king-design-analyzer 2.2.0 → 2.2.2

package/docs_for_llm/diagram.doc.md

@@ -0,0 +1,343 @@
+# 流程图 (Diagram)
+
+流程图组件，用于在画布中组织图形、连线和布局。支持节点选中、标签编辑以及多种布局方式，适合流程建模、拓扑展示和审批链路可视化场景。
+
+**关键词**: diagram, 流程图, 拓扑图, graph, DTreeLayout, DFlowLayout
+
+**使用场景**: 审批流建模、拓扑结构展示、流程状态可视化
+
+## 导入语句
+```typescript
+import { Diagram, DRectangle, DCircle, DLine, DTreeLayout } from '@king-design/vue/components/diagram';
+```
+
+## 事件 (Events)
+| 事件名 | Vue事件名 | 说明 | 回调参数 | 示例 |
+| --- | --- | --- | --- | --- |
+| labelChanged | `@labelChanged` | 节点标签修改后触发 | `cell: any, newLabel: string, oldLabel: string` | `<Diagram @labelChanged="handleLabelChanged"></Diagram>` |
+| selectionChanged | `@selectionChanged` | 画布选中元素变化时触发 | `cells: any[]` | `<Diagram @selectionChanged="handleSelectionChanged"></Diagram>` |
+
+### 事件参数说明
+**labelChanged**
+
+| 参数 | 类型 | 必填 | 默认值 | 说明 |
+| --- | --- | --- | --- | --- |
+| cell | `any` | 是 | - | 发生变化的图元实例 |
+| newLabel | `string` | 是 | - | 修改后的标签内容 |
+| oldLabel | `string` | 是 | - | 修改前的标签内容 |
+
+事件处理示例:
+```typescript
+const handleLabelChanged = (cell: any, newLabel: string, oldLabel: string) => {
+  console.log('label changed', oldLabel, '=>', newLabel);
+};
+```
+
+**selectionChanged**
+
+| 参数 | 类型 | 必填 | 默认值 | 说明 |
+| --- | --- | --- | --- | --- |
+| cells | `any[]` | 是 | - | 当前选中的图元列表 |
+
+事件处理示例:
+```typescript
+const handleSelectionChanged = (cells: any[]) => {
+  console.log('selected cells', cells.length);
+};
+```
+
+## 插槽 (Slots)
+| 插槽名 | 说明 | 模板写法 | 示例 |
+| --- | --- | --- | --- |
+| default | 流程图内容，通常放置布局组件、图形组件和连线组件 | `#default` | `<Diagram>
+  <DTreeLayout>
+    <DRectangle key="1" />
+    <DCircle key="2" />
+    <DLine from="1" to="2" />
+  </DTreeLayout>
+</Diagram>` |
+
+### 插槽参数说明
+**default**
+
+- 参数结构: 无参数
+
+## 子组件 (Sub-Components)
+### DRectangle
+矩形节点，支持圆角、拖拽、选中和自定义内容。
+
+#### 属性 (Props)
+| 属性名 | 类型 | 说明 | 示例 |
+| --- | --- | --- | --- |
+| key | `string | number` | 节点唯一标识，供连线引用 | `<DRectangle key="1" />` |
+| label | `string | number` | 节点标签 | `<DRectangle key="1" label="开始" />` |
+| rounded | `number | string` | 圆角大小 | `<DRectangle key="1" :rounded="8" />` |
+
+#### 组合示例
+##### 可选中节点
+**场景**: 在画布中选中节点并联动侧边配置面板。
+
+监听选中变化，处理画布交互。
+
+**命中的子组件 API**: 属性: key, label
+
+```vue
+<script setup lang="ts">
+import { Diagram, DRectangle, DLine, DFlowLayout } from '@king-design/vue/components/diagram';
+
+const handleSelectionChanged = (cells: any[]) => {
+  console.log('当前选中数量', cells.length);
+};
+</script>
+<template>
+  <Diagram @selectionChanged="handleSelectionChanged">
+    <DFlowLayout type="horizontal">
+      <DRectangle key="1" label="节点 A" selectable />
+      <DRectangle key="2" label="节点 B" selectable />
+      <DLine from="1" to="2" label="流转" />
+    </DFlowLayout>
+  </Diagram>
+</template>
+```
+
+##### 基础树形流程图
+**场景**: 快速搭建审批流或状态流转图。
+
+使用树形布局组织节点和连线。
+
+**命中的子组件 API**: 属性: key, label
+
+```vue
+<script setup lang="ts">
+import { Diagram, DRectangle, DCircle, DLine, DTreeLayout } from '@king-design/vue/components/diagram';
+</script>
+<template>
+  <Diagram>
+    <DTreeLayout>
+      <DRectangle key="1" label="开始" />
+      <DCircle key="2" label="审核" />
+      <DCircle key="3" label="结束" />
+      <DLine from="1" to="2" />
+      <DLine from="2" to="3" />
+    </DTreeLayout>
+  </Diagram>
+</template>
+```
+
+### DCircle
+圆形节点，适合展示起止节点或状态节点。
+
+#### 属性 (Props)
+| 属性名 | 类型 | 说明 | 示例 |
+| --- | --- | --- | --- |
+| key | `string | number` | 节点唯一标识 | `<DCircle key="2" />` |
+| label | `string | number` | 节点标签 | `<DCircle key="2" label="结束" />` |
+
+#### 组合示例
+##### 基础树形流程图
+**场景**: 快速搭建审批流或状态流转图。
+
+使用树形布局组织节点和连线。
+
+**命中的子组件 API**: 属性: key, label
+
+```vue
+<script setup lang="ts">
+import { Diagram, DRectangle, DCircle, DLine, DTreeLayout } from '@king-design/vue/components/diagram';
+</script>
+<template>
+  <Diagram>
+    <DTreeLayout>
+      <DRectangle key="1" label="开始" />
+      <DCircle key="2" label="审核" />
+      <DCircle key="3" label="结束" />
+      <DLine from="1" to="2" />
+      <DLine from="2" to="3" />
+    </DTreeLayout>
+  </Diagram>
+</template>
+```
+
+### DLine
+节点之间的连线。
+
+#### 属性 (Props)
+| 属性名 | 类型 | 说明 | 示例 |
+| --- | --- | --- | --- |
+| from | `string | number` | 起始节点 key | `<DLine from="1" to="2" />` |
+| to | `string | number` | 目标节点 key | `<DLine from="1" to="2" />` |
+| label | `string` | 连线标签 | `<DLine from="1" to="2" label="通过" />` |
+
+#### 组合示例
+##### 可选中节点
+**场景**: 在画布中选中节点并联动侧边配置面板。
+
+监听选中变化，处理画布交互。
+
+**命中的子组件 API**: 属性: from, to, label
+
+```vue
+<script setup lang="ts">
+import { Diagram, DRectangle, DLine, DFlowLayout } from '@king-design/vue/components/diagram';
+
+const handleSelectionChanged = (cells: any[]) => {
+  console.log('当前选中数量', cells.length);
+};
+</script>
+<template>
+  <Diagram @selectionChanged="handleSelectionChanged">
+    <DFlowLayout type="horizontal">
+      <DRectangle key="1" label="节点 A" selectable />
+      <DRectangle key="2" label="节点 B" selectable />
+      <DLine from="1" to="2" label="流转" />
+    </DFlowLayout>
+  </Diagram>
+</template>
+```
+
+##### 基础树形流程图
+**场景**: 快速搭建审批流或状态流转图。
+
+使用树形布局组织节点和连线。
+
+**命中的子组件 API**: 属性: from, to
+
+```vue
+<script setup lang="ts">
+import { Diagram, DRectangle, DCircle, DLine, DTreeLayout } from '@king-design/vue/components/diagram';
+</script>
+<template>
+  <Diagram>
+    <DTreeLayout>
+      <DRectangle key="1" label="开始" />
+      <DCircle key="2" label="审核" />
+      <DCircle key="3" label="结束" />
+      <DLine from="1" to="2" />
+      <DLine from="2" to="3" />
+    </DTreeLayout>
+  </Diagram>
+</template>
+```
+
+### DTreeLayout
+树形布局，适合组织审批流或层级关系图。
+
+#### 属性 (Props)
+| 属性名 | 类型 | 说明 | 示例 |
+| --- | --- | --- | --- |
+| type | `"horizontal" | "vertical"` | 布局方向 | `<DTreeLayout type="horizontal"></DTreeLayout>` |
+| levelDistance | `number | string` | 层级之间的距离 | `<DTreeLayout :levelDistance="80"></DTreeLayout>` |
+
+#### 组合示例
+##### 基础树形流程图
+**场景**: 快速搭建审批流或状态流转图。
+
+使用树形布局组织节点和连线。
+
+```vue
+<script setup lang="ts">
+import { Diagram, DRectangle, DCircle, DLine, DTreeLayout } from '@king-design/vue/components/diagram';
+</script>
+<template>
+  <Diagram>
+    <DTreeLayout>
+      <DRectangle key="1" label="开始" />
+      <DCircle key="2" label="审核" />
+      <DCircle key="3" label="结束" />
+      <DLine from="1" to="2" />
+      <DLine from="2" to="3" />
+    </DTreeLayout>
+  </Diagram>
+</template>
+```
+
+### DFlowLayout
+流式布局，适合横向或纵向流程图编排。
+
+#### 属性 (Props)
+| 属性名 | 类型 | 说明 | 示例 |
+| --- | --- | --- | --- |
+| type | `"horizontal" | "vertical"` | 布局方向 | `<DFlowLayout type="horizontal"></DFlowLayout>` |
+| intraCellSpacing | `number | string` | 同层节点间距 | `<DFlowLayout :intraCellSpacing="40"></DFlowLayout>` |
+
+#### 组合示例
+##### 可选中节点
+**场景**: 在画布中选中节点并联动侧边配置面板。
+
+监听选中变化，处理画布交互。
+
+**命中的子组件 API**: 属性: type
+
+```vue
+<script setup lang="ts">
+import { Diagram, DRectangle, DLine, DFlowLayout } from '@king-design/vue/components/diagram';
+
+const handleSelectionChanged = (cells: any[]) => {
+  console.log('当前选中数量', cells.length);
+};
+</script>
+<template>
+  <Diagram @selectionChanged="handleSelectionChanged">
+    <DFlowLayout type="horizontal">
+      <DRectangle key="1" label="节点 A" selectable />
+      <DRectangle key="2" label="节点 B" selectable />
+      <DLine from="1" to="2" label="流转" />
+    </DFlowLayout>
+  </Diagram>
+</template>
+```
+
+## 使用示例
+### 基础树形流程图
+**场景**: 快速搭建审批流或状态流转图。
+
+使用树形布局组织节点和连线。
+
+**使用的 API**: 插槽: default
+
+```vue
+<script setup lang="ts">
+import { Diagram, DRectangle, DCircle, DLine, DTreeLayout } from '@king-design/vue/components/diagram';
+</script>
+<template>
+  <Diagram>
+    <DTreeLayout>
+      <DRectangle key="1" label="开始" />
+      <DCircle key="2" label="审核" />
+      <DCircle key="3" label="结束" />
+      <DLine from="1" to="2" />
+      <DLine from="2" to="3" />
+    </DTreeLayout>
+  </Diagram>
+</template>
+```
+
+### 可选中节点
+**场景**: 在画布中选中节点并联动侧边配置面板。
+
+监听选中变化，处理画布交互。
+
+**使用的 API**: 事件: selectionChanged | 插槽: default
+
+```vue
+<script setup lang="ts">
+import { Diagram, DRectangle, DLine, DFlowLayout } from '@king-design/vue/components/diagram';
+
+const handleSelectionChanged = (cells: any[]) => {
+  console.log('当前选中数量', cells.length);
+};
+</script>
+<template>
+  <Diagram @selectionChanged="handleSelectionChanged">
+    <DFlowLayout type="horizontal">
+      <DRectangle key="1" label="节点 A" selectable />
+      <DRectangle key="2" label="节点 B" selectable />
+      <DLine from="1" to="2" label="流转" />
+    </DFlowLayout>
+  </Diagram>
+</template>
+```
+
+## 相关组件
+Anchor, Card
+

package/docs_for_llm/dialog.doc.md

@@ -66,6 +66,23 @@ import { Dialog, Button } from '@king-design/vue';
   </template>
 </Dialog>` |
 
+### 插槽参数说明
+**default**
+
+- 参数结构: 无参数
+
+**header**
+
+- 参数结构: 无参数
+
+**footer**
+
+- 参数结构: 无参数
+
+**content**
+
+- 参数结构: 无参数
+
 ## 方法 (Methods)
 | 方法名 | 说明 | 参数 | 返回值 |
 | --- | --- | --- | --- |
@@ -81,6 +98,38 @@ import { Dialog, Button } from '@king-design/vue';
 | --- | --- | --- | --- | --- |
 | props | `DialogProps` | 否 | - | 可选的临时弹窗配置，会在本次显示时覆盖标题、按钮文案或宽度等属性。 |
 
+调用示例:
+```typescript
+const dialogRef = ref<InstanceType<typeof Dialog>>();
+await dialogRef.value?.show();
+```
+
+### 方法调用示例
+**show**
+
+```typescript
+const dialogRef = ref<InstanceType<typeof Dialog>>();
+await dialogRef.value?.show();
+```
+
+**close**
+
+```typescript
+dialogRef.value?.close();
+```
+
+**showLoading**
+
+```typescript
+dialogRef.value?.showLoading();
+```
+
+**hideLoading**
+
+```typescript
+dialogRef.value?.hideLoading();
+```
+
 ## 常见错误与正确用法 (Anti-Hallucination)
 ### 静态方法调用时未正确导入Dialog
 > **错误用法**: `import { confirm } from '@king-design/vue';

package/docs_for_llm/divider.doc.md

@@ -25,6 +25,11 @@ import { Divider } from '@king-design/vue';
 | --- | --- | --- | --- |
 | default | 分割线中间的文字内容 | `#default` | `<Divider>文字内容</Divider>` |
 
+### 插槽参数说明
+**default**
+
+- 参数结构: 无参数
+
 ## 常见错误与正确用法 (Anti-Hallucination)
 ### 混淆 vertical 和 horizontal 的含义
 > **错误用法**: `<Divider type="vertical" /> <!-- 想创建垂直分割线 -->`

package/docs_for_llm/drawer.doc.md

@@ -44,6 +44,50 @@ import { Drawer } from '@king-design/vue';
 | terminate | `@terminate` | 用户强行关闭抽屉时触发（点击关闭按钮、遮罩层或按 ESC） | `-` | `<Drawer @terminate="handleTerminate">` |
 | afterClose | `@afterClose` | 抽屉退出动画执行完成后触发 | `-` | `<Drawer @afterClose="handleAfterClose">` |
 
+## 插槽 (Slots)
+| 插槽名 | 说明 | 模板写法 | 示例 |
+| --- | --- | --- | --- |
+| content | 定义整个弹窗体，包括header，body，footer | `#content` | `<Drawer>
+  <template #content>自定义内容</template>
+</Drawer>` |
+| header | 扩展弹窗头部 | `#header` | `<Drawer>
+  <template #header>头部内容</template>
+</Drawer>` |
+| body | 扩展弹窗主体部分 | `#body` | `<Drawer>
+  <template #body>
+    自定义body内容
+  </template>
+</Drawer>` |
+| footer | 扩展弹窗底部 | `#footer` | `<Drawer>
+  <template #footer>底部内容</template>
+</Drawer>` |
+| footer-wrapper | 扩展弹窗整个底部，上述footer是它下面一个子扩展点 | `#footer-wrapper` | `<Drawer>
+  <template #footer-wrapper>
+    自定义footer-wrapper内容
+  </template>
+</Drawer>` |
+
+### 插槽参数说明
+**content**
+
+- 参数结构: 无参数
+
+**header**
+
+- 参数结构: 无参数
+
+**body**
+
+- 参数结构: 无参数
+
+**footer**
+
+- 参数结构: 无参数
+
+**footer-wrapper**
+
+- 参数结构: 无参数
+
 ## 方法 (Methods)
 | 方法名 | 说明 | 参数 | 返回值 |
 | --- | --- | --- | --- |
@@ -61,6 +105,48 @@ import { Drawer } from '@king-design/vue';
 | --- | --- | --- | --- | --- |
 | props | `DrawerProps` | 否 | - | 可选的临时抽屉配置，会在本次显示时覆盖标题、方向、宽度或按钮状态。 |
 
+调用示例:
+```typescript
+drawerRef.value?.show();
+```
+
+### 方法调用示例
+**show**
+
+```typescript
+drawerRef.value?.show();
+```
+
+**close**
+
+```typescript
+drawerRef.value?.close();
+```
+
+**showLoading**
+
+```typescript
+drawerRef.value?.showLoading();
+```
+
+**hideLoading**
+
+```typescript
+drawerRef.value?.hideLoading();
+```
+
+**disableOk**
+
+```typescript
+drawerRef.value?.disableOk();
+```
+
+**enableOk**
+
+```typescript
+drawerRef.value?.enableOk();
+```
+
 ## 常见错误与正确用法 (Anti-Hallucination)
 ### placement 值拼写错误
 > **错误用法**: `<Drawer placement="center">`