@epxing/dashboard 5.3.0-beta.3 → 5.3.0-beta.4

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.
Files changed (2) hide show
  1. package/API.md +80 -80
  2. package/package.json +5 -5
package/API.md CHANGED
@@ -1,80 +1,80 @@
1
- # @epxing/dashboard API
2
-
3
- 看板根容器、分组标签、标题、内容区和挂件组件。
4
-
5
- 本页对应包版本 `5.3.0-beta.3`。导出名、子路径和签名从当前源码、package.json 与类型声明生成。
6
-
7
- ## 安装与使用
8
-
9
-
10
- ```sh
11
- pnpm add @epxing/dashboard@5.3.0-beta.2
12
- ```
13
-
14
-
15
- ```js
16
- import DashboardPlugin, { Dashboard, DashboardWidget } from '@epxing/dashboard'
17
-
18
- // app 已初始化 core 和基础组件
19
- app.use(DashboardPlugin)
20
- app.component('ProductDashboard', Dashboard)
21
- ```
22
-
23
- ## 接入约定
24
-
25
- default 与具名 Dashboard 是同一根组件；其 install 会注册配套组件、预览和网格兼容组件。布局、请求与保存依赖平台运行环境。Tabs/Title/Div/Widget 稳定子路径均为 default 组件导出。
26
-
27
- 本版 JS 入口自动加载本包聚合样式，根导入和稳定子路径均无需手动 import style.css；保留显式样式入口以兼容旧代码。样式按包加载，产品覆盖样式放在框架导入之后。
28
-
29
- ## 根入口完整导出
30
-
31
- | 导出名 | 形态 | 用途 | 参数 / 配置 / 事件 |
32
- | --- | --- | --- | --- |
33
- | `default` | 默认导出 | Dashboard 组件，同时具有 install，可用作组件或 app.use 插件。 | [详细参考](../../docs/revision/dashboard/Dashboard.md) |
34
- | `Dashboard` | Vue 组件 | 看板根容器，组织布局、挂件和看板运行状态。 | [详细参考](../../docs/revision/dashboard/Dashboard.md) |
35
- | `DashboardTabs` | Vue 组件 | 看板标签页容器，按标签组织看板内容。 | [详细参考](../../docs/revision/dashboard/Tabs.md) |
36
- | `DashboardTitle` | Vue 组件 | 看板标题组件，展示标题和相关样式。 | [详细参考](../../docs/revision/dashboard/Title.md) |
37
- | `DashboardDiv` | Vue 组件 | 看板内容容器，承载嵌套内容和布局。 | [详细参考](../../docs/revision/dashboard/Div.md) |
38
- | `DashboardWidget` | Vue 组件 | 看板挂件容器，负责挂件内容与布局交互。 | [详细参考](../../docs/revision/dashboard/Widget.md) |
39
-
40
- ## 函数、类与工具对象
41
-
42
- 签名中的 any 表示现有声明未进一步限定结构；源代码方法签名保留默认参数。异步结果与泛型以声明为准。
43
-
44
- ## 稳定子路径
45
-
46
- 下表按实际 package.json 的公开入口列出。default 使用默认导入，其他名称使用具名导入；类型接口用 import type。
47
-
48
- | 导入路径 | 完整导出名 | 用途 / 详细说明 |
49
- | --- | --- | --- |
50
- | `@epxing/dashboard/tabs` | `default` | 看板标签页容器，按标签组织看板内容。 [详细参考](../../docs/revision/dashboard/Tabs.md) |
51
- | `@epxing/dashboard/title` | `default` | 看板标题组件，展示标题和相关样式。 [详细参考](../../docs/revision/dashboard/Title.md) |
52
- | `@epxing/dashboard/div` | `default` | 看板内容容器，承载嵌套内容和布局。 [详细参考](../../docs/revision/dashboard/Div.md) |
53
- | `@epxing/dashboard/widget` | `default` | 看板挂件容器，负责挂件内容与布局交互。 [详细参考](../../docs/revision/dashboard/Widget.md) |
54
- | `@epxing/dashboard/style.css` | 可选的显式样式入口 | JS 入口自动加载本包样式；保留此路径以兼容旧代码。 |
55
-
56
- ## 源码兼容与其他入口
57
-
58
- /src 路径保留给已有产品和源码级扩展，可能包含平台内部实现；新产品优先采用上方根导出与稳定子路径。通配符表示按实际文件名匹配，不代表所有源码都属于根入口。
59
-
60
- | 公开路径模式 | 实际目标 |
61
- | --- | --- |
62
- | `@epxing/dashboard/src` | `./dist/src/index.js` |
63
- | `@epxing/dashboard/src/*.css` | `./src/*.css` |
64
- | `@epxing/dashboard/src/*.scss` | `./src/*.scss` |
65
- | `@epxing/dashboard/src/*.png` | `./src/*.png` |
66
- | `@epxing/dashboard/src/*.svg` | `./src/*.svg` |
67
- | `@epxing/dashboard/src/*.jpg` | `./src/*.jpg` |
68
- | `@epxing/dashboard/src/*.gif` | `./src/*.gif` |
69
- | `@epxing/dashboard/src/*.woff` | `./src/*.woff` |
70
- | `@epxing/dashboard/src/*.woff2` | `./src/*.woff2` |
71
- | `@epxing/dashboard/src/*.ttf` | `./src/*.ttf` |
72
- | `@epxing/dashboard/src/*.js` | `./dist/src/*.js` |
73
- | `@epxing/dashboard/src/*.jsx` | `./dist/src/*.js` |
74
- | `@epxing/dashboard/src/*.vue` | `./dist/src/*.js` |
75
- | `@epxing/dashboard/src/*` | `./dist/src/*.js` |
76
- | `@epxing/dashboard/package.json` | `./package.json` |
77
-
78
- ## 文档维护
79
-
80
- 本页由 build/gen-package-api-docs.mjs 生成。修改公开入口并更新构建产物和类型声明后，在框架根运行 `pnpm docs:api`；`pnpm docs:api:check` 检查清单、类型、包内文档与站点镜像是否同步，同时验证页面编译和文档链接。用途和示例维护在 build/package-api-notes.mjs，组件和源码方法的详细参考位于 docs/revision。
1
+ # @epxing/dashboard API
2
+
3
+ 看板根容器、分组标签、标题、内容区和挂件组件。
4
+
5
+ 本页对应包版本 `5.3.0-beta.4`。导出名、子路径和签名从当前源码、package.json 与类型声明生成。
6
+
7
+ ## 安装与使用
8
+
9
+
10
+ ```sh
11
+ pnpm add @epxing/dashboard@5.3.0-beta.2
12
+ ```
13
+
14
+
15
+ ```js
16
+ import DashboardPlugin, { Dashboard, DashboardWidget } from '@epxing/dashboard'
17
+
18
+ // app 已初始化 core 和基础组件
19
+ app.use(DashboardPlugin)
20
+ app.component('ProductDashboard', Dashboard)
21
+ ```
22
+
23
+ ## 接入约定
24
+
25
+ default 与具名 Dashboard 是同一根组件；其 install 会注册配套组件、预览和网格兼容组件。布局、请求与保存依赖平台运行环境。Tabs/Title/Div/Widget 稳定子路径均为 default 组件导出。
26
+
27
+ 本版 JS 入口自动加载本包聚合样式，根导入和稳定子路径均无需手动 import style.css；保留显式样式入口以兼容旧代码。样式按包加载，产品覆盖样式放在框架导入之后。
28
+
29
+ ## 根入口完整导出
30
+
31
+ | 导出名 | 形态 | 用途 | 参数 / 配置 / 事件 |
32
+ | --- | --- | --- | --- |
33
+ | `default` | 默认导出 | Dashboard 组件，同时具有 install，可用作组件或 app.use 插件。 | [详细参考](../../docs/revision/dashboard/Dashboard.md) |
34
+ | `Dashboard` | Vue 组件 | 看板根容器，组织布局、挂件和看板运行状态。 | [详细参考](../../docs/revision/dashboard/Dashboard.md) |
35
+ | `DashboardTabs` | Vue 组件 | 看板标签页容器，按标签组织看板内容。 | [详细参考](../../docs/revision/dashboard/Tabs.md) |
36
+ | `DashboardTitle` | Vue 组件 | 看板标题组件，展示标题和相关样式。 | [详细参考](../../docs/revision/dashboard/Title.md) |
37
+ | `DashboardDiv` | Vue 组件 | 看板内容容器，承载嵌套内容和布局。 | [详细参考](../../docs/revision/dashboard/Div.md) |
38
+ | `DashboardWidget` | Vue 组件 | 看板挂件容器，负责挂件内容与布局交互。 | [详细参考](../../docs/revision/dashboard/Widget.md) |
39
+
40
+ ## 函数、类与工具对象
41
+
42
+ 签名中的 any 表示现有声明未进一步限定结构；源代码方法签名保留默认参数。异步结果与泛型以声明为准。
43
+
44
+ ## 稳定子路径
45
+
46
+ 下表按实际 package.json 的公开入口列出。default 使用默认导入，其他名称使用具名导入；类型接口用 import type。
47
+
48
+ | 导入路径 | 完整导出名 | 用途 / 详细说明 |
49
+ | --- | --- | --- |
50
+ | `@epxing/dashboard/tabs` | `default` | 看板标签页容器，按标签组织看板内容。 [详细参考](../../docs/revision/dashboard/Tabs.md) |
51
+ | `@epxing/dashboard/title` | `default` | 看板标题组件，展示标题和相关样式。 [详细参考](../../docs/revision/dashboard/Title.md) |
52
+ | `@epxing/dashboard/div` | `default` | 看板内容容器，承载嵌套内容和布局。 [详细参考](../../docs/revision/dashboard/Div.md) |
53
+ | `@epxing/dashboard/widget` | `default` | 看板挂件容器，负责挂件内容与布局交互。 [详细参考](../../docs/revision/dashboard/Widget.md) |
54
+ | `@epxing/dashboard/style.css` | 可选的显式样式入口 | JS 入口自动加载本包样式；保留此路径以兼容旧代码。 |
55
+
56
+ ## 源码兼容与其他入口
57
+
58
+ /src 路径保留给已有产品和源码级扩展，可能包含平台内部实现；新产品优先采用上方根导出与稳定子路径。通配符表示按实际文件名匹配，不代表所有源码都属于根入口。
59
+
60
+ | 公开路径模式 | 实际目标 |
61
+ | --- | --- |
62
+ | `@epxing/dashboard/src` | `./dist/src/index.js` |
63
+ | `@epxing/dashboard/src/*.css` | `./src/*.css` |
64
+ | `@epxing/dashboard/src/*.scss` | `./src/*.scss` |
65
+ | `@epxing/dashboard/src/*.png` | `./src/*.png` |
66
+ | `@epxing/dashboard/src/*.svg` | `./src/*.svg` |
67
+ | `@epxing/dashboard/src/*.jpg` | `./src/*.jpg` |
68
+ | `@epxing/dashboard/src/*.gif` | `./src/*.gif` |
69
+ | `@epxing/dashboard/src/*.woff` | `./src/*.woff` |
70
+ | `@epxing/dashboard/src/*.woff2` | `./src/*.woff2` |
71
+ | `@epxing/dashboard/src/*.ttf` | `./src/*.ttf` |
72
+ | `@epxing/dashboard/src/*.js` | `./dist/src/*.js` |
73
+ | `@epxing/dashboard/src/*.jsx` | `./dist/src/*.js` |
74
+ | `@epxing/dashboard/src/*.vue` | `./dist/src/*.js` |
75
+ | `@epxing/dashboard/src/*` | `./dist/src/*.js` |
76
+ | `@epxing/dashboard/package.json` | `./package.json` |
77
+
78
+ ## 文档维护
79
+
80
+ 本页由 build/gen-package-api-docs.mjs 生成。修改公开入口并更新构建产物和类型声明后，在框架根运行 `pnpm docs:api`；`pnpm docs:api:check` 检查清单、类型、包内文档与站点镜像是否同步，同时验证页面编译和文档链接。用途和示例维护在 build/package-api-notes.mjs，组件和源码方法的详细参考位于 docs/revision。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epxing/dashboard",
3
- "version": "5.3.0-beta.3",
3
+ "version": "5.3.0-beta.4",
4
4
  "description": "看板运行态渲染",
5
5
  "type": "module",
6
6
  "main": "./dist/src/index.js",
@@ -56,10 +56,10 @@
56
56
  ],
57
57
  "dependencies": {
58
58
  "gridstack": "13.3.0",
59
- "@epxing/components": "^5.3.0-beta.3",
60
- "@epxing/core": "^5.3.0-beta.3",
61
- "@epxing/theme": "^5.3.0-beta.3",
62
- "@epxing/utils": "^5.3.0-beta.3"
59
+ "@epxing/components": "^5.3.0-beta.4",
60
+ "@epxing/theme": "^5.3.0-beta.4",
61
+ "@epxing/core": "^5.3.0-beta.4",
62
+ "@epxing/utils": "^5.3.0-beta.4"
63
63
  },
64
64
  "peerDependencies": {
65
65
  "vue": "3.5.39",