king-design-analyzer 2.1.9 → 2.2.1

package/docs_for_llm/datepicker.doc.md

@@ -12,69 +12,100 @@ import { Datepicker } from '@king-design/vue';
 ```
 
 ## 属性 (Props)
-| 属性名 | 类型 | 默认值 | 必填 | 说明 | 示例 |
-| --- | --- | --- | --- | --- | --- |
-| value | `Value | Value[] | [Value, Value] | [Value, Value][]` | `""` | 否 | 当前选择的值，可用 v-model 双向绑定。范围选择时为 [Value, Value] | `<Datepicker v-model="date" />` |
-| type | `"date" | "datetime" | "year" | "month"` | `"date"` | 否 | 组件类型 | `<Datepicker type="datetime" />` |
-| range | `boolean` | `false` | 否 | 是否选择日期范围 | `<Datepicker range />` |
-| multiple | `boolean` | `false` | 否 | 是否支持多选 | `<Datepicker multiple />` |
-| disabled | `boolean` | `false` | 否 | 是否禁用 | `<Datepicker disabled />` |
-| clearable | `boolean` | `false` | 否 | 是否可清空 | `<Datepicker clearable />` |
-| size | `"large" | "default" | "small" | "mini"` | `"default"` | 否 | 尺寸 | `<Datepicker size="small" />` |
-| placeholder | `string` | `"请选择日期"` | 否 | 占位文案 | `<Datepicker placeholder="选择开始日期" />` |
-| format | `string` | `"YYYY-MM-DD HH:mm:ss"` | 否 | 日期格式化字符串 | `<Datepicker format="YYYY-MM-DD" />` |
-| valueFormat | `string` | `undefined` | 否 | value 值的日期格式化字符串 | `<Datepicker valueFormat="YYYY-MM-DD" />` |
-| showFormat | `string` | `undefined` | 否 | 展示的日期格式化字符串 | `<Datepicker showFormat="YYYY年MM月DD日" />` |
-| min | `Value` | `undefined` | 否 | 最小可选日期 | `<Datepicker min="2024-01-01" />` |
-| max | `Value` | `undefined` | 否 | 最大可选日期 | `<Datepicker max="2024-12-31" />` |
-| disabledDate | `(v: Dayjs) => boolean` | `undefined` | 否 | 禁用日期的函数，返回 true 表示禁用该日期 | `<Datepicker :disabledDate="(d) => d.day() === 0" /></Datepicker>` |
-| shortcuts | `Shortcut[]` | `undefined` | 否 | 快捷方式配置 | `<Datepicker :shortcuts="shortcuts" />` |
-| hideIcon | `boolean` | `false` | 否 | 是否隐藏后面的图标 | `<Datepicker hideIcon />` |
-| fluid | `boolean` | `false` | 否 | 是否宽度 100% | `<Datepicker fluid />` |
-| inline | `boolean` | `false` | 否 | 是否展示内联模式 | `<Datepicker inline />` |
-| flat | `boolean` | `false` | 否 | 是否展示扁平样式 | `<Datepicker flat />` |
-| width | `number | string` | `undefined` | 否 | 指定宽度，自动添加单位 px | `<Datepicker :width="200" />` |
+| 属性名 | 类型 | 默认值 | 必填 | 说明 | 标签 | 示例 |
+| --- | --- | --- | --- | --- | --- | --- |
+| value | `Value | Value[] | [Value, Value] | [Value, Value][]` | `""` | 否 | 当前选择的值，可用 v-model 双向绑定。范围选择时为 [Value, Value] | - | `<Datepicker v-model="date" />` |
+| type | `"date" | "datetime" | "year" | "month"` | `"date"` | 否 | 组件类型 | - | `<Datepicker type="datetime" />` |
+| range | `boolean` | `false` | 否 | 是否选择日期范围 | - | `<Datepicker range />` |
+| multiple | `boolean` | `false` | 否 | 是否支持多选 | - | `<Datepicker multiple />` |
+| filterable | `boolean` | `false` | 否 | 是否支持筛选输入 | - | `<Datepicker filterable />` |
+| loading | `boolean` | `false` | 否 | 数据加载状态 | - | `<Datepicker :loading="loading" />` |
+| disabled | `boolean` | `false` | 否 | 是否禁用 | - | `<Datepicker disabled />` |
+| name | `string` | `undefined` | 否 | 表单元素的 name 属性 | - | `<Datepicker name="startDate" />` |
+| clearable | `boolean` | `false` | 否 | 是否可清空 | - | `<Datepicker clearable />` |
+| size | `"large" | "default" | "small" | "mini"` | `"default"` | 否 | 尺寸 | - | `<Datepicker size="small" />` |
+| placeholder | `string` | `"请选择日期"` | 否 | 占位文案 | - | `<Datepicker placeholder="选择开始日期" />` |
+| format | `string` | `"YYYY-MM-DD HH:mm:ss"` | 否 | 日期格式化字符串 | - | `<Datepicker format="YYYY-MM-DD" />` |
+| valueFormat | `string` | `undefined` | 否 | value 值的日期格式化字符串 | - | `<Datepicker valueFormat="YYYY-MM-DD" />` |
+| showFormat | `string` | `undefined` | 否 | 展示的日期格式化字符串 | - | `<Datepicker showFormat="YYYY年MM月DD日" />` |
+| min | `Value` | `undefined` | 否 | 最小可选日期 | - | `<Datepicker min="2024-01-01" />` |
+| max | `Value` | `undefined` | 否 | 最大可选日期 | - | `<Datepicker max="2024-12-31" />` |
+| disabledDate | `(v: Dayjs) => boolean` | `undefined` | 否 | 禁用日期的函数，返回 true 表示禁用该日期 | - | `<Datepicker :disabledDate="(d) => d.day() === 0" />` |
+| shortcuts | `Shortcut[]` | `undefined` | 否 | 快捷方式配置 | - | `<Datepicker :shortcuts="shortcuts" />` |
+| hideIcon | `boolean` | `false` | 否 | 是否隐藏后面的图标 | - | `<Datepicker hideIcon />` |
+| fluid | `boolean` | `false` | 否 | 是否宽度 100% | - | `<Datepicker fluid />` |
+| inline | `boolean` | `false` | 否 | 是否展示内联模式 | - | `<Datepicker inline />` |
+| flat | `boolean` | `false` | 否 | 是否展示扁平样式 | - | `<Datepicker flat />` |
+| width | `number | string` | `undefined` | 否 | 指定宽度，自动添加单位 px | - | `<Datepicker :width="200" />` |
+| container | `string | ((parentDom: Element, anchor: Node | null) => Element)` | `undefined` | 否 | 指定弹出菜单追加的位置，默认 Dialog 组件会追加到 Dialog 中，其他追加到 body | - | `<Datepicker :container="() => document.body" />` |
+| show | `boolean` | `false` | 否 | 是否展示菜单项（受控模式） | - | `<Datepicker :show="visible" />` |
+| position | `Position | "left" | "bottom" | "right" | "top"` | `{my: 'left top+8', at: 'left bottom'}` | 否 | 菜单弹出的位置 | - | `<Datepicker position="top" />` |
+| nowrap | `boolean` | `false` | 否 | 选中值区域是否不换行展示，适合单行紧凑布局 | - | `<Datepicker nowrap />` |
+| draggable | `boolean` | `false` | 否 | 多选值是否支持拖动排序 | - | `<Datepicker multiple draggable />` |
+| virtual | `boolean` | `false` | 否 | 是否开启虚拟列表，用于大数据量场景 | - | `<Datepicker virtual />` |
 
 ## 事件 (Events)
 | 事件名 | Vue事件名 | 说明 | 回调参数 | 示例 |
 | --- | --- | --- | --- | --- |
 | show | `@show` | 菜单弹出时触发 | `-` | `<Datepicker @show="handleShow" />` |
 | hide | `@hide` | 菜单隐藏时触发 | `-` | `<Datepicker @hide="handleHide" />` |
-| selecting | `@selecting` | 范围选择时，用户正在操作选择时触发 | `value: [Dayjs, Dayjs?]` | `<Datepicker range @selecting="handleSelecting" />` |
+| selecting | `@selecting` | 范围选择时，用户正在操作选择时触发 | `value: [Dayjs, Dayjs?], confirmed: boolean` | `<Datepicker range @selecting="handleSelecting" />` |
 
-### 事件处理函数示例
-**show**:
+### 事件参数说明
+**selecting**
+
+| 参数 | 类型 | 必填 | 默认值 | 说明 |
+| --- | --- | --- | --- | --- |
+| value | `[Dayjs, Dayjs?]` | 是 | - | 当前选择的值 |
+| confirmed | `boolean` | 是 | - | 当前这次 selecting 是否已经进入确认完成态；常见交互过程中通常为 `false`。 |
+
+事件处理示例:
 ```typescript
-const handleShow = () => {
-  console.log('日期选择器已打开');
+const handleSelecting = (value, confirmed) => {
+  console.log('正在选择:', value, confirmed);
 };
 ```
 
-**hide**:
+## 方法 (Methods)
+| 方法名 | 说明 | 参数 | 返回值 |
+| --- | --- | --- | --- |
+| show | 主动展开日期选择面板。 | `-` | `void` |
+| hide | 主动关闭日期选择面板。 | `-` | `void` |
+| position | 重新计算日期选择面板的位置。 | `-` | `void` |
+
+### 方法调用示例
+**show**
+
 ```typescript
-const handleHide = () => {
-  console.log('日期选择器已关闭');
-};
+datepickerRef.value?.show();
 ```
 
-**selecting**:
+**hide**
+
 ```typescript
-const handleSelecting = (value) => {
-  console.log('正在选择:', value);
-};
+datepickerRef.value?.hide();
+```
+
+**position**
+
+```typescript
+datepickerRef.value?.position();
 ```
 
 ## 常见错误与正确用法 (Anti-Hallucination)
+### 范围选择时 value 类型错误
 > **错误用法**: `const date = ref('');
 <Datepicker v-model="date" range />`
 > **正确写法**: `const dateRange = ref<[string, string]>(['', '']);
 <Datepicker v-model="dateRange" range />`
 > **说明**: 当 range 为 true 时，value 必须是 [string, string] 数组
 
+### type 值拼写错误
 > **错误用法**: `<Datepicker type="dateTime" />`
 > **正确写法**: `<Datepicker type="datetime" />`
 > **说明**: type 值为小写 datetime，不是 dateTime
 
+### disabledDate 函数返回值错误
 > **错误用法**: `const disabledDate = (d) => { if (d.day() === 0) return '禁用'; }`
 > **正确写法**: `const disabledDate = (d) => d.day() === 0;`
 > **说明**: disabledDate 必须返回布尔值，true 表示禁用

package/docs_for_llm/description.doc.md

@@ -0,0 +1,75 @@
+# 描述输入 (Description)
+
+面向资源描述、备注和说明信息的简化输入组件，适合需要统一长度和校验规则的描述类字段。
+
+**关键词**: description, remark input, 描述输入, 备注填写, 说明文本
+
+**使用场景**: 资源描述录入、备注信息填写、编辑页备注预览
+
+## 导入语句
+```typescript
+import { Description } from '@ksyun-internal/versatile';
+```
+
+## 属性 (Props)
+| 属性名 | 类型 | 默认值 | 必填 | 说明 | 标签 | 示例 |
+| --- | --- | --- | --- | --- | --- | --- |
+| modelValue | `string | null` | `undefined` | 否 | 描述内容 | - | - |
+
+## 事件 (Events)
+| 事件名 | Vue事件名 | 说明 | 回调参数 | 示例 |
+| --- | --- | --- | --- | --- |
+| update:modelValue | `@update:modelValue` | 描述内容变化时触发，可直接同步备注或说明字段。 | `value?: string | null` | - |
+
+### 事件参数说明
+**update:modelValue**
+
+| 参数 | 类型 | 必填 | 默认值 | 说明 |
+| --- | --- | --- | --- | --- |
+| value | `string | null` | 否 | - | 当前备注或描述文本。 |
+
+## 使用示例
+### 实例备注录入
+**场景**: 在创建或编辑资源时填写用途说明和备注信息。
+
+使用 Description 统一承载资源备注或用途说明。
+
+**使用的 API**: 属性: modelValue | 事件: update:modelValue
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue';
+import { Description } from '@ksyun-internal/versatile';
+
+const remark = ref('用于支付链路的核心应用实例');
+</script>
+
+<template>
+  <Description v-model="remark" />
+</template>
+```
+
+### 编辑资源备注
+**场景**: 在编辑资源信息时实时预览备注字段内容。
+
+在编辑表单中回填已有备注并持续同步到父级状态。
+
+**使用的 API**: 属性: modelValue | 事件: update:modelValue
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue';
+import { Description } from '@ksyun-internal/versatile';
+
+const remark = ref('部署于金融业务生产环境');
+</script>
+
+<template>
+  <Description v-model="remark" />
+  <div>预览：{{ remark }}</div>
+</template>
+```
+
+## 相关组件
+FormItemInput
+

package/docs_for_llm/descriptions.doc.md

@@ -12,33 +12,143 @@ import { Descriptions, DescriptionItem } from '@king-design/vue';
 ```
 
 ## 属性 (Props)
-| 属性名 | 类型 | 默认值 | 必填 | 说明 | 示例 |
-| --- | --- | --- | --- | --- | --- |
-| title | `string | number | VNode` | `undefined` | 否 | 描述列表的标题，显示在最顶部 | `<Descriptions title="用户信息"></Descriptions>` |
-| vertical | `boolean` | `false` | 否 | 是否垂直排列（label 在上，content 在下） | `<Descriptions vertical></Descriptions>` |
-| columns | `number` | `3` | 否 | 一行的 DescriptionItem 数量 | `<Descriptions :columns="2"></Descriptions>` |
-| items | `DescriptionItemProps[]` | `[]` | 否 | 描述列表项内容数组，可替代使用 DescriptionItem 子组件 | `<Descriptions :items="items" />` |
+| 属性名 | 类型 | 默认值 | 必填 | 说明 | 标签 | 示例 |
+| --- | --- | --- | --- | --- | --- | --- |
+| title | `string | number | VNode` | `undefined` | 否 | 描述列表的标题，显示在最顶部 | - | `<Descriptions title="用户信息"></Descriptions>` |
+| vertical | `boolean` | `false` | 否 | 是否垂直排列（label 在上，content 在下） | - | `<Descriptions vertical></Descriptions>` |
+| columns | `number` | `3` | 否 | 一行的 DescriptionItem 数量 | - | `<Descriptions :columns="2"></Descriptions>` |
+| items | `DescriptionItemProps[]` | `[]` | 否 | 描述列表项内容数组，可替代使用 DescriptionItem 子组件 | - | `<Descriptions :items="items" />` |
 
 ## 插槽 (Slots)
 | 插槽名 | 说明 | 模板写法 | 示例 |
 | --- | --- | --- | --- |
-| title | 自定义title | `undefined` | - |
+| title | 自定义title | `#title` | `<Descriptions>
+  <template #title>自定义标题</template>
+</Descriptions>` |
+
+### 插槽参数说明
+**title**
+
+- 参数结构: 无参数
 
 ## 子组件 (Sub-Components)
 ### DescriptionItem
 描述列表项组件，用于定义每个字段的标签和内容
 
+#### 属性 (Props)
 | 属性名 | 类型 | 说明 | 示例 |
 | --- | --- | --- | --- |
 | label | `string | number | VNode` | 内容的标题/标签 | `<DescriptionItem label="姓名">张三</DescriptionItem>` |
 | content | `string | number | VNode` | 包含内容，也可直接在标签内写内容 | `<DescriptionItem label="姓名" content="张三" />` |
 | append | `string | number | VNode` | 自定义内容，常用于操作区 | `<DescriptionItem label="手机" append="修改">138****8000</DescriptionItem>` |
 
-**插槽**:
-- `undefined`: 用于超长省略后的操作区自定义内容
-- `undefined`: 自定义label
+#### 插槽 (Slots)
+| 插槽名 | 说明 | 模板写法 | 示例 |
+| --- | --- | --- | --- |
+| append | 用于超长省略后的操作区自定义内容 | `#append` | `<DescriptionItem label="手机号">
+  138****8000
+  <template #append>
+    修改
+  </template>
+</DescriptionItem>` |
+| label | 自定义label | `#label` | `<DescriptionItem>
+  <template #label>
+    联系方式
+  </template>
+  138****8000
+</DescriptionItem>` |
+
+##### 插槽参数说明
+**append**
+
+- 参数结构: 无参数
+
+**label**
+
+- 参数结构: 无参数
+
+#### 组合示例
+##### 带操作按钮
+**场景**: 在描述项后添加操作按钮
+
+在描述项后添加操作按钮
+
+**命中的子组件 API**: 属性: label | 插槽: append
+
+```vue
+<script setup lang="ts">
+import { Descriptions, DescriptionItem, Button } from '@king-design/vue';
+</script>
+<template>
+  <Descriptions title="账户信息" :columns="2">
+    <DescriptionItem label="手机号">
+      138****8000
+      <template #append>
+        <Button type="link" size="small">修改</Button>
+      </template>
+    </DescriptionItem>
+    <DescriptionItem label="邮箱">
+      zhang***@example.com
+      <template #append>
+        <Button type="link" size="small">修改</Button>
+      </template>
+    </DescriptionItem>
+  </Descriptions>
+</template>
+```
+
+##### 基础用法
+**场景**: 创建基本的信息展示描述列表
+
+基本的描述列表
+
+**命中的子组件 API**: 属性: label
+
+```vue
+<script setup lang="ts">
+import { Descriptions, DescriptionItem } from '@king-design/vue';
+</script>
+<template>
+  <Descriptions title="用户信息">
+    <DescriptionItem label="姓名">张三</DescriptionItem>
+    <DescriptionItem label="年龄">28</DescriptionItem>
+    <DescriptionItem label="性别">男</DescriptionItem>
+    <DescriptionItem label="电话">13800138000</DescriptionItem>
+    <DescriptionItem label="地址">北京市朝阳区</DescriptionItem>
+    <DescriptionItem label="邮箱">zhangsan@example.com</DescriptionItem>
+  </Descriptions>
+</template>
+```
+
+##### 详情页示例
+**场景**: 详情页的完整信息展示
+
+完整的详情页信息展示
+
+**命中的子组件 API**: 属性: label
+
+```vue
+<script setup lang="ts">
+import { Descriptions, DescriptionItem, Card, Tag } from '@king-design/vue';
+</script>
+<template>
+  <Card title="订单详情">
+    <Descriptions :columns="3">
+      <DescriptionItem label="订单编号">DD2024010100001</DescriptionItem>
+      <DescriptionItem label="创建时间">2024-01-01 10:30:00</DescriptionItem>
+      <DescriptionItem label="订单状态">
+        <Tag type="success">已完成</Tag>
+      </DescriptionItem>
+      <DescriptionItem label="收货人">张三</DescriptionItem>
+      <DescriptionItem label="联系电话">13800138000</DescriptionItem>
+      <DescriptionItem label="收货地址">北京市朝阳区xxx路xxx号</DescriptionItem>
+    </Descriptions>
+  </Card>
+</template>
+```
 
 ## 常见错误与正确用法 (Anti-Hallucination)
+### DescriptionItem 未设置 label
 > **错误用法**: `<Descriptions>
   <DescriptionItem>张三</DescriptionItem>
 </Descriptions>`
@@ -47,6 +157,7 @@ import { Descriptions, DescriptionItem } from '@king-design/vue';
 </Descriptions>`
 > **说明**: DescriptionItem 应该设置 label 属性来标识字段名称
 
+### items 数组结构错误
 > **错误用法**: `const items = ['姓名', '年龄'];`
 > **正确写法**: `const items = [
   { label: '姓名', content: '张三' },
@@ -54,6 +165,7 @@ import { Descriptions, DescriptionItem } from '@king-design/vue';
 ];`
 > **说明**: items 数组中的每个元素必须是包含 label 和 content 的对象
 
+### columns 使用字符串而非数字
 > **错误用法**: `<Descriptions columns="2">`
 > **正确写法**: `<Descriptions :columns="2">`
 > **说明**: columns 是数字类型，需要使用 v-bind (:columns) 语法传入数字