@melt-js/comps-art 0.0.0-stage → 2026.11.16-1
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/LICENSE +21 -0
- package/README.md +182 -2
- package/hel_dist/assets/index-Dab8WMf5.js +1 -0
- package/hel_dist/assets/index-Dab8WMf5.js.gz +0 -0
- package/hel_dist/assets/preload-helper-VtCg8-4b.js +1 -0
- package/hel_dist/assets/shared-runtime-u88-9G6Q.js +1 -0
- package/hel_dist/assets/shared-runtime-u88-9G6Q.js.gz +0 -0
- package/hel_dist/assets/style-ChCm0n5J.css +1 -0
- package/hel_dist/assets/style-ChCm0n5J.css.gz +0 -0
- package/hel_dist/assets/vendor-VheH_XYQ.js +1 -0
- package/hel_dist/assets/vendor-VheH_XYQ.js.gz +0 -0
- package/hel_dist/cdn/example-esm.html +1 -0
- package/hel_dist/cdn/example-umd.html +1 -0
- package/hel_dist/cdn/index.esm.mjs +86 -0
- package/hel_dist/cdn/index.umd.cjs +164 -0
- package/hel_dist/cdn/manifest.json +100 -0
- package/hel_dist/entry.js +164 -0
- package/hel_dist/hel-meta.json +148 -0
- package/hel_dist/index.html +42 -0
- package/hel_proxy/entry.js +164 -0
- package/hel_proxy_es/entry.js +86 -0
- package/hel_proxy_es/types/index.d.ts +162 -0
- package/package.json +119 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 SuperManTT
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,183 @@
|
|
|
1
|
-
#
|
|
1
|
+
# comps-art
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
从 [art-design-pro](https://github.com/Daymychen/art-design-pro) 抽出的 **Vue 3 + Element Plus 公共组件远程包**(hel-micro),
|
|
4
|
+
共 **61 个组件**,供 [`tpl-vue3-admin-ele-art`](../tpl-vue3-admin-ele-art) 以
|
|
5
|
+
`preloadHelLibs` 的方式预加载,业务从包根具名引入。
|
|
6
|
+
|
|
7
|
+
- hel 组名:`comps-art`(`appGroupName` / `LIB_NAME`)
|
|
8
|
+
- 本地联调端口:**20080**(全局端口表见仓库根目录 [`ports.json`](../ports.json),comps = 200xx)
|
|
9
|
+
- 构建产物:`hel_dist/`(UMD 入口 + 内联样式 + `hel-meta.json`)、`hel_proxy/`、`hel_proxy_es/`(消费方 `npm i` 后的空壳代理)
|
|
10
|
+
|
|
11
|
+
## 导出的组件
|
|
12
|
+
|
|
13
|
+
包根 `exports.import` 指向 `hel_proxy_es/entry.js`,`types` 指向自包含的 `types/index.d.ts`。
|
|
14
|
+
代理具名导出全部 61 个组件及集合、安装器、运行时注入 / 查询 API 和组名;`dtlib` / default 保留兼容。
|
|
15
|
+
代理只依赖 `hel-lib-proxy` 与组名,组件实现不会混入宿主构建。
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
// main 先共享运行时并预加载,再动态进入含此 import 的 loadApp / 业务模块。
|
|
19
|
+
import { ArtTable, ArtButtonTable, setupArtRuntime, installArtComponents } from '@melt-js/comps-art'
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
具名 import 不会自动下载实现,必须遵循 `main → preload → import('./loadApp')`。
|
|
23
|
+
模板在 `plugins/art.ts` 注入真实宿主能力,无需本地 remote 访问器。源码与独立构建配置也随包交付,排除 local / 部署环境。
|
|
24
|
+
|
|
25
|
+
| 分类 | 组件 |
|
|
26
|
+
| --- | --- |
|
|
27
|
+
| 基础 | `ArtSvgIcon` `ArtLogo` `ArtBackToTop` `ArtIconButton` |
|
|
28
|
+
| 表格 | `ArtTable` `ArtTableHeader` `ArtButtonTable` `ArtButtonMore` |
|
|
29
|
+
| 表单 | `ArtForm` `ArtSearchBar` `ArtDragVerify` `ArtWangEditor` `ArtExcelExport` `ArtExcelImport` |
|
|
30
|
+
| 图表 | `ArtBarChart` `ArtHBarChart` `ArtLineChart` `ArtDualBarCompareChart` `ArtKLineChart` `ArtRadarChart` `ArtRingChart` `ArtScatterChart` `ArtMapChart` |
|
|
31
|
+
| 卡片 | `ArtStatsCard` `ArtProgressCard` `ArtImageCard` `ArtDataListCard` `ArtTimelineListCard` `ArtBarChartCard` `ArtLineChartCard` `ArtDonutChartCard` |
|
|
32
|
+
| 布局 | `ArtHeaderBar` `ArtSidebarMenu` `ArtHorizontalMenu` `ArtMixedMenu` `ArtBreadcrumb` `ArtPageContent` `ArtWorkTab` `ArtGlobalComponent` `ArtGlobalSearch` `ArtNotification` `ArtFastEnter` `ArtSettingsPanel` `ArtScreenLock` `ArtChatWindow` `ArtFireworksEffect` |
|
|
33
|
+
| 其它 | `ArtWatermark` `ArtMenuRight` `ArtCountTo` `ArtTextScroll` `ArtFestivalTextScroll` `ArtCutterImg` `ArtVideoPlayer` `ArtBasicBanner` `ArtCardBanner` |
|
|
34
|
+
| 视图级 | `ArtException` `ArtResultPage` `LoginLeftView` `AuthTopBar` `CommentWidget` `ThemeSvg` |
|
|
35
|
+
|
|
36
|
+
完整清单(按名字排序)见 `src/components/index.ts`(由 `scripts/gen-components-index.mjs` 生成)。
|
|
37
|
+
|
|
38
|
+
## 宿主接入约定
|
|
39
|
+
|
|
40
|
+
art-design-pro 的组件**不是纯 UI**:表格依赖 `useTable` 的列配置、菜单依赖 menu store、
|
|
41
|
+
顶栏依赖 setting store、图表依赖宿主注册好的 echarts、文案走宿主的 vue-i18n。
|
|
42
|
+
组件包不直接 import 这些宿主模块,而是由宿主在 `preFetchLib` 完成后注入。
|
|
43
|
+
八步缺一不可:
|
|
44
|
+
|
|
45
|
+
1. **vue**:`bindVueRuntime({ Vue })`(hel-micro)把宿主 vue 挂到 `window.Vue`;
|
|
46
|
+
2. **element-plus / vue-router / pinia / vue-i18n**:宿主把四个模块挂到
|
|
47
|
+
`window.ElementPlus` / `window.VueRouter` / `window.Pinia` / `window.VueI18n`。
|
|
48
|
+
这四个必须共用同一份实例:`vue-router` / `pinia` / `vue-i18n` 依赖 provide/inject 的 Symbol,
|
|
49
|
+
两个包各打包一份会让 `useRouter()` / `useI18n()` / store 全部失效;
|
|
50
|
+
3. **element-plus 组件注册**:宿主 `app.use(ElementPlus)` 全量注册(组件里的 `<ElForm />` 等标签靠它解析);
|
|
51
|
+
4. **业务能力**:`lib.setupArtRuntime({ stores, hooks, utils, config, plugins, env })`(见下节);
|
|
52
|
+
5. **全局注册**:`lib.installArtComponents(app)`,一次注册 61 个组件,
|
|
53
|
+
视图里保持 `<ArtTable />` `<ArtHeaderBar />` 写法不变;
|
|
54
|
+
6. **样式**:element-plus 样式由宿主全量引入(`element-plus/dist/index.css`),
|
|
55
|
+
组件包自己的 Tailwind 产物 + art 基础类随 `hel_dist` 一起注入;
|
|
56
|
+
7. **不依赖 Tailwind 扫描**:组件包的 `src/styles/core/tailwind.css` 只引入
|
|
57
|
+
`tailwindcss/theme.css` + `utilities.css`(**不含 preflight**,preflight 是页面级 reset,由宿主统一注入);
|
|
58
|
+
8. **启动顺序**:远程包必须在 `app.mount()` 之前加载并完成注入。
|
|
59
|
+
|
|
60
|
+
### setupArtRuntime 能力清单
|
|
61
|
+
|
|
62
|
+
| 分组 | 注入项 | 组件里的来源 |
|
|
63
|
+
| --- | --- | --- |
|
|
64
|
+
| `stores` | `useSettingStore` `useUserStore` `useMenuStore` `useWorktabStore` `useTableStore` | `@/store/modules/*` |
|
|
65
|
+
| `hooks` | `useAuth` `useAutoLayoutHeight` `useLayoutHeight` `useCeremony` `useChartOps` `useChartComponent` `useCommon` `useFastEnter` `useHeaderBar` `useTableHeight` `useTheme` | `@/hooks/core/*` |
|
|
66
|
+
| `utils` | `formatMenuTitle` `handleMenuJump` `isIframe` `mittBus` `request` | `@/utils/{router,navigation,sys,http}` |
|
|
67
|
+
| `config` | `AppConfig` `SETTING_DEFAULT_CONFIG` `headerBarConfig` `getEnabledGlobalComponents` `StorageConfig` | `@/config/*`、`@/utils/storage/storage-config` |
|
|
68
|
+
| `plugins` | `echarts` `graphic` | `@/plugins/echarts` |
|
|
69
|
+
| `env` | `VITE_API_URL` `VITE_OPEN_ROUTE_INFO` `VITE_LOCK_ENCRYPT_KEY` | 宿主 `import.meta.env` |
|
|
70
|
+
|
|
71
|
+
实现方式见 `src/runtime/index.ts` + `src/runtime/shims/*`:组件源码保持 art-design-pro 原来的
|
|
72
|
+
`import { useSettingStore } from '@/store/modules/setting'` 写法,Vite 的 alias 把这些**宿主模块路径**
|
|
73
|
+
指向 `src/runtime/shims/` 下的同名代理(一个函数一层转发),因此:
|
|
74
|
+
|
|
75
|
+
- 组件源码与上游几乎逐字一致,升级上游时 diff 很小;
|
|
76
|
+
- 真正实现只有宿主一份,不存在两份 store / 两份配置 / 两份 mitt 事件总线;
|
|
77
|
+
- 值类型导出(`AppConfig`、`mittBus`、`echarts`、`request`)用 `Proxy` 惰性转发 —— bundle 加载时
|
|
78
|
+
宿主还没注入,直接 `export const` 会拿到默认值。
|
|
79
|
+
|
|
80
|
+
`useChartOps()` 是唯一在**模块加载期**就会被调用的注入项(图表组件 `withDefaults` 的默认值会被编译到
|
|
81
|
+
props 定义里),所以它在未注入时回退到 `src/runtime/chart-ops.ts` 的本地实现,注入后走宿主那一份。
|
|
82
|
+
|
|
83
|
+
## 独立开发 / 预览
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
# 独立调试页(20080):vue / element-plus / vue-router / pinia / vue-i18n 由 index.html 的 CDN 提供
|
|
87
|
+
pnpm dev
|
|
88
|
+
|
|
89
|
+
# 构建(产物地址指向 unpkg,可直接发布)
|
|
90
|
+
pnpm build
|
|
91
|
+
|
|
92
|
+
# 构建成本地地址(HEL_APP_HOME_PAGE=http://localhost:20080),配合 pnpm preview 验证产物
|
|
93
|
+
pnpm build:local
|
|
94
|
+
pnpm preview
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
> 独立调试页只演示不依赖宿主状态的组件(图标、数字滚动、滑块验证、卡片横幅);
|
|
98
|
+
> 依赖 store / hooks / 配置 的组件请通过本体模板 `tpl-vue3-admin-ele-art` 查看。
|
|
99
|
+
|
|
100
|
+
### 构建期压缩与适度混淆
|
|
101
|
+
|
|
102
|
+
`pnpm build` 默认先压缩,再使用 `vite-plugin-bundle-obfuscator` 适度混淆,与仓库内其它参与统一构建配置的 comps 保持一致。参数统一维护于 `@melt-js/libs-core/scripts/comps-obfuscator-options.cjs`;混淆会增加构建耗时和产物体积。
|
|
103
|
+
|
|
104
|
+
体积相关的几个开关:
|
|
105
|
+
|
|
106
|
+
- `build.minify: 'terser'`:比 esbuild 再小几个百分点,`compress.passes: 2`;
|
|
107
|
+
- `build.sourcemap: false`:不发布 source map(包体更小,也不把源码带出去);
|
|
108
|
+
- `esbuild.legalComments: 'none'` + terser `format.comments: false`:`/*!`、`@license`、`@preserve` 全部清掉;
|
|
109
|
+
- `xlsx` 别名到官方 `xlsx/dist/xlsx.mini.min.js`(861KB → 245KB,Excel 组件只做 xlsx/csv 读写);
|
|
110
|
+
- 组件里引用的图片在 `assetsInlineLimit` 内内联进 JS,避免 hel 只加载 js 时丢资源。
|
|
111
|
+
|
|
112
|
+
仅在排查产物问题时关闭混淆(仍不生成 sourcemap):
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
HEL_OBFUSCATE=0 pnpm build # 临时关闭混淆;默认构建无需设置该变量
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
混淆参数(与其它 comps 包同一套):`renameGlobals: false`(`window.Vue` / `window.ElementPlus` 等 UMD 约定不能改)、
|
|
119
|
+
`renameProperties: false`(`lib.ArtTable` / `lib.setupArtRuntime` / `lib.installArtComponents` 等对外属性名不能改),
|
|
120
|
+
不开控制流平坦化 / 死代码注入 / 自保护 / 调试保护。
|
|
121
|
+
|
|
122
|
+
> 仓库内其它 `comps-*` 包:`comps-vue3-ele` / `comps-vue3-antd` / `comps-pure` 用 Vite 混淆插件,
|
|
123
|
+
> `comps-vue2` / `comps-vue2-ele` / `comps-vue2-antd` / `comps-vue3` 用 `webpack-obfuscator`,
|
|
124
|
+
> `comps-bag-shop` / `comps-bag-sys` 暂不参与本次统一调整,保留原配置。
|
|
125
|
+
|
|
126
|
+
## 目录结构
|
|
127
|
+
|
|
128
|
+
```
|
|
129
|
+
src/
|
|
130
|
+
components/ 从 art-design-pro src/components 原样复制(core + business)
|
|
131
|
+
index.ts 对外导出清单(生成)
|
|
132
|
+
runtime/
|
|
133
|
+
index.ts setupArtRuntime / getArtRuntime / getArtEnv
|
|
134
|
+
chart-ops.ts useChartOps 的模块加载期兜底实现
|
|
135
|
+
shims/ 宿主模块代理(store / hook / utils / config / plugins)
|
|
136
|
+
types/ enums/ 从上游复制的纯类型与枚举
|
|
137
|
+
utils/
|
|
138
|
+
ui/ colors / animation / emojo(从上游复制,依赖走 shim)
|
|
139
|
+
form/responsive.ts 表单响应式栅格
|
|
140
|
+
constants/ WEB_LINKS
|
|
141
|
+
index.ts StorageConfig(宿主注入)
|
|
142
|
+
locales/index.ts languageOptions(纯数据)
|
|
143
|
+
locales 之外的 i18n 由宿主提供(useI18n / $t)
|
|
144
|
+
mock/ 组件内部用到的静态数据(chinaMap.json、commentDetail)
|
|
145
|
+
assets/images/ 组件内部引用的图片(logo / 头像 / 节日素材 / 插画)
|
|
146
|
+
styles/
|
|
147
|
+
core/tailwind.css Tailwind 入口(无 preflight)+ art 主题变量
|
|
148
|
+
core/app.scss art 全局基础类(art-card / art-table-card / art-full-height ...)
|
|
149
|
+
core/el-light.scss 给 SCSS 用的 EP 主题变量(与宿主一致)
|
|
150
|
+
core/mixin.scss ellipsis 等 mixin
|
|
151
|
+
entrance/ libProperties(对外 lib)/ libTypes(rollup 代理入口)
|
|
152
|
+
install.ts installArtComponents:全局注册 61 个组件
|
|
153
|
+
main.ts / loadApp.ts 远程入口 / 独立调试页挂载
|
|
154
|
+
playground/ 独立调试页
|
|
155
|
+
scripts/
|
|
156
|
+
gen-components-index.mjs 扫描 components 目录生成导出清单
|
|
157
|
+
check.mjs / meta.mjs / prepublishOnly.mjs
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
TDZ 检查通过 `pnpm run check:tdz` 调用 `@melt-js/libs-core` 提供的 `hel-check-tdz`,不再保留本地转发脚本。
|
|
161
|
+
|
|
162
|
+
## 与上游源码的差异
|
|
163
|
+
|
|
164
|
+
- 组件源码保持原样,只改了三处 `import.meta.env`:`VITE_API_URL`(wangEditor 上传地址)、
|
|
165
|
+
`VITE_OPEN_ROUTE_INFO`(页面内容区路由信息)、`VITE_LOCK_ENCRYPT_KEY`(锁屏加密)改为
|
|
166
|
+
`getArtEnv()`,由宿主注入;
|
|
167
|
+
- 宿主模块(store / hooks / utils / config / plugins)通过 `src/runtime/shims` 代理,不打包第二份;
|
|
168
|
+
- `@/utils/ui` 的 `colors.ts` / `animation.ts` / `emojo.ts` 复制进包内(`animation.ts` 里对 hooks
|
|
169
|
+
的调用仍走 shim);
|
|
170
|
+
- Tailwind 入口去掉 preflight(页面级 reset 由宿主统一注入),并显式 `@source` 扫描组件目录;
|
|
171
|
+
- 组件里引用的图片用 `assetsInlineLimit: 1MB` 直接内联进 JS,避免 hel 只加载 js 时丢资源;
|
|
172
|
+
- 三个较重依赖(`@wangeditor/*` ≈ 800KB、`xgplayer` ≈ 283KB、`xlsx` 已换 mini 构建)随包打包,
|
|
173
|
+
因此默认产物 UMD 约 2.27MB(gzip ≈ 777KB);若还要更小,可以裁掉 `ArtWangEditor` / `ArtVideoPlayer`
|
|
174
|
+
(见 `src/components/index.ts`),或把它们的依赖改成运行时按需加载;
|
|
175
|
+
只需要精简版功能时可以在 `src/components/index.ts` 里裁掉 `ArtExcelExport` / `ArtExcelImport` /
|
|
176
|
+
`ArtWangEditor` / `ArtVideoPlayer`,体积会明显下降。
|
|
177
|
+
|
|
178
|
+
## 已知限制
|
|
179
|
+
|
|
180
|
+
- `echarts` 由宿主提供(`plugins.echarts`),组件包不注册图表类型:宿主升级 echarts 时
|
|
181
|
+
请同步检查 `src/plugins/echarts.ts` 的 `echarts.use([...])` 列表;
|
|
182
|
+
- 组件内部的图标统一走 `@iconify/vue`(随包打包),在线图标仍需要网络;
|
|
183
|
+
- 设置面板「复制配置」输出的 `SETTING_DEFAULT_CONFIG` 来自宿主,新增配置项请同步宿主 `src/config/setting.ts`。
|