ep-craft 0.1.41 → 0.2.0

package/dist-ai/components/form.json

@@ -0,0 +1,277 @@
+{
+  "entry": {
+    "category": "form",
+    "events": [
+      {
+        "description": "任一表单项被校验后触发",
+        "name": "validate",
+        "params": "(prop: string, isValid: boolean, message: string)"
+      }
+    ],
+    "exampleOmittedReason": null,
+    "examples": [
+      {
+        "code": "<script setup lang=\"ts\">\nimport { reactive, ref } from 'vue'\nimport { EpButton, EpForm, EpFormItem, EpInput } from 'ep-craft'\n\nconst formRef = ref()\nconst form = reactive({ name: '', email: '' })\nconst rules = {\n  name: [{ required: true, message: '请输入姓名', trigger: 'blur' }],\n  email: [{ required: true, message: '请输入邮箱', trigger: 'blur' }],\n}\n\nconst submit = async () => {\n  await formRef.value?.validate()\n}\n</script>\n\n<template>\n  <ep-form ref=\"formRef\" :model=\"form\" :rules=\"rules\" label-width=\"80px\">\n    <ep-form-item label=\"姓名\" prop=\"name\">\n      <ep-input v-model=\"form.name\" />\n    </ep-form-item>\n    <ep-form-item label=\"邮箱\" prop=\"email\">\n      <ep-input v-model=\"form.email\" />\n    </ep-form-item>\n    <ep-form-item>\n      <ep-button type=\"primary\" @click=\"submit\">提交</ep-button>\n    </ep-form-item>\n  </ep-form>\n</template>",
+        "id": "form-1",
+        "language": "vue",
+        "title": "表单与校验"
+      }
+    ],
+    "exposes": [
+      {
+        "description": "对整个表单的内容进行验证",
+        "name": "validate",
+        "type": "(callback?: (isValid: boolean, invalidFields?: ValidateFieldsError) => void) => Promise<boolean>"
+      },
+      {
+        "description": "验证具体的某个字段",
+        "name": "validateField",
+        "type": "(props?: string | string[], callback?: (isValid: boolean, invalidFields?: ValidateFieldsError) => void) => Promise<boolean>"
+      },
+      {
+        "description": "重置该表单项",
+        "name": "resetFields",
+        "type": "(props?: string | string[]) => void"
+      },
+      {
+        "description": "滚动到指定的字段",
+        "name": "scrollToField",
+        "type": "(prop: string) => void"
+      },
+      {
+        "description": "清理某个字段的表单验证信息",
+        "name": "clearValidate",
+        "type": "(props?: string | string[]) => void"
+      }
+    ],
+    "hot": true,
+    "id": "component:form",
+    "keywords": {
+      "en": [
+        "form",
+        "validation",
+        "submit"
+      ],
+      "zh": [
+        "表单",
+        "校验",
+        "提交"
+      ]
+    },
+    "kind": "component",
+    "name": "EpForm",
+    "nonUseCases": [
+      "仅展示只读详情时使用 Descriptions"
+    ],
+    "props": [
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "表单数据对象",
+        "hasDefault": false,
+        "name": "model",
+        "required": false,
+        "type": "Record<string, any>"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "表单验证规则",
+        "hasDefault": false,
+        "name": "rules",
+        "required": false,
+        "type": "FormRules"
+      },
+      {
+        "alias": null,
+        "defaultText": "right",
+        "description": "表单域标签的位置",
+        "hasDefault": true,
+        "name": "labelPosition",
+        "required": false,
+        "type": "'left' | 'right' | 'top'"
+      },
+      {
+        "alias": null,
+        "defaultText": "left",
+        "description": "星号的位置",
+        "hasDefault": true,
+        "name": "requireAsteriskPosition",
+        "required": false,
+        "type": "'left' | 'right'"
+      },
+      {
+        "alias": null,
+        "defaultText": "''",
+        "description": "标签的宽度",
+        "hasDefault": true,
+        "name": "labelWidth",
+        "required": false,
+        "type": "string | number"
+      },
+      {
+        "alias": null,
+        "defaultText": "''",
+        "description": "表单域标签的后缀",
+        "hasDefault": true,
+        "name": "labelSuffix",
+        "required": false,
+        "type": "string"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "行内表单模式",
+        "hasDefault": false,
+        "name": "inline",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否以行内形式展示校验信息",
+        "hasDefault": false,
+        "name": "inlineMessage",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否在输入框中显示校验结果反馈图标",
+        "hasDefault": false,
+        "name": "statusIcon",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "是否显示校验错误信息",
+        "hasDefault": true,
+        "name": "showMessage",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "是否在 rules 属性改变后立即触发一次验证",
+        "hasDefault": true,
+        "name": "validateOnRuleChange",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否隐藏必填字段标签旁的红色星号",
+        "hasDefault": false,
+        "name": "hideRequiredAsterisk",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "当校验失败时，滚动到第一个错误表单项",
+        "hasDefault": false,
+        "name": "scrollToError",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "当校验有失败结果时，滚动到第一个失败的表单项的配置",
+        "hasDefault": true,
+        "name": "scrollIntoViewOptions",
+        "required": false,
+        "type": "object | boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "default",
+        "description": "用于控制该表单内组件的尺寸",
+        "hasDefault": false,
+        "name": "size",
+        "required": false,
+        "type": "'large' | 'default' | 'small'"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否禁用该表单内的所有组件",
+        "hasDefault": false,
+        "name": "disabled",
+        "required": false,
+        "type": "boolean"
+      }
+    ],
+    "related": [
+      "EpFormItem",
+      "EpInput",
+      "EpSelect"
+    ],
+    "relations": {
+      "children": [
+        "EpFormItem"
+      ],
+      "combos": [
+        "EpForm + EpFormItem"
+      ],
+      "parents": [],
+      "requiredChildren": [
+        "EpFormItem"
+      ]
+    },
+    "slots": [
+      {
+        "description": "自定义默认内容",
+        "name": "default"
+      }
+    ],
+    "slug": "form",
+    "summary": "表单容器，统一管理校验与提交",
+    "tag": "ep-form",
+    "useCases": [
+      "组织多个表单项并统一校验",
+      "收集、提交与重置业务数据"
+    ],
+    "variants": [
+      {
+        "dimension": "size",
+        "values": [
+          "large",
+          "default",
+          "small"
+        ],
+        "when": "按容器空间与信息密度选择尺寸"
+      },
+      {
+        "dimension": "state",
+        "values": [
+          "disabled"
+        ],
+        "when": "通过布尔属性切换禁用、加载或选中状态"
+      }
+    ],
+    "visual": {
+      "cssVars": [
+        "--el-border-color",
+        "--el-border-radius-base",
+        "--el-color-primary",
+        "--el-font-size-base"
+      ],
+      "density": "中等",
+      "shape": "矩形输入框",
+      "slotContent": [
+        "default：自定义默认内容"
+      ]
+    }
+  },
+  "generatedAt": "2026-11-03T03:09:12.050Z",
+  "libraryVersion": "0.2.0",
+  "schemaVersion": 1
+}

package/dist-ai/components/form.md

@@ -0,0 +1,117 @@
+# EpForm
+
+`ep-form` · form（表单） · `component:form`
+
+## 摘要
+
+表单容器，统一管理校验与提交
+
+## 适用场景
+
+- 适用：组织多个表单项并统一校验
+- 适用：收集、提交与重置业务数据
+- 不适用：仅展示只读详情时使用 Descriptions
+
+## 关键词
+
+- 中文：表单、校验、提交
+- English: form, validation, submit
+
+## 变体
+
+- size: large/default/small（按容器空间与信息密度选择尺寸）
+- state: disabled（通过布尔属性切换禁用、加载或选中状态）
+
+## Props
+
+- model (Record<string, any>)：表单数据对象
+- rules (FormRules)：表单验证规则
+- labelPosition ('left' | 'right' | 'top'，默认 right)：表单域标签的位置
+- requireAsteriskPosition ('left' | 'right'，默认 left)：星号的位置
+- labelWidth (string | number，默认 '')：标签的宽度
+- labelSuffix (string，默认 '')：表单域标签的后缀
+- inline (boolean)：行内表单模式
+- inlineMessage (boolean)：是否以行内形式展示校验信息
+- statusIcon (boolean)：是否在输入框中显示校验结果反馈图标
+- showMessage (boolean，默认 true)：是否显示校验错误信息
+- validateOnRuleChange (boolean，默认 true)：是否在 rules 属性改变后立即触发一次验证
+- hideRequiredAsterisk (boolean)：是否隐藏必填字段标签旁的红色星号
+- scrollToError (boolean)：当校验失败时，滚动到第一个错误表单项
+- scrollIntoViewOptions (object | boolean，默认 见文档)：当校验有失败结果时，滚动到第一个失败的表单项的配置
+- size ('large' | 'default' | 'small')：用于控制该表单内组件的尺寸
+- disabled (boolean)：是否禁用该表单内的所有组件
+
+## Events
+
+- validate((prop: string, isValid: boolean, message: string))：任一表单项被校验后触发
+
+## Slots
+
+- default：自定义默认内容
+
+## Exposes
+
+- validate((callback?: (isValid: boolean, invalidFields?: ValidateFieldsError) => void) => Promise<boolean>)：对整个表单的内容进行验证
+- validateField((props?: string | string[], callback?: (isValid: boolean, invalidFields?: ValidateFieldsError) => void) => Promise<boolean>)：验证具体的某个字段
+- resetFields((props?: string | string[]) => void)：重置该表单项
+- scrollToField((prop: string) => void)：滚动到指定的字段
+- clearValidate((props?: string | string[]) => void)：清理某个字段的表单验证信息
+
+## 关系
+
+- 子级：EpFormItem
+- 必需子组件：EpFormItem
+- 常用组合：EpForm + EpFormItem
+
+## 视觉提示
+
+- 形状：矩形输入框
+- 密度：中等
+- 插槽内容：default：自定义默认内容
+- CSS 变量：--el-border-color、--el-border-radius-base、--el-color-primary、--el-font-size-base
+
+## 示例
+
+### 表单与校验
+
+```vue
+<script setup lang="ts">
+import { reactive, ref } from 'vue'
+import { EpButton, EpForm, EpFormItem, EpInput } from 'ep-craft'
+
+const formRef = ref()
+const form = reactive({ name: '', email: '' })
+const rules = {
+  name: [{ required: true, message: '请输入姓名', trigger: 'blur' }],
+  email: [{ required: true, message: '请输入邮箱', trigger: 'blur' }],
+}
+
+const submit = async () => {
+  await formRef.value?.validate()
+}
+</script>
+
+<template>
+  <ep-form ref="formRef" :model="form" :rules="rules" label-width="80px">
+    <ep-form-item label="姓名" prop="name">
+      <ep-input v-model="form.name" />
+    </ep-form-item>
+    <ep-form-item label="邮箱" prop="email">
+      <ep-input v-model="form.email" />
+    </ep-form-item>
+    <ep-form-item>
+      <ep-button type="primary" @click="submit">提交</ep-button>
+    </ep-form-item>
+  </ep-form>
+</template>
+```
+
+## 相关条目
+
+- EpFormItem
+- EpInput
+- EpSelect
+
+---
+
+ep-craft 0.2.0

package/dist-ai/components/header.json

@@ -0,0 +1,86 @@
+{
+  "entry": {
+    "category": "layout",
+    "events": [],
+    "exampleOmittedReason": null,
+    "examples": [
+      {
+        "code": "<script setup lang=\"ts\">\nimport { EpContainer, EpHeader, EpMain } from 'ep-craft'\n</script>\n\n<template>\n  <ep-container style=\"height: 180px\">\n    <ep-header height=\"48px\">页头</ep-header>\n    <ep-main>主体内容</ep-main>\n  </ep-container>\n</template>",
+        "id": "header-1",
+        "language": "vue",
+        "title": "页头"
+      }
+    ],
+    "exposes": [],
+    "hot": false,
+    "id": "component:header",
+    "keywords": {
+      "en": [
+        "header",
+        "layout"
+      ],
+      "zh": [
+        "页头",
+        "布局"
+      ]
+    },
+    "kind": "component",
+    "name": "EpHeader",
+    "nonUseCases": [
+      "已有明确外层布局且无需此语义时"
+    ],
+    "props": [
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "页头高度，缺省时由 theme-chalk 的 CSS 变量兜底",
+        "hasDefault": true,
+        "name": "height",
+        "required": false,
+        "type": "string"
+      }
+    ],
+    "related": [
+      "EpContainer"
+    ],
+    "relations": {
+      "children": [],
+      "combos": [
+        "EpContainer + EpHeader"
+      ],
+      "parents": [
+        "EpContainer"
+      ],
+      "requiredChildren": []
+    },
+    "slots": [
+      {
+        "description": "页头内容",
+        "name": "default"
+      }
+    ],
+    "slug": "header",
+    "summary": "页头，页面结构与浮层交互",
+    "tag": "ep-header",
+    "useCases": [
+      "使用页头组织页面区域与间距",
+      "承载内容分组或浮层交互"
+    ],
+    "variants": [],
+    "visual": {
+      "cssVars": [
+        "--el-bg-color",
+        "--el-border-color",
+        "--el-border-radius-base"
+      ],
+      "density": "宽松",
+      "shape": "区块容器",
+      "slotContent": [
+        "default：页头内容"
+      ]
+    }
+  },
+  "generatedAt": "2026-11-03T03:09:12.050Z",
+  "libraryVersion": "0.2.0",
+  "schemaVersion": 1
+}

package/dist-ai/components/header.md

@@ -0,0 +1,63 @@
+# EpHeader
+
+`ep-header` · layout（布局） · `component:header`
+
+## 摘要
+
+页头，页面结构与浮层交互
+
+## 适用场景
+
+- 适用：使用页头组织页面区域与间距
+- 适用：承载内容分组或浮层交互
+- 不适用：已有明确外层布局且无需此语义时
+
+## 关键词
+
+- 中文：页头、布局
+- English: header, layout
+
+## Props
+
+- height (string，默认 见文档)：页头高度，缺省时由 theme-chalk 的 CSS 变量兜底
+
+## Slots
+
+- default：页头内容
+
+## 关系
+
+- 父级：EpContainer
+- 常用组合：EpContainer + EpHeader
+
+## 视觉提示
+
+- 形状：区块容器
+- 密度：宽松
+- 插槽内容：default：页头内容
+- CSS 变量：--el-bg-color、--el-border-color、--el-border-radius-base
+
+## 示例
+
+### 页头
+
+```vue
+<script setup lang="ts">
+import { EpContainer, EpHeader, EpMain } from 'ep-craft'
+</script>
+
+<template>
+  <ep-container style="height: 180px">
+    <ep-header height="48px">页头</ep-header>
+    <ep-main>主体内容</ep-main>
+  </ep-container>
+</template>
+```
+
+## 相关条目
+
+- EpContainer
+
+---
+
+ep-craft 0.2.0

package/dist-ai/components/icon.json

@@ -0,0 +1,95 @@
+{
+  "entry": {
+    "category": "feedback",
+    "events": [],
+    "exampleOmittedReason": null,
+    "examples": [
+      {
+        "code": "<script setup lang=\"ts\">\nimport { EpIcon } from 'ep-craft'\nimport { Search } from 'ep-craft/icons'\n</script>\n\n<template>\n  <ep-icon :size=\"24\" color=\"#409eff\">\n    <Search />\n  </ep-icon>\n</template>",
+        "id": "icon-1",
+        "language": "vue",
+        "title": "图标"
+      }
+    ],
+    "exposes": [],
+    "hot": false,
+    "id": "component:icon",
+    "keywords": {
+      "en": [
+        "icon",
+        "glyph",
+        "feedback"
+      ],
+      "zh": [
+        "图标",
+        "反馈"
+      ]
+    },
+    "kind": "component",
+    "name": "EpIcon",
+    "nonUseCases": [
+      "无需用户感知状态变化时",
+      "需要完整业务弹窗流程时优先使用 Dialog"
+    ],
+    "props": [
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "SVG 图标尺寸，宽高相同",
+        "hasDefault": false,
+        "name": "size",
+        "required": false,
+        "type": "number | string"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "SVG 图标的 fill 颜色",
+        "hasDefault": false,
+        "name": "color",
+        "required": false,
+        "type": "string"
+      }
+    ],
+    "related": [
+      "EpButton",
+      "EpLink"
+    ],
+    "relations": {
+      "children": [],
+      "combos": [],
+      "parents": [],
+      "requiredChildren": []
+    },
+    "slots": [
+      {
+        "description": "图标内容（SVG 或组件）",
+        "name": "default"
+      }
+    ],
+    "slug": "icon",
+    "summary": "图标，状态与结果反馈",
+    "tag": "ep-icon",
+    "useCases": [
+      "展示图标并向用户传达状态",
+      "在操作前后提供即时反馈"
+    ],
+    "variants": [],
+    "visual": {
+      "cssVars": [
+        "--el-color-success",
+        "--el-color-warning",
+        "--el-color-danger",
+        "--el-font-size-base"
+      ],
+      "density": "中等",
+      "shape": "行内或块级提示",
+      "slotContent": [
+        "default：图标内容（SVG 或组件）"
+      ]
+    }
+  },
+  "generatedAt": "2026-11-03T03:09:12.050Z",
+  "libraryVersion": "0.2.0",
+  "schemaVersion": 1
+}

package/dist-ai/components/icon.md

@@ -0,0 +1,61 @@
+# EpIcon
+
+`ep-icon` · feedback（反馈） · `component:icon`
+
+## 摘要
+
+图标，状态与结果反馈
+
+## 适用场景
+
+- 适用：展示图标并向用户传达状态
+- 适用：在操作前后提供即时反馈
+- 不适用：无需用户感知状态变化时
+- 不适用：需要完整业务弹窗流程时优先使用 Dialog
+
+## 关键词
+
+- 中文：图标、反馈
+- English: icon, glyph, feedback
+
+## Props
+
+- size (number | string)：SVG 图标尺寸，宽高相同
+- color (string)：SVG 图标的 fill 颜色
+
+## Slots
+
+- default：图标内容（SVG 或组件）
+
+## 视觉提示
+
+- 形状：行内或块级提示
+- 密度：中等
+- 插槽内容：default：图标内容（SVG 或组件）
+- CSS 变量：--el-color-success、--el-color-warning、--el-color-danger、--el-font-size-base
+
+## 示例
+
+### 图标
+
+```vue
+<script setup lang="ts">
+import { EpIcon } from 'ep-craft'
+import { Search } from 'ep-craft/icons'
+</script>
+
+<template>
+  <ep-icon :size="24" color="#409eff">
+    <Search />
+  </ep-icon>
+</template>
+```
+
+## 相关条目
+
+- EpButton
+- EpLink
+
+---
+
+ep-craft 0.2.0