king-design-analyzer 2.1.9 → 2.2.1

package/docs_for_llm/status.doc.md

@@ -2,9 +2,9 @@
 
 显示状态图标和文本，支持旋转动画。
 
-**关键词**: status, indicator, loading, 状态
+**关键词**: status, indicator, loading, 状态, 状态指示器, 加载状态, 进度状态
 
-**使用场景**: 表格行状态展示、详情页资源状态
+**使用场景**: 表格行状态展示、详情页资源状态、带进度的任务状态展示、支持刷新动作的状态提示
 
 ## 导入语句
 ```typescript
@@ -12,11 +12,16 @@ import { Status } from '@ksyun-internal/versatile';
 ```
 
 ## 属性 (Props)
-| 属性名 | 类型 | 默认值 | 必填 | 说明 | 示例 |
-| --- | --- | --- | --- | --- | --- |
-| type | `StatusType` | `undefined` | 否 | 状态类型 | - |
-| color | `string` | `undefined` | 否 | 自定义颜色 | - |
-| text | `string` | `undefined` | 否 | 状态文本 | - |
-| rotate | `boolean` | `undefined` | 否 | 是否旋转图标 | - |
-| refresh | `() => Promise<void>` | `undefined` | 否 | 刷新函数，传递此属性时会显示刷新按钮 | - |
+| 属性名 | 类型 | 默认值 | 必填 | 说明 | 标签 | 示例 |
+| --- | --- | --- | --- | --- | --- | --- |
+| type | `StatusType` | `undefined` | 否 | 状态类型 | - | - |
+| color | `string` | `undefined` | 否 | 自定义颜色 | - | - |
+| text | `string` | `undefined` | 否 | 状态文本 | - | - |
+| rotate | `boolean` | `undefined` | 否 | 是否旋转图标 | - | - |
+| rotationDuration | `string | number` | `undefined` | 否 | 旋转动画时长，支持字符串或数字 | - | - |
+| refresh | `() => Promise<void>` | `undefined` | 否 | 刷新函数，传递此属性时会显示刷新按钮 | - | - |
+| tip | `string` | `undefined` | 否 | 状态说明提示文案 | - | - |
+| progress | `number` | `undefined` | 否 | 进度值，传入后可展示带进度语义的状态 | - | - |
+| refreshTip | `string` | `undefined` | 否 | 刷新按钮的 tooltip 文案 | - | - |
+| position | `"left" | "right" | "top" | "bottom" | Options` | `undefined` | 否 | 状态提示或刷新按钮的弹出位置 | - | - |
 

package/docs_for_llm/steps.doc.md

@@ -12,33 +12,107 @@ import { Steps, Step } from '@king-design/vue';
 ```
 
 ## 属性 (Props)
-| 属性名 | 类型 | 默认值 | 必填 | 说明 | 示例 |
-| --- | --- | --- | --- | --- | --- |
-| value | `number` | `undefined` | 否 | 当前第几步，从 0 开始，可用 v-model 双向绑定 | `<Steps :value="current"></Steps>` |
-| status | `"normal" | "error"` | `"normal"` | 否 | 步骤条的状态 | `<Steps status="error"></Steps>` |
-| type | `"default" | "line" | "simple" | "line-compact"` | `"default"` | 否 | 步骤条样式 | `<Steps type="line"></Steps>` |
-| clickable | `boolean` | `false` | 否 | 是否支持快速切换已完成的步骤 | `<Steps v-model="current" clickable></Steps>` |
-| vertical | `boolean` | `false` | 否 | 是否垂直排列 | `<Steps vertical></Steps>` |
+| 属性名 | 类型 | 默认值 | 必填 | 说明 | 标签 | 示例 |
+| --- | --- | --- | --- | --- | --- | --- |
+| value | `number` | `undefined` | 否 | 当前第几步，从 0 开始，可用 v-model 双向绑定 | - | `<Steps :value="current"></Steps>` |
+| status | `"normal" | "error"` | `"normal"` | 否 | 步骤条的状态 | - | `<Steps status="error"></Steps>` |
+| type | `"default" | "line" | "simple" | "line-compact"` | `"default"` | 否 | 步骤条样式 | - | `<Steps type="line"></Steps>` |
+| clickable | `boolean` | `false` | 否 | 是否支持快速切换已完成的步骤 | - | `<Steps v-model="current" clickable></Steps>` |
+| vertical | `boolean` | `false` | 否 | 是否垂直排列 | - | `<Steps vertical></Steps>` |
 
 ## 子组件 (Sub-Components)
 ### Step
 步骤项组件，用于定义每个步骤的标题和内容
 
+#### 属性 (Props)
 | 属性名 | 类型 | 说明 | 示例 |
 | --- | --- | --- | --- |
 | title | `string` | 步骤标题 | `<Step title="步骤1" />` |
 
+#### 组合示例
+##### 基础用法
+**场景**: 创建一个基本的步骤条
+
+基本的步骤条
+
+**命中的子组件 API**: 属性: title
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue';
+import { Steps, Step } from '@king-design/vue';
+
+const current = ref(1);
+</script>
+<template>
+  <Steps :value="current">
+    <Step title="步骤1" />
+    <Step title="步骤2" />
+    <Step title="步骤3" />
+  </Steps>
+</template>
+```
+
+##### 可点击切换
+**场景**: 可以点击已完成的步骤进行切换
+
+支持点击切换已完成的步骤
+
+**命中的子组件 API**: 属性: title
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue';
+import { Steps, Step } from '@king-design/vue';
+
+const current = ref(0);
+</script>
+<template>
+  <Steps v-model="current" clickable>
+    <Step title="填写信息" />
+    <Step title="确认信息" />
+    <Step title="完成" />
+  </Steps>
+</template>
+```
+
+##### 垂直步骤条
+**场景**: 创建垂直排列的步骤条
+
+垂直排列的步骤条
+
+**命中的子组件 API**: 属性: title
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue';
+import { Steps, Step } from '@king-design/vue';
+
+const current = ref(1);
+</script>
+<template>
+  <Steps :value="current" vertical>
+    <Step title="步骤1" />
+    <Step title="步骤2" />
+    <Step title="步骤3" />
+  </Steps>
+</template>
+```
+
 ## 常见错误与正确用法 (Anti-Hallucination)
+### value 从 1 开始而非 0
 > **错误用法**: `const current = ref(1); // 期望第一步
 <Steps :value="current">`
 > **正确写法**: `const current = ref(0); // 第一步
 <Steps :value="current">`
 > **说明**: Steps 的 value 从 0 开始，0 表示第一步
 
+### 使用 clickable 但未用 v-model
 > **错误用法**: `<Steps :value="current" clickable> <!-- 点击不会改变值 -->`
 > **正确写法**: `<Steps v-model="current" clickable>`
 > **说明**: 使用 clickable 时需要用 v-model 进行双向绑定才能响应点击
 
+### type 值拼写错误
 > **错误用法**: `<Steps type="compact">`
 > **正确写法**: `<Steps type="line-compact">`
 > **说明**: type 只支持 default, line, simple, line-compact

package/docs_for_llm/switch.doc.md

@@ -12,34 +12,49 @@ import { Switch } from '@king-design/vue';
 ```
 
 ## 属性 (Props)
-| 属性名 | 类型 | 默认值 | 必填 | 说明 | 示例 |
-| --- | --- | --- | --- | --- | --- |
-| value | `any` | `false` | 否 | 开关当前值，可用 v-model 双向绑定 | `<Switch v-model="value" />` |
-| trueValue | `any` | `true` | 否 | 开启时的值 | `<Switch trueValue="on" falseValue="off" />` |
-| falseValue | `any` | `false` | 否 | 关闭时的值 | `<Switch trueValue="1" falseValue="0" />` |
-| on | `string` | `undefined` | 否 | 开启时显示的文案 | `<Switch on="开" off="关" />` |
-| off | `string` | `undefined` | 否 | 关闭时显示的文案 | `<Switch on="ON" off="OFF" />` |
-| disabled | `boolean` | `false` | 否 | 是否禁用 | `<Switch disabled />` |
-| loading | `boolean` | `false` | 否 | 是否显示加载状态 | `<Switch :loading="isLoading" />` |
-| size | `"large" | "default" | "small" | "mini"` | `"default"` | 否 | 尺寸 | `<Switch size="small" />` |
-| width | `number | string` | `undefined` | 否 | 开关的宽度 | `<Switch :width="60" />` |
-| height | `number | string` | `undefined` | 否 | 开关的高度 | `<Switch :height="24" />` |
-| name | `string` | `undefined` | 否 | 开关的名称，用于表单提交 | `<Switch name="enable" />` |
-| beforeChange | `(from: any, to: any) => boolean | Promise<boolean>` | `undefined` | 否 | 切换前的拦截函数，返回 false 阻止切换，支持异步 | `<Switch :beforeChange="handleBeforeChange" />` |
+| 属性名 | 类型 | 默认值 | 必填 | 说明 | 标签 | 示例 |
+| --- | --- | --- | --- | --- | --- | --- |
+| value | `any` | `false` | 否 | 开关当前值，可用 v-model 双向绑定 | - | `<Switch v-model="value" />` |
+| trueValue | `any` | `true` | 否 | 开启时的值 | - | `<Switch trueValue="on" falseValue="off" />` |
+| falseValue | `any` | `false` | 否 | 关闭时的值 | - | `<Switch trueValue="1" falseValue="0" />` |
+| on | `string` | `undefined` | 否 | 开启时显示的文案 | - | `<Switch on="开" off="关" />` |
+| off | `string` | `undefined` | 否 | 关闭时显示的文案 | - | `<Switch on="ON" off="OFF" />` |
+| disabled | `boolean` | `false` | 否 | 是否禁用 | - | `<Switch disabled />` |
+| loading | `boolean` | `false` | 否 | 是否显示加载状态 | - | `<Switch :loading="isLoading" />` |
+| size | `"large" | "default" | "small" | "mini"` | `"default"` | 否 | 尺寸 | - | `<Switch size="small" />` |
+| width | `number | string` | `undefined` | 否 | 开关的宽度 | - | `<Switch :width="60" />` |
+| height | `number | string` | `undefined` | 否 | 开关的高度 | - | `<Switch :height="24" />` |
+| name | `string` | `undefined` | 否 | 开关的名称，用于表单提交 | - | `<Switch name="enable" />` |
+| beforeChange | `(from: any, to: any) => boolean | Promise<boolean>` | `undefined` | 否 | 切换前的拦截函数，返回 false 阻止切换，支持异步 | - | `<Switch :beforeChange="handleBeforeChange" />` |
 
 ## 插槽 (Slots)
 | 插槽名 | 说明 | 模板写法 | 示例 |
 | --- | --- | --- | --- |
-| on | 扩展开启时的文案 | `undefined` | - |
-| off | 扩展关闭时的文案 | `undefined` | - |
+| on | 扩展开启时的文案 | `#on` | `<Switch>
+  <template #on>自定义on内容</template>
+</Switch>` |
+| off | 扩展关闭时的文案 | `#off` | `<Switch>
+  <template #off>自定义off内容</template>
+</Switch>` |
+
+### 插槽参数说明
+**on**
+
+- 参数结构: 无参数
+
+**off**
+
+- 参数结构: 无参数
 
 ## 常见错误与正确用法 (Anti-Hallucination)
+### 在 Vue 中使用保留字 Switch
 > **错误用法**: `import { Switch } from '@king-design/vue';
 // 可能在某些情况下与 Vue 保留字冲突`
 > **正确写法**: `import { Switch as KSwitch } from '@king-design/vue';
 // 或直接使用 Switch，现代 Vue 3 通常没问题`
 > **说明**: 在某些 Vue 版本中，Switch 可能是保留字，可以重命名为 KSwitch
 
+### beforeChange 函数未正确返回布尔值
 > **错误用法**: `const beforeChange = async () => {
   await Dialog.confirm({});
   // 忘记返回 true
@@ -54,6 +69,7 @@ import { Switch } from '@king-design/vue';
 }`
 > **说明**: beforeChange 必须返回布尔值，true 允许切换，false 阻止切换
 
+### 自定义值类型与初始值不匹配
 > **错误用法**: `const value = ref(false);
 <Switch v-model="value" trueValue="yes" falseValue="no" />`
 > **正确写法**: `const value = ref('no');