ep-craft 0.1.41 → 0.2.0

package/dist-ai/components/tooltip.md

@@ -0,0 +1,137 @@
+# EpTooltip
+
+`ep-tooltip` · layout（布局） · `component:tooltip`
+
+## 摘要
+
+文字提示，悬停展示简短说明
+
+## 适用场景
+
+- 适用：图标或截断文本的解释
+- 适用：补充字段含义与操作说明
+- 不适用：需要承载可交互内容时使用 Popover
+
+## 关键词
+
+- 中文：文字提示、悬停、气泡、布局
+- English: tooltip, hint, hover, layout
+
+## 变体
+
+- state: disabled（通过布尔属性切换禁用、加载或选中状态）
+- effect: dark/light（通过视觉修饰属性调整外观效果）
+
+## Props
+
+- showArrow (boolean，默认 true)：是否显示箭头
+- onUpdate:visible (unknown)
+- role (unknown，默认 见文档)
+- appendTo (unknown)
+- content (string，默认 '')：显示的内容
+- rawContent (boolean)：content 中的内容是否作为 HTML 字符串处理
+- persistent (boolean)：当 tooltip 组件长时间不触发且 persistent 为 false 时销毁
+- visible（别名 v-model:visible） (boolean，默认 见文档)：Tooltip 组件可见性
+- transition (string)：动画名称
+- teleported (boolean，默认 true)：是否使用 teleport
+- disabled (boolean)：Tooltip 组件是否禁用
+- ariaLabel (string)：与 aria-label 属性保持一致
+- showAfter (number，默认 0)：在触发后多久显示内容
+- hideAfter (number，默认 200)：延迟关闭
+- autoClose (number，默认 0)：自动隐藏时长
+- id (unknown)
+- style (unknown，默认 见文档)
+- className (unknown)
+- effect ('dark' | 'light'，默认 dark)：Tooltip 主题
+- enterable (boolean，默认 true)：鼠标是否可进入到 tooltip 中
+- pure (unknown，默认 见文档)
+- focusOnShow (unknown，默认 见文档)
+- trapping (unknown，默认 见文档)
+- popperClass (string)：为 Tooltip 的 popper 添加类名
+- popperStyle (unknown，默认 见文档)
+- referenceEl (unknown)
+- triggerTargetEl (unknown)
+- stopPopperMouseEvent (unknown，默认 见文档)
+- virtualTriggering (boolean，默认 false)：是否使用虚拟触发
+- zIndex (unknown)
+- loop (unknown，默认 见文档)
+- boundariesPadding (unknown，默认 见文档)
+- fallbackPlacements (unknown)
+- gpuAcceleration (unknown，默认 见文档)
+- offset (number，默认 12)：出现位置的偏移量
+- placement ('top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end' | 'right' | 'right-start' | 'right-end'，默认 bottom)：Tooltip 组件出现的位置
+- popperOptions (object，默认 {})：popper.js 的参数
+- strategy (unknown，默认 见文档)
+- arrowOffset (unknown，默认 见文档)
+- trigger ('hover' | 'click' | 'focus' | 'contextmenu'，默认 hover)：如何触发 Tooltip
+- triggerKeys (string[]，默认 ['Enter', 'Space'])：触发 tooltip 显示的按键
+- focusOnTarget (unknown)
+- virtualRef (HTMLElement)：虚拟触发的引用
+- onMouseenter (unknown)
+- onMouseleave (unknown)
+- onClick (unknown)
+- onKeydown (unknown)
+- onFocus (unknown)
+- onBlur (unknown)
+- onContextmenu (unknown)
+- open (unknown)
+
+## Events
+
+- update:visible((visible: boolean))：Tooltip 可见性变化时触发
+- beforeShow((event?: Event))：显示动画播放前触发
+- beforeHide((event?: Event))：隐藏动画播放前触发
+- show((event?: Event))：显示时触发
+- hide((event?: Event))：隐藏时触发
+- open((event?: Event))：显示时触发（兼容事件名，建议监听 show）
+- close((event?: Event))：隐藏时触发（兼容事件名，建议监听 hide）
+
+## Slots
+
+- default：Tooltip 触发 & 引用的元素
+- content：自定义内容
+
+## 视觉提示
+
+- 形状：区块容器
+- 密度：宽松
+- 插槽内容：default：Tooltip 触发 & 引用的元素；content：自定义内容
+- CSS 变量：--el-bg-color、--el-border-color、--el-border-radius-base
+
+## 示例
+
+### 基础提示
+
+```vue
+<script setup lang="ts">
+import { EpButton, EpTooltip } from 'ep-craft'
+</script>
+
+<template>
+  <ep-tooltip content="这里展示提示内容">
+    <ep-button>悬停查看</ep-button>
+  </ep-tooltip>
+</template>
+```
+
+### 深色提示
+
+```vue
+<script setup lang="ts">
+import { EpButton, EpTooltip } from 'ep-craft'
+</script>
+
+<template>
+  <ep-tooltip content="右侧提示" placement="right" effect="dark">
+    <ep-button>右侧</ep-button>
+  </ep-tooltip>
+</template>
+```
+
+## 相关条目
+
+- EpPopover
+
+---
+
+ep-craft 0.2.0

package/dist-ai/components/tour-step.json

@@ -0,0 +1,219 @@
+{
+  "entry": {
+    "category": "feedback",
+    "events": [
+      {
+        "description": "关闭当前步骤时触发",
+        "name": "close",
+        "params": "—"
+      }
+    ],
+    "exampleOmittedReason": null,
+    "examples": [
+      {
+        "code": "<script setup lang=\"ts\">\nimport { ref } from 'vue'\nimport { EpButton, EpTour, EpTourStep } from 'ep-craft'\n\nconst open = ref(true)\n</script>\n\n<template>\n  <ep-button id=\"tour-step-target\">目标按钮</ep-button>\n  <ep-tour v-model=\"open\">\n    <ep-tour-step target=\"#tour-step-target\" title=\"说明\" description=\"引导步骤内容\" />\n  </ep-tour>\n</template>",
+        "id": "tour-step-1",
+        "language": "vue",
+        "title": "引导步骤"
+      }
+    ],
+    "exposes": [],
+    "hot": false,
+    "id": "component:tour-step",
+    "keywords": {
+      "en": [
+        "tour-step",
+        "tour",
+        "step",
+        "guide",
+        "feedback"
+      ],
+      "zh": [
+        "引导步骤",
+        "反馈"
+      ]
+    },
+    "kind": "component",
+    "name": "EpTourStep",
+    "nonUseCases": [
+      "无需用户感知状态变化时",
+      "需要完整业务弹窗流程时优先使用 Dialog"
+    ],
+    "props": [
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "引导卡片指向的元素，为空时显示在屏幕中央",
+        "hasDefault": false,
+        "name": "target",
+        "required": false,
+        "type": "string | HTMLElement | (() => HTMLElement | null) | null"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "引导内容标题",
+        "hasDefault": false,
+        "name": "title",
+        "required": false,
+        "type": "string"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "描述内容",
+        "hasDefault": false,
+        "name": "description",
+        "required": false,
+        "type": "string"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "是否显示关闭按钮",
+        "hasDefault": true,
+        "name": "showClose",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "自定义关闭图标",
+        "hasDefault": false,
+        "name": "closeIcon",
+        "required": false,
+        "type": "string | Component"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "是否显示箭头",
+        "hasDefault": true,
+        "name": "showArrow",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "bottom",
+        "description": "引导卡片相对目标元素的位置",
+        "hasDefault": true,
+        "name": "placement",
+        "required": false,
+        "type": "Placement"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "是否启用遮罩，可传对象自定义样式与填充色",
+        "hasDefault": true,
+        "name": "mask",
+        "required": false,
+        "type": "boolean | TourMask"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "内容自定义样式",
+        "hasDefault": false,
+        "name": "contentStyle",
+        "required": false,
+        "type": "CSSProperties"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "上一步按钮的属性",
+        "hasDefault": false,
+        "name": "prevButtonProps",
+        "required": false,
+        "type": "TourBtnProps"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "下一步按钮的属性",
+        "hasDefault": false,
+        "name": "nextButtonProps",
+        "required": false,
+        "type": "TourBtnProps"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "自定义 scrollIntoView 配置",
+        "hasDefault": true,
+        "name": "scrollIntoViewOptions",
+        "required": false,
+        "type": "boolean | ScrollIntoViewOptions"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "类型，影响背景色与文字颜色",
+        "hasDefault": false,
+        "name": "type",
+        "required": false,
+        "type": "'default' | 'primary'"
+      }
+    ],
+    "related": [
+      "EpTour"
+    ],
+    "relations": {
+      "children": [],
+      "combos": [
+        "EpTour + EpTourStep"
+      ],
+      "parents": [
+        "EpTour"
+      ],
+      "requiredChildren": []
+    },
+    "slots": [
+      {
+        "description": "自定义头部内容",
+        "name": "header"
+      },
+      {
+        "description": "自定义主体内容",
+        "name": "default"
+      }
+    ],
+    "slug": "tour-step",
+    "summary": "引导步骤，状态与结果反馈",
+    "tag": "ep-tour-step",
+    "useCases": [
+      "展示引导步骤并向用户传达状态",
+      "在操作前后提供即时反馈"
+    ],
+    "variants": [
+      {
+        "dimension": "type",
+        "values": [
+          "default",
+          "primary"
+        ],
+        "when": "通过 type 选择类型，影响背景色与文字颜色"
+      }
+    ],
+    "visual": {
+      "cssVars": [
+        "--el-color-success",
+        "--el-color-warning",
+        "--el-color-danger",
+        "--el-font-size-base"
+      ],
+      "density": "中等",
+      "shape": "行内或块级提示",
+      "slotContent": [
+        "header：自定义头部内容",
+        "default：自定义主体内容"
+      ]
+    }
+  },
+  "generatedAt": "2026-11-03T03:09:12.050Z",
+  "libraryVersion": "0.2.0",
+  "schemaVersion": 1
+}

package/dist-ai/components/tour-step.md

@@ -0,0 +1,88 @@
+# EpTourStep
+
+`ep-tour-step` · feedback（反馈） · `component:tour-step`
+
+## 摘要
+
+引导步骤，状态与结果反馈
+
+## 适用场景
+
+- 适用：展示引导步骤并向用户传达状态
+- 适用：在操作前后提供即时反馈
+- 不适用：无需用户感知状态变化时
+- 不适用：需要完整业务弹窗流程时优先使用 Dialog
+
+## 关键词
+
+- 中文：引导步骤、反馈
+- English: tour-step, tour, step, guide, feedback
+
+## 变体
+
+- type: default/primary（通过 type 选择类型，影响背景色与文字颜色）
+
+## Props
+
+- target (string | HTMLElement | (() => HTMLElement | null) | null)：引导卡片指向的元素，为空时显示在屏幕中央
+- title (string)：引导内容标题
+- description (string)：描述内容
+- showClose (boolean，默认 见文档)：是否显示关闭按钮
+- closeIcon (string | Component)：自定义关闭图标
+- showArrow (boolean，默认 见文档)：是否显示箭头
+- placement (Placement，默认 bottom)：引导卡片相对目标元素的位置
+- mask (boolean | TourMask，默认 见文档)：是否启用遮罩，可传对象自定义样式与填充色
+- contentStyle (CSSProperties)：内容自定义样式
+- prevButtonProps (TourBtnProps)：上一步按钮的属性
+- nextButtonProps (TourBtnProps)：下一步按钮的属性
+- scrollIntoViewOptions (boolean | ScrollIntoViewOptions，默认 见文档)：自定义 scrollIntoView 配置
+- type ('default' | 'primary')：类型，影响背景色与文字颜色
+
+## Events
+
+- close(—)：关闭当前步骤时触发
+
+## Slots
+
+- header：自定义头部内容
+- default：自定义主体内容
+
+## 关系
+
+- 父级：EpTour
+- 常用组合：EpTour + EpTourStep
+
+## 视觉提示
+
+- 形状：行内或块级提示
+- 密度：中等
+- 插槽内容：header：自定义头部内容；default：自定义主体内容
+- CSS 变量：--el-color-success、--el-color-warning、--el-color-danger、--el-font-size-base
+
+## 示例
+
+### 引导步骤
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue'
+import { EpButton, EpTour, EpTourStep } from 'ep-craft'
+
+const open = ref(true)
+</script>
+
+<template>
+  <ep-button id="tour-step-target">目标按钮</ep-button>
+  <ep-tour v-model="open">
+    <ep-tour-step target="#tour-step-target" title="说明" description="引导步骤内容" />
+  </ep-tour>
+</template>
+```
+
+## 相关条目
+
+- EpTour
+
+---
+
+ep-craft 0.2.0

package/dist-ai/components/tour.json

@@ -0,0 +1,258 @@
+{
+  "entry": {
+    "category": "feedback",
+    "events": [
+      {
+        "description": "打开状态变化时触发",
+        "name": "update:modelValue",
+        "params": "(value: boolean)"
+      },
+      {
+        "description": "当前步骤变化时触发",
+        "name": "update:current",
+        "params": "(current: number)"
+      },
+      {
+        "description": "关闭引导时触发",
+        "name": "close",
+        "params": "(current: number)"
+      },
+      {
+        "description": "完成全部步骤时触发",
+        "name": "finish",
+        "params": "—"
+      },
+      {
+        "description": "当前步骤变化时触发",
+        "name": "change",
+        "params": "(current: number)"
+      }
+    ],
+    "exampleOmittedReason": null,
+    "examples": [
+      {
+        "code": "<script setup lang=\"ts\">\nimport { ref } from 'vue'\nimport { EpButton, EpTour, EpTourStep } from 'ep-craft'\n\nconst open = ref(false)\n</script>\n\n<template>\n  <ep-button id=\"tour-target\" type=\"primary\" @click=\"open = true\">新建项目</ep-button>\n  <ep-tour v-model=\"open\">\n    <ep-tour-step target=\"#tour-target\" title=\"第一步\" description=\"点击这里创建项目\" />\n  </ep-tour>\n</template>",
+        "id": "tour-1",
+        "language": "vue",
+        "title": "漫游引导"
+      }
+    ],
+    "exposes": [],
+    "hot": false,
+    "id": "component:tour",
+    "keywords": {
+      "en": [
+        "tour",
+        "guide",
+        "feedback"
+      ],
+      "zh": [
+        "漫游式引导",
+        "反馈"
+      ]
+    },
+    "kind": "component",
+    "name": "EpTour",
+    "nonUseCases": [
+      "无需用户感知状态变化时",
+      "需要完整业务弹窗流程时优先使用 Dialog"
+    ],
+    "props": [
+      {
+        "alias": "v-model",
+        "defaultText": "false",
+        "description": "是否打开引导",
+        "hasDefault": false,
+        "name": "modelValue",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "当前步骤索引",
+        "hasDefault": false,
+        "name": "current",
+        "required": false,
+        "type": "number"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "是否显示箭头",
+        "hasDefault": true,
+        "name": "showArrow",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "是否显示关闭按钮",
+        "hasDefault": true,
+        "name": "showClose",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "自定义关闭图标",
+        "hasDefault": false,
+        "name": "closeIcon",
+        "required": false,
+        "type": "string | Component"
+      },
+      {
+        "alias": null,
+        "defaultText": "bottom",
+        "description": "引导卡片相对目标元素的位置",
+        "hasDefault": true,
+        "name": "placement",
+        "required": false,
+        "type": "Placement"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "内容自定义样式",
+        "hasDefault": false,
+        "name": "contentStyle",
+        "required": false,
+        "type": "CSSProperties"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "是否启用遮罩，可传对象自定义样式与填充色",
+        "hasDefault": true,
+        "name": "mask",
+        "required": false,
+        "type": "boolean | TourMask"
+      },
+      {
+        "alias": null,
+        "defaultText": "{ offset: 6, radius: 2 }",
+        "description": "遮罩与目标元素之间的间隙",
+        "hasDefault": true,
+        "name": "gap",
+        "required": false,
+        "type": "{ offset?: number; radius?: number }"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "引导层 z-index",
+        "hasDefault": false,
+        "name": "zIndex",
+        "required": false,
+        "type": "number"
+      },
+      {
+        "alias": null,
+        "defaultText": "{ block: \"center\" }",
+        "description": "自定义 scrollIntoView 配置",
+        "hasDefault": true,
+        "name": "scrollIntoViewOptions",
+        "required": false,
+        "type": "boolean | ScrollIntoViewOptions"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "类型，影响背景色与文字颜色",
+        "hasDefault": false,
+        "name": "type",
+        "required": false,
+        "type": "'default' | 'primary'"
+      },
+      {
+        "alias": null,
+        "defaultText": "body",
+        "description": "引导内容挂载的容器",
+        "hasDefault": true,
+        "name": "appendTo",
+        "required": false,
+        "type": "string | HTMLElement"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "按 ESC 是否关闭引导",
+        "hasDefault": true,
+        "name": "closeOnPressEscape",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "使用遮罩时目标区域是否可点击",
+        "hasDefault": true,
+        "name": "targetAreaClickable",
+        "required": false,
+        "type": "boolean"
+      }
+    ],
+    "related": [
+      "EpTourStep",
+      "EpDialog"
+    ],
+    "relations": {
+      "children": [
+        "EpTourStep"
+      ],
+      "combos": [
+        "EpTour + EpTourStep"
+      ],
+      "parents": [],
+      "requiredChildren": [
+        "EpTourStep"
+      ]
+    },
+    "slots": [
+      {
+        "description": "步骤内容，通常放置 ep-tour-step",
+        "name": "default"
+      },
+      {
+        "description": "自定义步骤指示器，参数为 `{ current, total }`",
+        "name": "indicators"
+      }
+    ],
+    "slug": "tour",
+    "summary": "漫游式引导，状态与结果反馈",
+    "tag": "ep-tour",
+    "useCases": [
+      "展示漫游式引导并向用户传达状态",
+      "在操作前后提供即时反馈"
+    ],
+    "variants": [
+      {
+        "dimension": "type",
+        "values": [
+          "default",
+          "primary"
+        ],
+        "when": "通过 type 选择类型，影响背景色与文字颜色"
+      }
+    ],
+    "visual": {
+      "cssVars": [
+        "--el-color-success",
+        "--el-color-warning",
+        "--el-color-danger",
+        "--el-font-size-base"
+      ],
+      "density": "中等",
+      "shape": "行内或块级提示",
+      "slotContent": [
+        "default：步骤内容，通常放置 ep-tour-step",
+        "indicators：自定义步骤指示器，参数为 `{ current, total }`"
+      ]
+    }
+  },
+  "generatedAt": "2026-11-03T03:09:12.050Z",
+  "libraryVersion": "0.2.0",
+  "schemaVersion": 1
+}