sky-ui-kit 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,17 +1,21 @@
1
- # UsersSite Element Plus 主题预览
1
+ # sky-ui-kit 组件与样式库
2
2
 
3
- 从原项目提取主题,提供独立 Vue 3 / Element Plus 预览站及可发布的样式包。
3
+ 组件用途、数据约定、事件语义和限制见 [组件使用说明](docs/COMPONENT-GUIDE.md);完整类型与默认值见 [组件 API](docs/COMPONENT-API.md)。
4
+
5
+ 基于 Element Plus 二次封装,以原项目主题形成统一的 Vue 3 组件与样式库,并提供独立预览网站。标准层按 Element Plus 2.14.7 整理完整组件、服务与指令;项目特色层保留原有菜单、选择器、时间轴和地图组件。完整目录见 [ELEMENT-PLUS-COVERAGE.md](docs/ELEMENT-PLUS-COVERAGE.md)。出口与 API 索引覆盖不等于全部独立示例及交互状态均已完成验证。
4
6
 
5
7
  组件库分类、统一出口和兼容规则见 [COMPONENT-LIBRARY.md](docs/COMPONENT-LIBRARY.md)。基础组件使用 `Ui` 前缀,直接复用 Element Plus API;项目层保留现有组件名。两层共享项目主题。
6
8
 
7
9
  发布后反向对接以 [INTEGRATION.md](docs/INTEGRATION.md) 为准;逐页依赖见 [PAGE-INVENTORY.md](docs/PAGE-INVENTORY.md),全部原组件清单见 [COMPONENT-INVENTORY.md](docs/COMPONENT-INVENTORY.md)。完整静态扫描数据保存在 docs/project-audit.json,可用 `node scripts/audit-project.mjs` 更新。扫描覆盖不代表全部业务组件已经迁入包。
8
10
 
9
- 全部原组件调用依据见 [LEGACY-USAGE.md](docs/LEGACY-USAGE.md)。包内已导出的 10 个组件均有预览和接入示例;Element Plus 展示区提供完整演示源码。业务组件的调用片段保留原页面上下文,不能当作独立可运行示例。
11
+ 全部原组件调用依据见 [LEGACY-USAGE.md](docs/LEGACY-USAGE.md)。包内已导出的 11 个项目组件均有预览和接入示例;标准组件独立示例逐模块完善。业务组件的调用片段保留原页面上下文,不能当作独立可运行示例。
12
+
13
+ 当前实际使用清单见 [COMPONENT-USAGE.md](docs/COMPONENT-USAGE.md),逐模块替换、图标 Vite 配置、路由/地图薄适配、主题与验证方案见 [ADAPTATION.md](docs/ADAPTATION.md)。图标页面与 AI 文档共用 src/icon-setup-examples.ts。更新参考项目后在库目录运行 `node scripts/audit-project.mjs "D:\Work\01-项目code\一体化平台\webv1"` 与 `node scripts/scan-component-usage.mjs "D:\Work\01-项目code\一体化平台\webv1"`,再生成 AI 文档;这些脚本只读取原项目。
10
14
 
11
15
  ## 本地运行
12
16
 
13
17
  ```powershell
14
- cd D:\Work\01-项目code\一体化平台\webv1\element-plus-theme
18
+ cd D:\sky-ui-kit
15
19
  npm install
16
20
  npm run dev
17
21
  ```
@@ -27,7 +31,7 @@ npm run dev
27
31
  - `src/styles/site.css`:仅预览站布局,不进入 npm 样式包。
28
32
  - 不包含地图样式规则、业务数据色带、业务页面局部样式、全局 body 重置或字体二进制。HarmonyOS Sans SC 可由使用方自行加载,否则使用系统中文字体回退。
29
33
 
30
- 原项目文件不随预览站修改;当前目录是独立快照,后续主题修订在此目录进行。CSS 包使用全局 `:root` / `.theme-dark` 变量,应在 Element Plus CSS 之后加载。
34
+ 原项目文件不随预览站修改;当前目录是独立快照,后续主题修订在此目录进行。默认 style.css 使用局部主题作用域,应在 Element Plus CSS 之后加载;只有主动整站换肤时才引入 global.css。
31
35
 
32
36
  ## 项目原生组件
33
37
 
@@ -95,3 +99,9 @@ npm publish --access public
95
99
  ## 样式隔离
96
100
 
97
101
  默认 style.css 只给库组件作用域设置样式,作用域之外的原生 Element Plus 不受库 CSS 覆盖。主动整站换肤才额外导入 global.css。浮层、局部变量和默认 teleported 差异见 [CSS-THEME.md](docs/CSS-THEME.md)。开发验证页:[样式隔离验证](http://127.0.0.1:5180/isolation.html)。
102
+
103
+ ## AI 文档
104
+
105
+ 安装或升级 npm 最新正式版:`npm install sky-ui-kit@latest`。团队 AI 从 llms.txt 开始读取;模块变化见 [AI-CHANGELOG.md](docs/AI-CHANGELOG.md)。后续修改必须同步相关 AI 文档并运行 `npm run docs:ai`,开发约定见 AGENTS.md。快速开始页面与 AI 文档共用 src/quick-start-examples.ts。
106
+
107
+ 包内提供 llms.txt、llms-full.txt、components.json 和 docs/AI-GUIDE.md、docs/COMPONENT-API.md。让 AI 工具读取 node_modules/sky-ui-kit/llms.txt 开始,再按链接读取详细 API。文档不会随 npm install 自动进入 AI 上下文。项目组件 API 根据源码生成,Ui 基础组件关联 Element Plus 官方 API 和类型声明。