Compare commits

..

No commits in common. "master" and "v1.8.0-beta.16" have entirely different histories.

326 changed files with 8589 additions and 20827 deletions

View File

@ -17,14 +17,12 @@ jobs:
- name: Install pnpm
uses: pnpm/action-setup@v4
with:
version: 11.21.0
- name: Set node version to 22
uses: actions/setup-node@v4
with:
node-version: 22
cache: "pnpm"
cache: 'pnpm'
- run: pnpm bootstrap

View File

@ -1 +1 @@
npm run coverage
npm run test

View File

@ -7,11 +7,7 @@
TMagic Editor 是魔方平台的可视化编辑器核心库,提供拖拽式组件编辑、配置面板、预览发布等能力。支持 Vue 和 React 双框架 Runtime采用 pnpm monorepo 管理多个核心包。开源项目,同时支持内部业务定制。
编辑器本体使用 Vue 3UI 通过 `@tmagic/design` + adapter 接入 Element Plus 或 TDesign Vue Next。
**技术栈:** Vue 3, TypeScript, Vite, rolldown, vitest, VitePress, Element Plus / TDesign Vue Next
**环境:** Node.js `^20.19.0 || >=22.12.0`pnpm `11.21.0`
**当前版本:** `1.8.0-beta.25`
**技术栈:** Vue 3, Element Plus, TypeScript, Vite, vitest, VitePress
**主仓库:** `https://git.woa.com/vft-magic/tmagic-editor.git`
**开源仓库:** `https://github.com/Tencent/tmagic-editor.git`
@ -19,10 +15,10 @@ TMagic Editor 是魔方平台的可视化编辑器核心库,提供拖拽式组
关键目录:
- `packages/` — 核心 npm 包(`editor``form``stage``core``cli``data-source``schema``form-schema``design``utils``dep``table``element-plus-adapter``tdesign-vue-next-adapter`
- `runtime/` — Vue/React Runtime,以及 `vue-runtime-help``react-runtime-help``tmagic-form`
- `vue-components/` — Vue 业务组件封装
- `react-components/` — React 业务组件封装
- `packages/` — 核心编辑器包
- `runtime/` — Vue/React Runtime 实现
- `vue-components/` — Vue 组件封装
- `react-components/` — React 组件封装
- `playground/` — 演示 playground
- `docs/` — VitePress 文档
- `scripts/` — 构建和发布脚本
@ -30,12 +26,9 @@ TMagic Editor 是魔方平台的可视化编辑器核心库,提供拖拽式组
## 开发约定
**分支策略(内部约定):** 日常开发走 `dev`test/prod 对应 `master`。开源文档站与 playground 从 `dev` 发布。
**提交规范:** commitlint`@commitlint/config-conventional`+ husky格式 `type(scope): subject`,详见 `CONTRIBUTING.md`
**测试:** 新增或修改的代码必须补充单元测试,覆盖率不低于 85%lines`pnpm coverage` 执行两层硬门禁:
1. 全仓 lines ≥ 85%vitest `coverage.thresholds`
2. 工作区相对 HEAD 的 `packages/*/src` 变更逐文件 lines ≥ 85%(不含 design / UI adapter未测新文件按 0% 计)
pre-commit 跑 lint-staged 与 `pnpm check:type`pre-push 跑 `pnpm coverage`
**分支策略:** dev=dev, test/prod=master
**提交规范:** commitlint + husky`type: 描述`
**测试覆盖率:** 新增或修改的代码必须补充单元测试,覆盖率不低于 85%
**禁止事项:**
@ -50,12 +43,14 @@ pre-commit 跑 lint-staged 与 `pnpm check:type`pre-push 跑 `pnpm coverage`
pnpm pg:react # 启动 React playground
pnpm build # 完整构建DTS + 包)
pnpm test # 运行测试
pnpm coverage # 运行测试、生成覆盖率,并执行 85% 门禁
pnpm check:type # TypeScript 类型检查
pnpm lint-fix # ESLint 修复
pnpm docs:dev # 启动文档开发
pnpm release # 发版
## 当前状态
**当前里程碑:** {待人工填写}
## 深入阅读
| 文档 | 说明 |

View File

@ -1,128 +1,3 @@
# [1.8.0-beta.27](https://github.com/Tencent/tmagic-editor/compare/v1.8.0-beta.26...v1.8.0-beta.27) (2026-09-04)
### Bug Fixes
* **editor,form:** 合并宿主 FORM_CONTEXT 并修复 formState mForm 自引用 ([b0d43dc](https://github.com/Tencent/tmagic-editor/commit/b0d43dc2775a2241499de9ab1b165a5ad3febcf3))
* **editor:** 修复 eventsService resetState 响应式失效并在编辑器重置时清空 ([959c032](https://github.com/Tencent/tmagic-editor/commit/959c0322b6885ee00c38bc830f58841ccbb42a40))
* **form:** 避免 Select init 请求失败或路径缺失时抛出未处理异常 ([d1cb8c3](https://github.com/Tencent/tmagic-editor/commit/d1cb8c3853ac724b424dbe8de2d2a63bf6302324))
### Features
* **data-source:** 新增数据源 mounted 生命周期 ([092bc29](https://github.com/Tencent/tmagic-editor/commit/092bc2914d444c9527140a204ab8bc2776d31a1b))
# [1.8.0-beta.26](https://github.com/Tencent/tmagic-editor/compare/v1.8.0-beta.25...v1.8.0-beta.26) (2026-09-01)
### Bug Fixes
* **editor:** inject eventBus 时提供 null 默认值 ([58f2a94](https://github.com/Tencent/tmagic-editor/commit/58f2a943b866a836817b12b93194eb0e13f82d16))
* **editor:** 避免 defaultSelected 早于 root 就绪时 select 抛出未处理错误 ([08b610a](https://github.com/Tencent/tmagic-editor/commit/08b610a4f2de9c6c433ec792fc46039e6f57e7b0))
* **form:** 避免 Tooltip 无合法触发器时报 ElOnlyChild ([90e4bec](https://github.com/Tencent/tmagic-editor/commit/90e4bec70b25194446b6b7c8453ac7c9dc32bff3))
### Features
* **editor:** 统一列表字段添加按钮样式并支持新增后自动滚动 ([02eeb2e](https://github.com/Tencent/tmagic-editor/commit/02eeb2e87f78f59d18baaf471704d3f574c5556c))
* **form:** 容器透传 labelPosition ([c34ed6a](https://github.com/Tencent/tmagic-editor/commit/c34ed6aafc0542ea12ba7d32e0130eb227da1f81))
* **form:** 新增无渲染校验入口,支持 Node/CI 环境执行表单校验 ([93dc0d2](https://github.com/Tencent/tmagic-editor/commit/93dc0d2187046d5d5da9409cc67e21afd01a0abe))
* **form:** 用 FormContext 与 provide/inject 替代 extendState 钩子 ([a7999f5](https://github.com/Tencent/tmagic-editor/commit/a7999f50d542e3c369db4a1f6f42339ec0056e04))
* **form:** 统一字段值 effect 机制并将 nested 重命名为 innerConfig ([f2ee7ae](https://github.com/Tencent/tmagic-editor/commit/f2ee7ae7b522d0fe78f354de531d6cbd6116ab4b))
# [1.8.0-beta.25](https://github.com/Tencent/tmagic-editor/compare/v1.8.0-beta.24...v1.8.0-beta.25) (2026-08-13)
### Bug Fixes
* **editor:** 统一数据源字段路径解析并优化 typeMatch 校验 ([05fbdb1](https://github.com/Tencent/tmagic-editor/commit/05fbdb17b53e688f562202a32cdb748afae65347))
# [1.8.0-beta.24](https://github.com/Tencent/tmagic-editor/compare/v1.8.0-beta.23...v1.8.0-beta.24) (2026-08-10)
### Bug Fixes
* **editor:** 修复连续 add 与批量插入时节点顺序错乱 ([a7198e2](https://github.com/Tencent/tmagic-editor/commit/a7198e273123484822987c4d1838b2cc4689fb86))
* **editor:** 移除 removeStyleDisplayConfig 并取消属性 tab 懒加载 ([8550e6f](https://github.com/Tencent/tmagic-editor/commit/8550e6f854e1d0d0267b7064836f845aa2b004f9))
* **editor:** 节点未注册时回退使用 formValue 加载事件与动作选项 ([53c4763](https://github.com/Tencent/tmagic-editor/commit/53c4763a596abfb355061db651dc56843e75cacc))
### Features
* **form,editor:** 静默校验模式下跳过叶子字段渲染以提升性能 ([44cd3d4](https://github.com/Tencent/tmagic-editor/commit/44cd3d480f5f3b76bb6ba6d2bc4b2632f6a5e957))
# [1.8.0-beta.23](https://github.com/Tencent/tmagic-editor/compare/v1.8.0-beta.22...v1.8.0-beta.23) (2026-08-06)
### Bug Fixes
* **editor:** abort 时保留常驻依赖收集 worker避免反复重建 ([efb637e](https://github.com/Tencent/tmagic-editor/commit/efb637e72e19c4c1ce5eb07a4c6dd9e6828778d1))
* **form:** 优化可选项校验建议文案并导出供 editor 复用 ([0d1a17d](https://github.com/Tencent/tmagic-editor/commit/0d1a17dce3b8b912238f822ad7d67c1992af53f4))
* **stage:** 修复切换页面后 mask 滚动重置与 scrollIntoView 失效 ([cf007f9](https://github.com/Tencent/tmagic-editor/commit/cf007f9082043589ce94fb3dd1c11dbf96ca0e1d))
# [1.8.0-beta.22](https://github.com/Tencent/tmagic-editor/compare/v1.8.0-beta.21...v1.8.0-beta.22) (2026-08-04)
### Bug Fixes
* **editor:** 优化组件列表与图层面板搜索过滤 ([7777c20](https://github.com/Tencent/tmagic-editor/commit/7777c205b95429c80f7762510d46c6d98b5f73c5))
* **editor:** 修复 StyleSetter Box/Position 输入框无法正确显示 model 值 ([af157fc](https://github.com/Tencent/tmagic-editor/commit/af157fcda96da817d1507cb93a564709b6d010b9))
* **stage:** 修复切换页面后 StageMask 尺寸与滚动偏移异常 ([a9cda71](https://github.com/Tencent/tmagic-editor/commit/a9cda719bc85161039405dd3219139347638268e))
### Features
* **editor:** 完善样式设置器字段 typeMatch 校验 ([d5a2e25](https://github.com/Tencent/tmagic-editor/commit/d5a2e25e18a7eba980839224bf65ed8481901637))
* **editor:** 支持 update replace 整节点替换,源码编辑走 replace 模式 ([6f0a41f](https://github.com/Tencent/tmagic-editor/commit/6f0a41f2db8add132943cf7b3e4d796f99106e6f))
# [1.8.0-beta.21](https://github.com/Tencent/tmagic-editor/compare/v1.8.0-beta.20...v1.8.0-beta.21) (2026-08-04)
### Bug Fixes
* **editor:** 修复 IdleTask 在 requestIdleCallback timeout 时队列空转的问题 ([b544f05](https://github.com/Tencent/tmagic-editor/commit/b544f059173ff7807a421a98d4247d334bce5fbc))
### Features
* **editor:** getEvent/getMethod 支持节点上下文参数 ([d2a02e1](https://github.com/Tencent/tmagic-editor/commit/d2a02e16d26a4424681ac02592da1de850ebb78d))
# [1.8.0-beta.20](https://github.com/Tencent/tmagic-editor/compare/v1.8.0-beta.19...v1.8.0-beta.20) (2026-07-30)
### Bug Fixes
* **editor:** 修复删除页面/页面片时画布被误清空的问题 ([aa42144](https://github.com/Tencent/tmagic-editor/commit/aa4214473858200c62b6efab79c0671e06cc3917))
### Features
* **editor,dep:** collectIdle 使用常驻 Web Worker 做依赖收集 ([4bbda35](https://github.com/Tencent/tmagic-editor/commit/4bbda354a987b0a409a01184e8511822a0384a13))
# [1.8.0-beta.19](https://github.com/Tencent/tmagic-editor/compare/v1.8.0-beta.18...v1.8.0-beta.19) (2026-07-28)
### Features
* **form:** 新增 validateOnInit默认关闭初始化时自动校验 ([b7c04ed](https://github.com/Tencent/tmagic-editor/commit/b7c04edcd518554d5117c2212bbfe8ef632a4b37))
# [1.8.0-beta.18](https://github.com/Tencent/tmagic-editor/compare/v1.8.0-beta.17...v1.8.0-beta.18) (2026-07-28)
### Bug Fixes
* **editor:** 修复 IdleTask 任务异常或 clearTasks 时队列卡住的问题 ([3fe9cf9](https://github.com/Tencent/tmagic-editor/commit/3fe9cf9b664dc5b39c17b40efe1d3935c89f7553))
### Features
* **form:** 支持 typeMatch 异步校验与 validator 返回值约定 ([a123747](https://github.com/Tencent/tmagic-editor/commit/a123747e9d250166c2bb0f1d3ce3a39dd5baea9f))
# [1.8.0-beta.17](https://github.com/Tencent/tmagic-editor/compare/v1.8.0-beta.16...v1.8.0-beta.17) (2026-07-27)
### Bug Fixes
* **editor:** 修复 collectIdle 批次结算与中断时 Promise 挂起问题 ([b5abf31](https://github.com/Tencent/tmagic-editor/commit/b5abf310663f0bc34bd2c51c2e1a28de0bdf6ab9))
* **editor:** 切换动作类型时清空关联配置字段 ([b564c9e](https://github.com/Tencent/tmagic-editor/commit/b564c9e4aacd215dd46c4b839cf0033ceedc8047))
* **form,table:** groupList分界线、空状态、actions只存在一个 ([dec4ebf](https://github.com/Tencent/tmagic-editor/commit/dec4ebfa20483f699a676e41e0541d23ebe24d81))
* **form:** 完善 mountFormInstance 清理逻辑,避免临时表单实例泄漏 ([bf8df74](https://github.com/Tencent/tmagic-editor/commit/bf8df74864b78891a8820462062624702a1d33d3))
* **table:** 列操作点击后关闭popover ([596d86f](https://github.com/Tencent/tmagic-editor/commit/596d86f2ab08d3d4e6548b5e4bd5759d18e4493d))
### Features
* **editor,stage:** 新增 containerHighlightAddOnly 配置 ([e6cf694](https://github.com/Tencent/tmagic-editor/commit/e6cf694a032652e4f2c05efbab4a07a252e2ffa1))
# [1.8.0-beta.16](https://github.com/Tencent/tmagic-editor/compare/v1.8.0-beta.15...v1.8.0-beta.16) (2026-07-23)

View File

@ -18,7 +18,7 @@ https://tencent.github.io/tmagic-editor/playground/index.html
node.js ^20.19.0 || >=22.12.0
pnpm 11.20.0
pnpm >= 10
先安装 pnpm

View File

@ -588,13 +588,10 @@ export default defineConfig({
},
resolve: {
alias:[
{ find: /^@form/, replacement: path.join(__dirname, '../../packages/form/src/') },
{ find: /^@tmagic\/form-schema/, replacement: path.join(__dirname, '../../packages/form-schema/src/index.ts') },
{ find: /^@tmagic\/form\/headless$/, replacement: path.join(__dirname, '../../packages/form/src/headless.ts') },
{ find: /^@tmagic\/form/, replacement: path.join(__dirname, '../../packages/form/src/index.ts') },
{ find: /^@tmagic\/utils/, replacement: path.join(__dirname, '../../packages/utils/src/index.ts') },
{ find: /^@tmagic\/schema/, replacement: path.join(__dirname, '../../packages/schema/src/index.ts') },
{ find: /^@tmagic\/design\/headless$/, replacement: path.join(__dirname, '../../packages/design/src/headless.ts') },
{ find: /^@tmagic\/design/, replacement: path.join(__dirname, '../../packages/design/src/index.ts') },
{ find: /^@tmagic\/element-plus-adapter/, replacement: path.join(__dirname, '../../packages/element-plus-adapter/src/index.ts') },
]

View File

@ -480,8 +480,6 @@ editorService.highlight("text_123");
- {`MNode`} config 新的节点
- `{Object}` data 可选配置
- {`ChangeRecord`[]} changeRecords 变更记录
- `{boolean}` replace 是否整节点替换(默认 false。为 `true` 时跳过 `mergeWith` / `toggleFixedPosition` / `setChildrenLayout`,直接用传入配置覆盖现有节点
- `{HistoryOpSource}` historySource 见[历史记录相关 options](#历史记录相关-options)
- **返回:**
- `{Promise<{ newNode: MNode; oldNode: MNode; changeRecords?: ChangeRecord[] }>}` 更新前后的节点信息
@ -500,8 +498,6 @@ editorService.highlight("text_123");
当被更新节点正好在当前选中列表中时state 会自动同步到新的节点引用,无需调用方处理
当被更新节点正好是当前页面时state.page 也会同步到新的节点引用;更新非当前页面(不同 ID时不会把编辑器切到该页
默认会将传入配置与现有节点深合并(保留未传入的字段)。若需要完整 DSL 覆盖(如源码编辑写回),传入 `replace: true`
:::
## update
@ -516,7 +512,6 @@ editorService.highlight("text_123");
- `{boolean}` doNotPushHistory 是否不写入历史记录(默认 false
- `{string}` historyDescription 见[历史记录相关 options](#历史记录相关-options)
- `{HistoryOpSource}` historySource 见[历史记录相关 options](#历史记录相关-options)
- `{boolean}` replace 是否整节点替换(默认 false。为 `true` 时跳过 `mergeWith` / `toggleFixedPosition` / `setChildrenLayout`,直接用传入配置覆盖现有节点;适用于源码编辑、完整 DSL 回写等场景
- `{Object}` invalidInfo 启用 [enablePropsFormValidate](./props.md#enablepropsformvalidate) 时,属性面板提交携带的校验错误信息,在写入历史记录之前落库,使历史快照与本次变更对齐
- `{Id}` id 节点 id
- `{'props' | 'style'}` source 错误来源:属性表单 / 样式表单
@ -551,12 +546,6 @@ editorService.highlight("text_123");
才退化为整节点替换(如内部 `sort` / `moveLayer` / 拖动等纯快照场景)。
:::
:::tip
**`replace: true` 整节点替换:** 默认 `update` 会将传入配置与现有节点深合并,未传入的字段会保留。
传入 `replace: true` 后跳过合并与布局相关变换,直接用传入配置覆盖,传入对象中不存在的字段会被删除。
属性面板局部改动请保持默认;源码编辑 / 完整 DSL 回写等场景使用 `replace: true`
:::
## sort
- **[扩展支持](../../guide/editor-expand#行为扩展)** 是

View File

@ -16,11 +16,7 @@
- **详情:**
批量设置多个组件类型的事件列表。增量合并语义:只写入入参中出现的类型,已有的其他类型保持不变。
::: tip 切换 runtime 版本
不同版本的 runtime 事件表不同,直接调用 `setEvents` 会让上一个版本独有的类型残留。是否需要清掉上一个版本的数据由业务自行决定,需要清掉时先调用 [`resetState`](#resetstate) 再写入新表。
:::
批量设置多个组件类型的事件列表
- **示例:**
@ -51,7 +47,7 @@ eventsService.setEvents({
- **详情:**
设置指定组件类型的事件列表,只影响该类型
设置指定组件类型的事件列表
- **示例:**
@ -69,7 +65,6 @@ eventsService.setEvent('button', [
- **参数:**
- `{string}` type 组件类型
- `{ node?: MNode | null }` data 可选上下文,便于插件按节点定制事件列表(默认 `{}`
- **返回:**
@ -77,25 +72,15 @@ eventsService.setEvent('button', [
- **详情:**
获取指定组件类型的事件列表。默认实现仅按 `type` 返回注册事件;可通过 `usePlugin``beforeGetEvent` / `afterGetEvent` 读取 `data.node` 做节点级过滤或扩展。
获取指定组件类型的事件列表
- **示例:**
```js
import { eventsService } from '@tmagic/editor';
const events = eventsService.getEvent('button', { node });
const events = eventsService.getEvent('button');
console.log(events); // [{ label: '点击', value: 'click' }, ...]
// 插件按节点定制
eventsService.usePlugin({
afterGetEvent(events, type, data) {
if (data?.node?.id === 'btn_1') {
return events.filter((item) => item.value !== 'longpress');
}
return events;
},
});
```
## setMethods
@ -110,7 +95,7 @@ eventsService.usePlugin({
- **详情:**
批量设置多个组件类型的方法列表。语义与 `setEvents` 一致:增量合并,入参中不存在的类型保持不变。
批量设置多个组件类型的方法列表
- **示例:**
@ -142,7 +127,7 @@ eventsService.setMethods({
- **详情:**
设置指定组件类型的方法列表,只影响该类型
设置指定组件类型的方法列表
- **示例:**
@ -161,9 +146,7 @@ eventsService.setMethod('video', [
- **参数:**
- `{string}` type 组件类型
- `{ node?: MNode | null; targetId?: Id }` data 可选上下文(默认 `{}`
- `targetId`:目标节点 id
- `node`:目标节点配置,便于插件按节点定制方法列表
- `{string | number}` _targetId 目标节点id保留参数便于扩展时按节点定制
- **返回:**
@ -171,36 +154,15 @@ eventsService.setMethod('video', [
- **详情:**
获取指定组件类型的方法列表。默认实现仅按 `type` 返回注册方法;可通过 `usePlugin``beforeGetMethod` / `afterGetMethod` 读取 `data` 做节点级过滤或扩展。
::: warning 破坏性变更
第二参数已从 `targetId: Id` 调整为对象 `{ node?, targetId? }`。请同步更新调用方与插件钩子入参,例如:
```js
// 旧
eventsService.getMethod('video', 'video_123');
// 新
eventsService.getMethod('video', { targetId: 'video_123', node });
```
:::
获取指定组件类型的方法列表
- **示例:**
```js
import { eventsService } from '@tmagic/editor';
const methods = eventsService.getMethod('video', { targetId: 'video_123', node });
const methods = eventsService.getMethod('video', 'video_123');
console.log(methods); // [{ label: '播放', value: 'play' }, ...]
// 插件按节点定制
eventsService.usePlugin({
afterGetMethod(methods, type, data) {
if (data?.targetId === 'video_123') {
return methods.filter((item) => item.value !== 'stop');
}
return methods;
},
});
```
## resetState
@ -213,17 +175,14 @@ eventsService.usePlugin({
- **详情:**
重置事件服务状态,清空所有事件和方法配置`setEvents` / `setMethods` 是增量合并,切换 runtime 版本这类需要丢弃上一份事件表的场景,由业务在写入新表前自行调用本方法。
重置事件服务状态,清空所有事件和方法配置
- **示例:**
```js
import { eventsService } from '@tmagic/editor';
// 切到另一个版本的 runtime先清空再写入该版本的事件表
eventsService.resetState();
eventsService.setEvents(nextVersionEvents);
eventsService.setMethods(nextVersionMethods);
```
## destroy

View File

@ -630,10 +630,6 @@ const propsValues = {
该属性最终会设置到[eventsService](./eventsServiceMethods.md)中,所以也可直接调用[eventsService.setEvents()](./eventsServiceMethods.md#setEvents)与[eventsService.setMethods()](./eventsServiceMethods.md#setMethods)方法来配置
:::
:::warning
该属性每次变更都是增量合并,不会清掉上一次写入的类型。切换 runtime 版本时若需要丢弃旧版本的事件表,请自行调用 [eventsService.resetState()](./eventsServiceMethods.md#resetstate)
:::
- **默认值:** `{}`
- **类型:** `Record<string, { events: EventOption[]; methods: EventOption[] }>`
@ -1023,18 +1019,6 @@ alt: 按住alt键启动识别
- **类型:** `'default' | 'alt' | ''`
## containerHighlightAddOnly
- **详情:**
是否只有新增组件(从组件列表拖入新组件)时才启用识别容器
开启后,在画布中拖动已有组件时不再识别容器,即已有组件不能通过拖动加入其他容器;新增组件仍然按 [containerHighlightType](#containerHighlightType) 配置的方式识别
- **默认值:** `false`
- **类型:** `boolean`
## stageRect
@ -1562,71 +1546,52 @@ const onLayerNodeDblclick = (event, data) => {
- 返回 `false` 时,会同时阻断默认的"展开/收起"行为以及向上抛出的 [`layer-node-dblclick`](./events.md#layer-node-dblclick) 事件;返回其他值则继续触发默认行为并抛出事件。
:::
## 表单业务上下文
## extendFormState
- **详情:**
扩展表单状态
编辑器会把 `services` 与当前 `stage` 通过 `FORM_CONTEXT_KEY` provide 下去,编辑器内所有 `MForm`(属性面板、历史差异对比表单、侧边栏、以及 Link / FormBox 里的嵌套子表单)都自动继承。
用于在属性表单中注入自定义的状态数据,这些数据可以在表单配置的各个字段为函数时的第一个参数中获取
业务方要往里追加自己的字段,在 `<m-editor>` 外层再 provide 一层即可,同名字段覆盖内置的:
- **默认值:** `undefined`
- **类型:** `(state: FormState) => Record<string, any> | Promise<Record<string, any>>`
- **示例:**
```html
<template>
<m-editor></m-editor>
<m-editor :extend-form-state="extendFormState"></m-editor>
</template>
<script setup>
import { computed, provide } from 'vue';
import { FORM_CONTEXT_KEY } from '@tmagic/form';
provide(
FORM_CONTEXT_KEY,
computed(() => ({
currentUser: store.currentUser,
env: store.env,
})),
);
const extendFormState = async (state) => {
// 返回自定义的状态数据
return {
// 可以是同步数据
currentUser: {
name: 'Admin',
role: 'admin',
},
// 也可以是异步获取的数据
projectConfig: await fetchProjectConfig(),
};
};
</script>
```
补类型用模块增强:
```ts
declare module '@tmagic/form-schema' {
interface FormContext {
currentUser?: { name: string; role: string };
}
}
```
表单配置里统一从第一个参数 `mForm`formState 是读穿 Proxy`mForm` 上没有的字段自动落到 context所以回调签名不变后端下发的存量配置无需改动。
:::tip
扩展的状态可以在表单配置中通过 `state` 访问,例如:
```js
{
name: 'title',
text: '标题',
disabled: (mForm) => mForm.currentUser?.role !== 'admin',
display: (mForm) => mForm.env === 'prod',
// 根据扩展的状态动态设置
disabled: (state) => state.currentUser.role !== 'admin',
}
```
::: warning 从 extendFormState 迁移
`extendFormState` prop 已移除,同时移除的还有 `PropsPanel` / `FormPanel` / `HistoryDiffDialog` / `CompareForm` / `ViewForm``extendState``CompareForm``baseFormState``useHistoryRevert``extendState``getPropsPanelFormState`
改法是把「返回数据的函数」换成「数据本身」:
```ts
// before
const extendFormState = (state) => ({ env: store.env });
// <m-editor :extend-form-state="extendFormState" />
// after
provide(FORM_CONTEXT_KEY, computed(() => ({ env: store.env })));
```
原先返回 Promise 的写法,改由宿主自己决定挂载时机(`v-if="ready"`),或先 provide 一个空 context、数据到位后更新——后者不保证 `defaultValue` / `onInitValue` 首轮能读到。
配置里的 `mForm.xxx` 读法不受影响,读穿 Proxy 保留。
:::
## historyListExtraTabs

View File

@ -219,25 +219,8 @@
- **类型:** `boolean`
## context
## extendState
- **详情:** 宿主业务上下文。可用本 prop 直接传,也可由祖先 `provide(FORM_CONTEXT_KEY)` 下发;同名字段本 prop 优先。
嵌套表单Link 的子表单、`MFormBox``MFormDialog`)会自动继承最近祖先的 context不需要层层透传。
配置回调统一通过第一个参数 `mForm` 读取formState 是一个读穿 Proxy`mForm` 上找不到的字段会自动落到 context。回调签名因此保持不变后端 eval 下发的存量配置无需改动。
- **类型:** `FormContext`
- **示例:**
```ts
// 模板:<m-form :context="formContext" />
const formContext = computed(() => ({ username: store.username }));
// 配置回调mForm.username 读穿到 context
{
display: (mForm) => mForm.username === 'admin',
}
```
- **详情:** 扩展 formState 的钩子函数,返回的对象会被合并到 formState 上
- **类型:** `(state: FormState) => Record<string, any> | Promise<Record<string, any>>`

View File

@ -1,107 +1,14 @@
# submitForm 函数
以命令式方式对一份「表单配置 + 表单值」执行一次校验并取回表单值,类似 `ElMessage` 的用法。
以命令式方式调用 `MForm` 组件完成一次表单校验/提交,类似 `ElMessage` 的用法。
走**无渲染**实现:不创建任何 DOM 容器、不实例化任何组件,而是直接遍历 `config` 树收集带规则的字段,交给 [`async-validator`](https://github.com/yiminghe/async-validator)`element-plus` 内部用的也是它)执行。因此它可以在 Node / CI 等没有 DOM 的环境中使用,也省去了挂载整棵表单的开销。校验通过则 `resolve` 表单值,失败则 `reject` 错误信息。纯 Node 请从 `@tmagic/form/headless` 引入,避免加载 Vue 组件和样式
调用时函数内部会临时挂载一个不可见的 `MForm` 实例,把入参作为 props 透传给它,等待初始化完成后调用其 `submitForm` 方法。校验通过则 `resolve` 表单值,校验失败则 `reject` 错误信息,最后自动卸载实例并清理 DOM
适用于一些没有合适的容器、但又需要复用 `MForm` 校验逻辑的场景,例如:
- 通过快捷菜单/命令面板触发一次性表单
- 在脚本/服务层完成一次表单值校验后再发请求
- 把 `config` 配置当作"可执行的校验规则"使用
- 在 Node 脚本 / CI 中批量校验组件配置
## 无渲染校验与自定义字段登记
无渲染实现按 `Container.vue` 及各容器组件的模板规则遍历配置树,产出的字段 `prop` 与规则与「挂载 `MForm` 后调用 `validate()`」等价。需要 UI 时传入 `dialog: true`,会把表单以弹层渲染出来供填写/确认。
字段只要带了 `rules`(会包 FormItem就会校验自身不必先登记为叶子。配置里有 `items` 会下钻子项。内部再渲染 `MContainer` 的复合字段需要 `registerField(type, { innerConfig })`把内部会挂到父表单上的配置交出来。innerConfig 回调自身抛错时,会以 `FieldInnerConfigError``code: 'FIELD_INNER_CONFIG'`reject。
innerConfig 回调在校验和表单值初始化两条链路上都会被调用(后者用于走到复合字段内部、找出需要执行 `effect` 的子字段),所以它应当只做配置派生、可重复调用、不要做重活。在表单值初始化链路上,回调抛错只会记录到 console 并跳过该子树,不会让表单渲染不出来。
自定义字段的渲染组件和无渲染校验都通过 `registerField` / `registerFields` 一次登记。`component` 会写入字段注册表(`getFormField`);传入 `app` 时同时 `app.component('m-fields-*')`。容器组件用 `container`,对应 `m-form-*`
字段对表单值的初始化写入统一登记为 `effect`,渲染与无渲染共用同一份登记表,执行点也只有一个:表单值初始化完成后(`MForm` 内部、`validateValues`、以及 tab / table 新增行时)各执行一次 `applyMountValueEffects`,字段组件自身不要在 `setup` 里改写 `model`。因此 effect 有两个约束:一是必须幂等,同一份值可能被执行多次(如 `initValues` 变化后重新初始化);二是不看 `display``display: false` 或函数返回假的字段也会被规整,避免字段由隐藏转为显示时漏掉)。`type: 'hidden'` 不同:遍历在该节点停止、不往下分派,内部字段不会执行 effect。需要按路径跨层级写值时用上下文里的 `values`(本次处理的值根对象,`prop` 即以它为根),不要用 `mForm.values`——对比模式处理的是 `lastValues` 那一份,新增行处理的则是还没挂到表单上的一行值。单个 effect 抛错只会记录到 console不影响其余字段与表单渲染。复合字段可以同时登记 `effect``innerConfig`:前者改本字段的值,后者只派生内部配置、不要在回调里改 `model`
| 字段形态 | 登记方式 |
| --------------------------------------------------------------------- | ------------------------------------------- |
| 自身带 `rules`,内部没有嵌套的父表单 FormItem | 无需登记,直接校验 |
| 内部只渲染叶子 UI或把子表单渲染在独立的 `MForm` / `MFormBox` 实例里 | `registerField('my-field')`(配置里有 `items` 但不属于父表单时,避免被当下钻) |
| 同时需要渲染组件 | `registerField('my-field', { component })` |
| 容器组件(`m-form-*` | `registerField('my-box', { container, walk })` |
| 叶子字段,但需要改写表单值(类似 `display``initValue` | `registerField('my-field', { effect })` |
| 内部再渲染 `MContainer` / `MPanel` / `MGroupList`,向父表单注册字段 | `registerField('my-field', { innerConfig })`(需要改本字段的值时再加 `effect` |
| 自定义 `typeMatch` 类型校验 | `registerField('my-field', { typeMatch })` |
```ts
import { registerField, registerFields } from '@tmagic/form';
import MyColorPicker from './MyColorPicker.vue';
// 叶子字段:内部没有嵌套的表单项;带 component 时即可渲染
registerFields({ 'my-color-picker': { component: MyColorPicker } });
// 需要挂到当前 app 时传入第二个参数
registerFields({ 'my-color-picker': { component: MyColorPicker } }, app);
// 叶子字段,但需要改写表单值:写成 effect不要在组件 setup 里改 model
registerField('my-status', {
effect: ({ config, model }) => {
if ((config as any).initValue && model) {
model[(config as any).name] = (config as any).initValue;
}
},
});
// 复合字段:把组件内部渲染的 MContainer 配置交出来
registerField('my-composite', {
innerConfig: ({ config, model, prop }) => ({
// 对应组件内部 <MContainer :config="childConfig" :model="model[name]" :prop="prop">
config: childConfig,
model: model[config.name],
prop,
}),
});
// typeMatch覆盖或扩展该 type 的类型匹配校验,可与 innerConfig / effect 同时登记
registerField('my-status', {
typeMatch: (value, { message }) => (typeof value === 'string' ? undefined : message || '应为字符串'),
});
```
返回的 `config``name` 会被追加到返回的 `prop` 上。因此当内部配置复用了字段自身的 `name`(例如内部渲染 `<MGroupList :config="{ name, items }" :model="model" :prop="prop">`)时,要返回 `parentProp` 而非 `prop`,否则 `name` 会被拼两次:
```ts
registerField('my-list', {
innerConfig: ({ config, parentProp }) => ({
config: { type: 'group-list', name: config.name, items: innerItems },
prop: parentProp,
}),
});
```
编辑器侧四个复合字段(`code-select` / `display-conds` / `event-select` / `style-setter`)的登记可参考 `packages/editor/src/fields/headless-validation.ts`innerConfig 与组件共用同一份配置工厂(`packages/editor/src/fields/configs/`),避免两条链路各写一份而逐渐跑偏。
`type: 'component'` 会把 `config.component` 当任意 Vue 组件渲染。无渲染校验把它视为叶子,**不会**遍历内部结构。因此该组件不得再向父表单注册 FormItem需要嵌套表单项时应对该具体组件 `registerField(type, { innerConfig })`
### 重复登记与撤销
同一个 type 多次登记按字段浅合并,后一次只覆盖自己传入的 key
```ts
registerField('my-composite', { innerConfig });
registerField('my-composite', { component: MyComposite }); // innerConfig 仍在
```
登记分「内置」与「业务」两层。`app.use(MagicForm)` / `registerBuiltInFields` 写内置层,`registerField` / `registerFields` 写业务层;读取时业务层优先,`unregisterField` / `clearFields` 只清业务层,内置字段不受影响(单测里 `clearFields` 之后仍能校验 `text``tab` 等内置 type
因为是合并语义,把一个已登记 `innerConfig` 的 type 改成普通叶子,不能靠再传一次空对象,要先撤销:
```ts
registerField('my-composite', {}); // ✗ 合并后 innerConfig 还在,仍会下钻
unregisterField('my-composite'); // ✓ 先清掉业务层登记
registerField('my-composite', { component: MyComposite });
```
一次登记里同时传多个形态时的优先级:`walk` > `innerConfig` > `effect`(叶子),命中低优先级的那份会被忽略并在控制台给出告警。
## 签名
@ -111,7 +18,7 @@ function submitForm(options: SubmitFormOptions): Promise<any>;
## 参数
`options``MForm` 组件的 props 基本对齐,额外提供了 `native``returnChangeRecords``dialog`、`signal` 等参数。`appContext``dialog: true` 时生效
`options``MForm` 组件的 props 基本对齐,额外提供了 `native``returnChangeRecords``appContext`、`timeout` 等参数
| 名称 | 类型 | 默认值 | 说明 |
| ---------------------- | ------------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------- |
@ -131,23 +38,22 @@ function submitForm(options: SubmitFormOptions): Promise<any>;
| `popperClass` | `string` | — | 弹层 className |
| `preventSubmitDefault` | `boolean` | — | 是否阻止表单原生 submit |
| `useFieldTextInError` | `boolean` | `true` | 校验失败时错误提示前缀是否使用字段的 `text` 文案;`false` 时直接使用字段 `name` |
| `context` | `FormContext` | — | 宿主业务上下文,与 MForm 的 `context` 语义一致;配置回调通过 `mForm.xxx` 读穿取用 |
| `extendState` | `(state: FormState) => Record<string, any> \| Promise<Record<string, any>>` | — | 扩展 `formState` |
| `native` | `boolean` | `false` | 透传给 `Form.submitForm``true` 时返回内部响应式 `values`,否则返回 `cloneDeep(toRaw(values))` |
| `returnChangeRecords` | `boolean` | `false` | `true` 时 resolve 结果为 `{ values, changeRecords }`,携带表单变更记录;否则仅 resolve `values` |
| `appContext` | `AppContext \| null` | `null` | 父级 Vue 应用上下文。仅 `dialog: true` 时生效用于继承全局组件、指令、provide 等,常通过 `app._context``getCurrentInstance()?.appContext` 获取 |
| `dialog` | `boolean` | `false` | `true` 时把表单以弹层形式渲染出来,点击「确定」才提交,「取消」则以 reject 中断;校验失败会保留弹层并展示错误,便于修正后重试。等待人工操作,可用 `signal` 中断 |
| `title` | `string` | `'submitForm'` / `'validateForm'` | 弹层标题,仅 `dialog: true` 时生效 |
| `signal` | `AbortSignal` | — | 外部中断信号。abort 时立即以 `signal.reason` reject并卸载 `dialog` 模式下已挂载的临时表单实例 |
| `appContext` | `AppContext \| null` | `null` | 父级 Vue 应用上下文。需要继承全局组件、指令、provide 等时传入,常通过 `app._context``getCurrentInstance()?.appContext` 获取 |
| `timeout` | `number` | `10000` | 等待表单初始化的最长时间(毫秒)。超时将以错误 reject。设为 `<= 0` 时关闭超时兜底 |
## 返回值
- `校验通过``Promise<any>` resolve 当前表单值(`native` 决定是否克隆);当 `returnChangeRecords``true`resolve `{ values, changeRecords }`
- `校验失败``Promise<any>` reject 一个 `Error``message` 中包含逐条字段错误信息(格式 `${text} -> ${message}`,多条用 `<br>` 分隔)
- `初始化超时``Promise<any>` reject `Error('submitForm timeout after ${timeout}ms: form is not initialized.')`
`dialog: true`无论成功或失败,函数都会在最后自动 `unmount` 内部 app 并移除挂载用的 DOM 容器,无需调用方手动清理。
无论成功或失败,函数都会在最后自动 `unmount` 内部 app 并移除挂载用的 DOM 容器,无需调用方手动清理。
::: tip 关于 changeRecords
`changeRecords` 记录的是表单挂载后发生的字段变更(由各字段的 `change` 事件累积而来)。无渲染校验没有用户交互,因此固定返回空数组;只有 `dialog: true` 时才可能有内容(`MForm` 内部的 `submitForm` 在校验通过后会清空变更记录,因此本函数会在调用前先做快照)
`changeRecords` 记录的是表单挂载后发生的字段变更(由各字段的 `change` 事件累积而来)。`submitForm` 这种命令式、无用户交互的场景下,通常为空数组;只有在 `extendState` 或字段联动等逻辑中触发了变更时才会有内容。`MForm` 内部的 `submitForm` 在校验通过后会清空变更记录,因此本函数会在调用前先对其做快照再返回
:::
## 基础用法
@ -193,9 +99,9 @@ console.log(values); // { username: 'foo' }
console.log(changeRecords); // ChangeRecord[]
```
## 弹层模式(`dialog: true`)下继承父级应用上下文
## 在组件中继承父级应用上下文
默认路径不挂载组件,不需要 `appContext`。只有 `dialog: true` 会渲染弹层,此时 `MForm` 要用到 `@tmagic/design` 的组件(背后可能是 `element-plus``tdesign`),需要宿主应用的上下文带过去:
`MForm` 内部使用 `@tmagic/design` 的组件(背后可能是 `element-plus``tdesign`),需要宿主应用先完成相应 `app.use(...)` 安装。在 `submitForm` 这种脱离常规组件树的命令式调用中,可通过 `appContext` 把父级应用上下文带过去:
```vue
<script setup lang="ts">
@ -209,8 +115,6 @@ const onClick = async () => {
const values = await submitForm({
config: [{ type: 'text', name: 'text', text: '文本' }],
initValues: { text: 'hello' },
dialog: true,
title: '编辑配置',
appContext,
});
console.log(values);
@ -254,77 +158,65 @@ try {
}
```
## validateForm 函数
`validateForm``submitForm` 共用同一套无渲染校验实现,区别在于它是**静默**的:校验失败不抛异常、不返回表单值,而是以返回值形式给出错误文案。适合「只想探测这份配置是否合法」的场景,例如源码编辑器保存后校验、批量校验组件配置。
```ts
function validateForm(options: ValidateFormOptions): Promise<string>;
```
`options``SubmitFormOptions` 中与校验相关的子集(`config``initValues``parentValues``labelWidth``keyProp``useFieldTextInError``extendState``typeMatchValid``appContext``dialog``title``signal`)。
```ts
import { validateForm } from '@tmagic/form';
const error = await validateForm({
config: [{ type: 'text', name: 'username', text: '用户名', rules: [{ required: true, message: '请输入用户名' }] }],
initValues: { username: '' },
});
if (error) {
// '用户名 -> 请输入用户名'
}
```
校验通过返回空字符串 `''`,否则返回以 `<br>` 拼接的错误文案。无法完成校验时才会 reject例如 innerConfig 回调失败抛出 `FieldInnerConfigError`)。
## 运行环境
无渲染实现不接触 `document` / `window`,因此在任何 JS 运行时中都可用:
`submitForm` 内部依赖 `document` / `window` 来挂载临时 Vue 实例,因此**只能在浏览器或具备 DOM 环境的运行时中使用**。
| 环境 | 是否可用 | 说明 |
| ------------------------------------------ | -------- | ------------------------------------------------------------------------------------- |
| 浏览器 / Electron 渲染进程 / 浏览器扩展 | ✅ | 直接可用 |
| Vitest / Jest + `happy-dom` / `jsdom` | ✅ | 项目自身的单测就跑在这种环境下 |
| 纯 Node.js / Bun / Deno无 DOM polyfill | ✅ | 从 `@tmagic/form/headless` 引入,不要用 `@tmagic/form` 主入口 |
| 环境 | 是否可用 | 说明 |
| ----------------------------------------------- | -------- | --------------------------------------------------------------------------------- |
| 浏览器 / Electron 渲染进程 / 浏览器扩展 | ✅ | 直接可用 |
| Vitest / Jest + `happy-dom` / `jsdom` | ✅ | 项目自身的单测就跑在这种环境下 |
| 纯 Node.js / Bun / Deno无 DOM polyfill | ❌ | 模块顶层就会读 `document`,会抛 `document is not defined` |
| Node.js + 手动注入 `happy-dom` / `jsdom` | ⚠️ | 可用,需要在 import `@tmagic/form` **之前**完成全局变量注入;校验行为不一定与浏览器完全一致 |
### 在 Node.js 中使用(需要先准备 DOM
下面是一个在 Node 脚本里调用 `submitForm` 的完整例子,使用 [`happy-dom`](https://github.com/capricorn86/happy-dom) 作为 DOM polyfill
```ts
// scripts/check-form.ts —— 纯 Node 环境,无需任何 DOM polyfill
import { builtInFields, registerBuiltInFields, registerFields, validateForm } from '@tmagic/form/headless';
import { editorFields } from '@tmagic/editor/headless';
// scripts/check-form.ts
import { Window } from 'happy-dom';
// `builtInFields` 只是数据;未 `app.use(MagicForm)` 时要自己登记
registerBuiltInFields(builtInFields);
registerFields(editorFields);
const error = await validateForm({
config: [{ type: 'text', name: 'username', text: '用户名', rules: [{ required: true }] }],
initValues: { username: '' },
const window = new Window();
Object.assign(globalThis, {
window,
document: window.document,
navigator: window.navigator,
HTMLElement: window.HTMLElement,
});
if (error) {
console.error(error);
process.exit(1);
}
// 注意DOM polyfill 必须先注入到 globalThis再用动态 import
// 加载业务模块,否则 @tmagic/design 等模块顶层执行时就会读 document
const { createApp } = await import('vue');
const ElementPlus = (await import('element-plus')).default;
const MagicForm = (await import('@tmagic/form')).default;
const { submitForm } = await import('@tmagic/form');
const parentApp = createApp({ render: () => null });
parentApp.use(ElementPlus);
parentApp.use(MagicForm);
const values = await submitForm({
config: [{ type: 'text', name: 'username', text: '用户名' }],
initValues: { username: 'foo' },
appContext: parentApp._context,
});
console.log(values);
```
::: warning 注意
`dialog: true` 依赖 DOM 与已安装的 UI 库(`element-plus` / `tdesign`),在纯 Node 环境中不可用。
:::
::: warning ESM 与 CJS 不要混用
`@tmagic/form/headless` 的 ESM 产物与 `@tmagic/form` 共用同一批模块文件,字段注册表是同一份,两个入口可以混着 `import`
CJS 产物是两个各自独立的 bundle注册表不共享。所以同一进程里不要同时 `require('@tmagic/form')``require('@tmagic/form/headless')`——在一边 `registerField` 另一边读不到,校验会因为「没登记过这个 type」而静默放过。`@tmagic/editor``@tmagic/design` 的 headless 子路径同理。
- DOM polyfill 必须在 **import 业务模块之前** 注入到 `globalThis`,否则模块顶层执行时仍会失败
- 在 `happy-dom` / `jsdom` 中,`element-plus` 的部分 `validate()` 行为不一定能 1:1 复现真实浏览器(例如某些场景下必填规则可能不触发),建议关键校验使用自定义 `validator` 函数确保稳定
- 如果只是想在 Node 端做一次纯校验,更稳妥的做法是直接复用 [`async-validator`](https://github.com/yiminghe/async-validator)element-plus 内部用的就是它),绕开整个 Vue 渲染层
:::
## 类型定义
::: details 查看 `SubmitFormOptions` 类型定义
<<< @/../packages/form/src/utils/submitHeadless.ts#SubmitFormOptions{ts}
<<< @/../packages/form/src/submitForm.ts#SubmitFormOptions{ts}
:::
::: details 查看 `SubmitFormResult` 类型定义
<<< @/../packages/form/src/utils/submitHeadless.ts#SubmitFormResult{ts}
<<< @/../packages/form/src/submitForm.ts#SubmitFormResult{ts}
:::

View File

@ -69,11 +69,10 @@
## delayedMarkContainer
- **类型**`(event: MouseEvent, excludeElList?: Element[], isAdd?: boolean) => NodeJS.Timeout | undefined`
- **类型**`(event: MouseEvent, excludeElList?: Element[]) => NodeJS.Timeout | undefined`
- **参数**
- `event`:鼠标事件
- `excludeElList`:计算鼠标所在容器时要排除的元素列表
- `isAdd`:当前操作是否为新增组件(从组件列表拖入新组件),`containerHighlightType``addOnly` 时只有新增才会标记容器
- **详情**
鼠标拖拽着元素在容器上方悬停延迟一段时间后对容器进行标记如果悬停时间够长将标记成功悬停时间短调用方通过返回的timeoutId取消标记

View File

@ -69,8 +69,6 @@
}
```
`validator` 除了调用 `callback` 外,也兼容 async-validator 的返回值约定:返回 `false``Error` / 错误数组表示失败,返回 `true` 表示通过,返回 `Promise` 则以 resolve / reject 为结果,内部抛出的异常会转成校验失败。同步与异步 `typeMatch` 下这些约定行为一致,且只会上报一次结果(既调 `callback` 又返回 `Promise` 时以先到的为准)。
## 扩展自定义 type 规则
业务可覆盖内置规则,或为自定义字段 type 注册校验。自定义规则优先于内置规则。
@ -78,76 +76,50 @@
### 运行时注册
```ts
import { registerField, registerFields, unregisterField, clearFields } from '@tmagic/form';
import {
registerTypeMatchRule,
registerTypeMatchRules,
deleteTypeMatchRule,
clearTypeMatchRules,
} from '@tmagic/form';
// 覆盖内置 text
registerField('text', {
typeMatch: (value, { message }) => {
if (typeof value !== 'string') {
return message || '值类型应为字符串';
}
},
registerTypeMatchRule('text', (value, { message }) => {
if (typeof value !== 'string') {
return message || '值类型应为字符串';
}
});
// 扩展业务字段
registerField('vs-code', {
typeMatch: (value, { message }) => {
if (typeof value !== 'string') {
return message || '代码字段应为字符串';
}
},
registerTypeMatchRule('vs-code', (value, { message }) => {
if (typeof value !== 'string') {
return message || '代码字段应为字符串';
}
});
// 批量注册
registerFields({
foo: { typeMatch: (value) => (Array.isArray(value) ? undefined : '应为数组') },
registerTypeMatchRules({
foo: (value) => (Array.isArray(value) ? undefined : '应为数组'),
});
// 删除 / 清空该 type 的全部登记(含 typeMatch
unregisterField('foo');
clearFields();
// 删除 / 清空
deleteTypeMatchRule('foo');
clearTypeMatchRules();
```
自定义校验器签名:`(value, context) => string | undefined | Promise<string | undefined>`。返回错误文案表示失败,返回 `undefined` 表示通过。`context` 包含 `fieldType``mForm``props``message`
### 异步校验
自定义校验器可以返回 `Promise`,用于需要异步确认取值是否合法的场景(如请求接口校验 id 是否存在)。内置规则均为同步。
```ts
import { registerField } from '@tmagic/form';
registerField('mod-select', {
typeMatch: async (value, { message }) => {
const exists = await checkModExists(value);
if (!exists) {
return message || `模块(${value})不存在`;
}
},
});
```
异步校验器通过后才会执行同一条 rule 上的自定义 `validator`。需要注意几点:
- **校验器自身失败不算校验失败。** Promise 被 reject如接口异常时只打印错误、该字段按通过处理避免网络故障阻塞操作。需要把失败暴露给用户时请在校验器内部 catch 并返回错误文案。
- **建议自行缓存请求结果。** 每次校验都会执行校验器,无缓存会导致逐次输入都发请求;也可以给 rule 配 `trigger: 'blur'` 降低触发频率。
- **只有最新一轮校验的结论会被采用。** 新一轮校验开始后,上一轮针对旧值、尚未返回的校验不再使用自己的结论,而是等最新一轮出结论后一起结算,因此旧结论不会晚到覆盖新结论,`form.validate()` 也不会对一个尚未校验完的值返回成功。
自定义校验器签名:`(value, context) => string | undefined`。返回错误文案表示失败,返回 `undefined` 表示通过。`context` 包含 `fieldType``mForm``props``message`
### 安装时注册
```ts
import MagicForm from '@tmagic/form';
import MyField from './MyField.vue';
app.use(MagicForm, {
fields: {
'my-field': {
component: MyField,
typeMatch: (value, { message }) => {
if (typeof value !== 'string') {
return message || 'my-field 应为字符串';
}
},
typeMatchRules: {
'my-field': (value, { message }) => {
if (typeof value !== 'string') {
return message || 'my-field 应为字符串';
}
},
},
});
@ -155,7 +127,7 @@ app.use(MagicForm, {
### Editor 字段内置规则
安装 `@tmagic/editor` 时会`editorFields`(无 Vue 组件)叠上字段组件后作为 `fields` 传给 `@tmagic/form`。Node 里从 `@tmagic/form/headless``@tmagic/editor/headless` 引入即可。若安装时也传了 `fields`,会与编辑器字段按 type 浅合并:调用方传入的 key 覆盖对应项,未传的 key`innerConfig` / `typeMatch`)保留。服务数据(数据源 / 代码块 / 节点树)未就绪时,只做基础形态校验,不做枚举或存在性失败。
安装 `@tmagic/editor` 时会自动 `registerTypeMatchRules` 注册编辑器自定义字段规则。服务数据(数据源 / 代码块 / 节点树)未就绪时,只做基础形态校验,不做枚举或存在性失败。
| 字段 type | 期望值 |
| --- | --- |
@ -174,7 +146,7 @@ app.use(MagicForm, {
> 容器类字段(`event-select` / `code-select` / `display-conds`)遵循同一约定:容器级 typeMatch 只做结构校验,「枚举 / 存在性」下沉到内部单元格各自的 typeMatch/rules避免单个子项非法导致整块表单标红。
业务仍可用 `registerField(type, { typeMatch })` 覆盖上述任一 type 的类型校验;多次 `registerField` 按字段浅合并,不会丢掉已登记的 `innerConfig` / `walk` / `effect`
业务仍可用 `registerTypeMatchRule` 覆盖上述任一 type
## 示例
@ -229,10 +201,6 @@ app.use(MagicForm, {
<<< @/../packages/form/src/utils/typeMatch.ts#TypeMatchValidateContext{ts}
:::
::: details 查看 FieldOptions 类型定义
<<< @/../packages/form/src/utils/registerField.ts#FieldOptions{ts}
:::
::: details 查看 FormInstallOptions 类型定义
<<< @/../packages/form/src/plugin.ts#FormInstallOptions{ts}
:::

View File

@ -101,6 +101,7 @@ onCodeBlockDiff(id, index);
| 字段 | 必填 | 说明 |
| --- | --- | --- |
| `appContext` | 否 | 父级应用上下文,用于让动态挂载的差异确认弹窗继承全局组件 / 指令 / provide / 插件Element Plus、`@tmagic/form` 字段组件等)。在组件 `setup` 中调用时会自动取当前组件的 `appContext`,无需手动传;仅当在组件 setup 之外调用时才需显式传入(如 `editorApp._context`)。 |
| `extendState` | 否 | 透传给差异确认弹窗的 `extendState`(同 Editor 的 [`extendFormState`](#自定义对比判断)),使对比表单中依赖业务上下文的 `display` / `disabled``filterFunction` 正常工作。 |
| `dialogWidth` | 否 | 内置页面 / 数据源 / 代码块的差异 / 回滚确认弹窗默认宽度(透传给 `TMagicDialog``width`),如 `'1200px'` / `'80%'`。缺省时使用弹窗内置默认宽度(`900px`)。业务自有历史可在 `viewDiff` / `confirmAndRevert` 调用时通过各自入参的 `width` 单独覆盖。 |
> 若只需要无确认、无校验的静默回滚,直接用上面的 `editorService.revertPageStep` 等即可,无需 `useHistoryRevert`
@ -163,7 +164,7 @@ const historyListExtraTabs = [
## 自定义对比判断
差异对话框中的「表单对比」最终透传到 `MForm`。Editor 会把 `services` / `stage` provide 为 `FORM_CONTEXT_KEY`,对比表单自动继承;业务字段在 `<m-editor>` 外层再 provide 一层即可,详见 [表单业务上下文](/api/editor/props.html#表单业务上下文)。配置回调通过 `mForm.xxx` 读穿取用
差异对话框中的「表单对比」最终透传到 `MForm`,你可以通过 Editor 顶层注入的 `extendFormState` 让对比表单拿到完整业务上下文,从而让依赖上下文的 `display` / `disabled``filterFunction` 正常工作
若某些字段语义上相等但结构不同(例如 `code-select` 字段中 `''``{ hookType: 'code', hookData: [] }` 应视为相等),可借助 `@tmagic/form` 的 [`showDiff`](/api/form/form-props.html#showdiff) 自定义判断函数避免被误判为差异。

View File

@ -45,20 +45,15 @@ app.use(MagicForm);
app.mount("#app");
```
也可在安装时传入自定义字段登记(叶子 / innerConfig / typeMatch / component,详见[表单校验 - 扩展自定义 type 规则](../../form-config/rules.md#扩展自定义-type-规则)
也可在安装时传入自定义 `typeMatch` 规则,详见[表单校验 - 扩展自定义 type 规则](../../form-config/rules.md#扩展自定义-type-规则)
```javascript
import MyField from './MyField.vue';
app.use(MagicForm, {
fields: {
'my-field': {
component: MyField,
typeMatch: (value, { message }) => {
if (typeof value !== 'string') {
return message || 'my-field 应为字符串';
}
},
typeMatchRules: {
'my-field': (value, { message }) => {
if (typeof value !== 'string') {
return message || 'my-field 应为字符串';
}
},
},
});

View File

@ -69,11 +69,11 @@ $ npm install monaco-editor -S
```ts
import { createApp } from "vue";
import EditorWorker from "monaco-editor/editor/editor.worker.js?worker";
import CssWorker from "monaco-editor/language/css/css.worker.js?worker";
import HtmlWorker from "monaco-editor/language/html/html.worker.js?worker";
import JsonWorker from "monaco-editor/language/json/json.worker.js?worker";
import TsWorker from "monaco-editor/language/typescript/ts.worker.js?worker";
import EditorWorker from "monaco-editor/esm/vs/editor/editor.worker?worker";
import CssWorker from "monaco-editor/esm/vs/language/css/css.worker?worker";
import HtmlWorker from "monaco-editor/esm/vs/language/html/html.worker?worker";
import JsonWorker from "monaco-editor/esm/vs/language/json/json.worker?worker";
import TsWorker from "monaco-editor/esm/vs/language/typescript/ts.worker?worker";
import editorPlugin from "@tmagic/editor";
import MagicElementPlusAdapter from "@tmagic/element-plus-adapter";

View File

@ -43,7 +43,6 @@ new DataSource(options: DataSourceOptions)
| `methods` | `CodeBlockContent[]` | 自定义方法配置 |
| `data` | `any` | 当前数据 |
| `isInit` | `boolean` | 是否已初始化 |
| `isMounted` | `boolean` | 页面渲染后的 `mounted` 是否已执行 |
## 实例方法
@ -173,28 +172,6 @@ ds.onDataChange('user.name', (payload) => {
初始化数据源。
### mounted
- **返回:**
- `{Promise<void>}`
- **详情:**
页面渲染完成后执行,执行后 `isMounted``true`。由 `DataSourceManager` 监听到 `mounted` 事件后统一调用,自定义数据源可以重写该方法实现「页面渲染后」的逻辑。
- **示例:**
```typescript
class CustomDataSource extends DataSource {
public async mounted() {
// 页面渲染后再拉取数据,避免阻塞首屏
this.setData(await fetchSomething());
await super.mounted();
}
}
```
### destroy
- **返回:**

View File

@ -25,7 +25,6 @@ new DataSourceManager(options: DataSourceManagerOptions)
| `data` | `DataSourceManagerData` | 所有数据源的数据 |
| `initialData` | `DataSourceManagerData` | 初始化数据 |
| `useMock` | `boolean` | 是否使用 Mock 数据 |
| `isMounted` | `boolean` | 页面是否已渲染完成(收到过 `mounted` 事件) |
## 静态方法
@ -110,27 +109,6 @@ if (ds) {
}
```
### mounted
- **参数:**
- `{DataSource} ds` 单个数据源实例(必填)
- **返回:**
- `{Promise<void>}`
- **详情:**
页面渲染完成后执行单个数据源的 `mounted`:先调用 `ds.mounted()`,再依次执行 `methods``timing === 'mounted'` 的方法。当 `ds.isMounted``true`,或当前 `app.jsEngine` 命中 `ds.schema.disabledInitInJsEngine` 时直接跳过。
一般不需要手动调用runtime 在顶层组件渲染完成后触发 `mounted` 事件,由 manager 统一对所有数据源调用该方法。
- **示例:**
```typescript
// runtime 顶层组件渲染完成后
app.dataSourceManager?.emit('mounted');
```
### get
- **参数:**
@ -206,7 +184,7 @@ const ds = dataSourceManager.addDataSource({
- **详情:**
同步更新数据源 DSL 配置:先按 `id` 移除已有数据源,再以 `cloneDeep` 重新 `addDataSource`,并对新建实例触发 `init`(异步执行,不会被该方法 `await`;若此时 `isMounted` 已为 `true``init` 完成后还会补充执行 `mounted`。一般在编辑器中修改配置后调用。
同步更新数据源 DSL 配置:先按 `id` 移除已有数据源,再以 `cloneDeep` 重新 `addDataSource`,并对新建实例触发 `init`(异步执行,不会被该方法 `await`)。一般在编辑器中修改配置后调用。
### compiledNode
@ -347,7 +325,6 @@ DataSourceManager 继承自 EventEmitter支持以下事件
|--------|------|----------|
| `change` | 单个数据源数据变化 | `(dsId: string, changeEvent: ChangeEvent)` |
| `init` | 所有数据源初始化完成;现代分支携带 `(data, errors)`,旧 Promise.all 分支为 `(this.data)` | `(data, errors?)` |
| `mounted` | 由 runtime 在顶层组件渲染完成后触发manager 收到后统一执行各数据源的 `mounted` | 无 |
| `registered-all` | 所有数据源注册完成 | 无 |
| `update-data` | 由 `createDataSourceManager` 在数据变化后发出,用于通知节点重新渲染 | `(newNodes: MNode[], sourceId: string, changeEvent: ChangeEvent, pageId: Id)` |

View File

@ -22,7 +22,7 @@ export default {
['^(@tencent)(/.*|$)'],
['^(@tmagic)(/.*|$)'],
// Internal packages.
['^(@|src|editor-page|@editor|@form|@data-source)(/.*|$)'],
['^(@|src|editor-page|@editor|@data-source)(/.*|$)'],
// Side effect imports.
['^\\u0000'],
// Parent imports. Put `..` last.

View File

@ -1,6 +1,6 @@
{
"name": "@tmagic/eslint-config",
"version": "0.1.1",
"version": "0.1.0",
"main": "index.mjs",
"type": "module",
"repository": {
@ -10,17 +10,17 @@
},
"dependencies": {
"@eslint/js": "^10.0.1",
"@typescript-eslint/parser": "^8.58.0",
"@typescript-eslint/eslint-plugin": "^8.58.0",
"@stylistic/eslint-plugin": "^5.10.0",
"@typescript-eslint/eslint-plugin": "^8.66.0",
"@typescript-eslint/parser": "^8.66.0",
"eslint-config-prettier": "^10.1.8",
"eslint-plugin-import": "^2.32.0",
"eslint-plugin-prettier": "^5.5.6",
"eslint-plugin-simple-import-sort": "^14.0.0",
"eslint-plugin-vue": "^10.10.0",
"globals": "^17.9.0",
"typescript-eslint": "^8.66.0",
"vue-eslint-parser": "^10.4.1"
"eslint-plugin-simple-import-sort": "^13.0.0",
"eslint-plugin-vue": "^10.8.0",
"vue-eslint-parser": "^10.4.0",
"eslint-plugin-prettier": "^5.5.5",
"globals": "^17.4.0",
"typescript-eslint": "^8.58.0"
},
"peerDependencies": {
"eslint": ">=10.0.0",

View File

@ -1,12 +1,12 @@
{
"version": "1.8.0-beta.27",
"version": "1.8.0-beta.16",
"name": "tmagic",
"private": true,
"type": "module",
"packageManager": "pnpm@11.21.0",
"packageManager": "pnpm@10.33.4",
"scripts": {
"bootstrap": "pnpm i && pnpm build",
"clean:top": "rimraf packages/*/dist packages/*/types runtime/*/dist runtime/*/types vue-components/*/dist vue-components/*/types react-components/*/dist react-components/*/types playground/dist coverage dwt* temp packages/cli/lib",
"clean:top": "rimraf */**/dist */**/types */dist coverage dwt* temp packages/cli/lib",
"clean:modules": "rimraf node_modules **/node_modules **/**/node_modules",
"clean:all": "pnpm clean:top && pnpm clean:modules",
"lint": "eslint --cache .",
@ -15,8 +15,7 @@
"pg": "pnpm playground",
"playground:react": "pnpm --filter \"runtime-react\" build:libs && pnpm --filter \"runtime-react\" --filter \"tmagic-playground\" dev:react",
"pg:react": "pnpm playground:react",
"build": "pnpm build:dts && node scripts/build.mjs && pnpm check:headless",
"check:headless": "node scripts/check-headless-dist.mjs",
"build": "pnpm build:dts && node scripts/build.mjs",
"build:dts": "pnpm --filter \"@tmagic/cli\" build && tsc -p tsconfig.build-browser.json && vue-tsc --declaration --emitDeclarationOnly --project tsconfig.build-vue.json && rolldown -c rolldown.dts.config.mjs && rimraf temp",
"check:type": "node scripts/check-type.mjs",
"build:playground": "pnpm --filter \"runtime-vue\" build && pnpm --filter \"tmagic-playground\" build",
@ -25,7 +24,7 @@
"docs:build": "vitepress build docs",
"reinstall": "pnpm clean:all && pnpm bootstrap",
"test": "vitest run",
"coverage": "vitest run --coverage && node scripts/check-coverage.mjs",
"coverage": "vitest run --coverage",
"prepare": "husky",
"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
"release": "node scripts/release.mjs"
@ -41,44 +40,44 @@
"url": "https://github.com/Tencent/tmagic-editor.git"
},
"devDependencies": {
"@commitlint/cli": "^21.2.1",
"@commitlint/config-conventional": "^21.2.0",
"@commitlint/cli": "^20.5.3",
"@commitlint/config-conventional": "^20.5.3",
"@tmagic/eslint-config": "workspace:*",
"@types/node": "26.1.2",
"@types/node": "24.0.10",
"@vitejs/plugin-vue": "^6.0.8",
"@vitest/coverage-v8": "^4.1.10",
"@vue/compiler-sfc": "catalog:",
"c8": "^12.0.0",
"c8": "^10.1.3",
"commitizen": "^4.3.2",
"conventional-changelog-cli": "^5.0.0",
"cosmiconfig": "^10.0.0",
"cosmiconfig": "^9.0.2",
"cz-conventional-changelog": "^3.3.0",
"element-plus": "catalog:",
"element-plus": "^2.14.3",
"enquirer": "^2.4.1",
"eslint": "^10.8.1",
"execa": "^10.0.1",
"happy-dom": "^20.11.2",
"eslint": "^10.7.0",
"execa": "^9.6.1",
"happy-dom": "^20.10.6",
"highlight.js": "^11.11.1",
"husky": "^9.1.7",
"jsdom": "^30.0.1",
"lint-staged": "^17.3.0",
"jsdom": "^27.4.0",
"lint-staged": "^16.4.0",
"minimist": "^1.2.8",
"picocolors": "^1.1.1",
"prettier": "^3.9.6",
"recast": "^0.23.20",
"rimraf": "^6.1.3",
"rolldown": "^1.2.3",
"rolldown-plugin-dts": "^0.28.1",
"prettier": "^3.9.5",
"recast": "^0.23.12",
"rimraf": "^3.0.2",
"rolldown": "^1.2.0",
"rolldown-plugin-dts": "^0.26.0",
"sass-embedded": "^1.100.0",
"semver": "^7.8.5",
"serialize-javascript": "^7.1.0",
"shx": "^0.4.0",
"serialize-javascript": "^7.0.7",
"shx": "^0.3.4",
"typescript": "catalog:",
"vite": "catalog:",
"vitepress": "2.0.0-alpha.19",
"vitepress": "2.0.0-alpha.18",
"vitest": "^4.1.10",
"vue": "^3.5.41",
"vue-tsc": "^3.3.9"
"vue": "catalog:",
"vue-tsc": "^3.3.7"
},
"config": {
"commitizen": {

View File

@ -1,6 +1,6 @@
#!/usr/bin/env node
import { cli } from '../lib/index.js';
const { cli } = require('../lib');
cli({
source: process.cwd(),

View File

@ -1,12 +1,11 @@
{
"version": "1.8.0-beta.27",
"version": "1.8.0-beta.16",
"name": "@tmagic/cli",
"type": "module",
"main": "lib/index.js",
"types": "lib/index.d.ts",
"license": "Apache-2.0",
"scripts": {
"build": "pnpm clean && rolldown -c rolldown.config.mjs",
"build": "pnpm clean && tsc -b tsconfig.build.json",
"clean": "rimraf lib *.tsbuildinfo",
"check:type": "tsc --noEmit --project tsconfig.build.json"
},
@ -27,18 +26,25 @@
"url": "https://github.com/Tencent/tmagic-editor.git"
},
"dependencies": {
"cac": "^7.0.0",
"chokidar": "^5.0.0",
"fs-extra": "^11.4.0",
"cac": "^6.7.14",
"chokidar": "^3.6.0",
"esbuild": "^0.21.5",
"fs-extra": "^11.2.0",
"merge-options": "^3.0.4",
"picocolors": "^1.1.1",
"recast": "^0.23.19",
"typescript": "catalog:"
"recast": "^0.23.11",
"tslib": "^2.8.0"
},
"devDependencies": {
"@types/fs-extra": "^11.0.4",
"@types/node": "^26.1.2",
"rolldown": "^1.2.2",
"rolldown-plugin-dts": "^0.28.0"
"@types/node": "^24.0.10"
},
"peerDependencies": {
"typescript": "catalog:"
},
"peerDependenciesMeta": {
"typescript": {
"optional": true
}
}
}

View File

@ -1,36 +0,0 @@
import { builtinModules, createRequire } from 'node:module';
import { defineConfig } from 'rolldown';
import { dts } from 'rolldown-plugin-dts';
const require = createRequire(import.meta.url);
const packageJson = require('./package.json');
const externalPackages = new Set([
...builtinModules,
...Object.keys(packageJson.dependencies ?? {}),
...Object.keys(packageJson.peerDependencies ?? {}),
]);
export default defineConfig({
input: 'src/index.ts',
plugins: [dts()],
external: (id) => {
if (id.startsWith('node:') || externalPackages.has(id)) {
return true;
}
for (const packageName of externalPackages) {
if (id.startsWith(`${packageName}/`)) {
return true;
}
}
return false;
},
output: {
dir: 'lib',
format: 'es',
sourcemap: false,
},
codeSplitting: false,
});

View File

@ -4,10 +4,10 @@ import fs from 'fs-extra';
import { prepareEntryFile } from './utils/prepareEntryFile';
import { resolveAppPackages } from './utils/resolveAppPackages';
import { require } from './require';
import { ModuleMainFilePath, UserConfig } from './types';
export default class Core {
// eslint-disable-next-line @typescript-eslint/no-require-imports
public version = require('../package.json').version;
public options: UserConfig;

View File

@ -4,7 +4,6 @@ import { allowTs } from './utils/allowTs';
import { error } from './utils/logger';
import { scripts } from './commands';
import App from './Core';
import { require } from './require';
import { UserConfig } from './types';
/**
@ -30,7 +29,7 @@ export const cli = (defaultAppConfig: UserConfig): void => {
const program = cac('tmagic');
// display core version and cli version
// eslint-disable-next-line @typescript-eslint/no-require-imports
const versionCli = require('../package.json').version;
program.version(`tmagic/cli@${versionCli}`);

View File

@ -1,9 +0,0 @@
import { createRequire } from 'node:module';
/**
* CJS `require()` in an ESM context, shared by the whole CLI so that
* `allowTs`'s `.ts` loader also applies to `loadUserConfig` requires.
* Bound to the package `src/` directory, so paths like `../package.json`
* resolve to the package root as before.
*/
export const require = createRequire(import.meta.url);

View File

@ -1,27 +1,23 @@
import { transformSync } from 'esbuild';
import fs from 'fs-extra';
import ts from 'typescript';
import { require } from '../require';
/**
* Transform a ts file to cjs code
*/
export const transformTsFileToCodeSync = (filename: string): string =>
ts.transpileModule(fs.readFileSync(filename).toString(), {
compilerOptions: {
inlineSourceMap: true,
inlineSources: true,
module: ts.ModuleKind.CommonJS,
target: ts.ScriptTarget.ES2022,
},
fileName: filename,
}).outputText;
transformSync(fs.readFileSync(filename).toString(), {
format: 'cjs',
loader: 'ts',
sourcefile: filename,
sourcemap: 'inline',
target: 'node18',
}).code;
/**
* Globally allow ts files to be loaded via `require()`
*/
export const allowTs = (): void => {
require.extensions['.ts'] = (m: any, filename: string) => {
require.extensions['.ts'] = (m: any, filename) => {
m._compile(transformTsFileToCodeSync(filename), filename);
};
};

View File

@ -1,4 +1,3 @@
import { require } from '../require';
import { UserConfig, UserConfigLoader } from '../types';
export const isPlainObject = <T extends Record<any, any> = Record<any, any>>(val: unknown): val is T =>
@ -11,6 +10,7 @@ export const hasExportDefault = <T = any>(mod: unknown): mod is { default: T } =
isPlainObject(mod) && !!mod.__esModule && Object.prototype.hasOwnProperty.call(mod, 'default');
export const loadUserConfigCjs: UserConfigLoader = async (userConfigPath) => {
// eslint-disable-next-line @typescript-eslint/no-require-imports
const required = require(userConfigPath);
return hasExportDefault(required) ? required.default : required;
};

View File

@ -1,7 +1,6 @@
import * as recast from 'recast';
import type App from '../Core';
import { require } from '../require';
import { EntryType } from '../types';
export const prepareEntryFile = async (app: App) => {
@ -139,6 +138,7 @@ export const generateContent = (
};
export const prettyCode = (code: string) =>
// eslint-disable-next-line @typescript-eslint/no-require-imports
recast.prettyPrint(recast.parse(code.replace(/\\/g, '/'), { parser: require('recast/parsers/typescript') }), {
tabWidth: 2,
trailingComma: true,

View File

@ -2,11 +2,10 @@ import { execSync } from 'node:child_process';
import path from 'node:path';
import { exit } from 'node:process';
import fs from 'fs-extra';
import fs, { existsSync } from 'fs-extra';
import * as recast from 'recast';
import type App from '../Core';
import { require } from '../require';
import { EntryType, ModuleMainFilePath, NpmConfig, PackageType } from '../types';
import { backupLock, backupPackageJson, restoreLock, restorePackageJson } from './backupPackageFile';
@ -128,7 +127,7 @@ const typeAssertion = function ({
if (isFile(defaultFile)) {
const defaultCode = fs.readFileSync(defaultFile, { encoding: 'utf-8', flag: 'r' });
// eslint-disable-next-line @typescript-eslint/no-require-imports
const ast = recast.parse(defaultCode, { parser: require('recast/parsers/typescript') });
if (
isDatasource(
@ -295,7 +294,7 @@ const getComponentPackageImports = function ({
if (propertyMatch) {
let file = getIndexPath(path.resolve(path.dirname(indexPath), propertyMatch.source.value));
if (!fs.existsSync(file)) {
if (!existsSync(file)) {
file = propertyMatch.source.value;
}
@ -519,7 +518,7 @@ const setPackages = (packages: ModuleMainFilePath, app: App, packagePath: string
.replace('\n', '');
const indexCode = fs.readFileSync(indexPath, { encoding: 'utf-8', flag: 'r' });
// eslint-disable-next-line @typescript-eslint/no-require-imports
const ast: Ast = recast.parse(indexCode, { parser: require('recast/parsers/typescript') });
const result = typeAssertion({ ast, indexPath, componentFileAffix, datasoucreSuperClass });

View File

@ -2,10 +2,12 @@
"extends": "../../tsconfig.json",
"compilerOptions": {
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
"moduleResolution": "bundler",
"module": "ESNext",
"moduleResolution": "node16",
"module": "node16",
"rootDir": "./src",
"outDir": "./lib",
"declaration": true,
"types": ["node"],
},
"include": ["./src"],

View File

@ -1,5 +1,5 @@
{
"version": "1.8.0-beta.27",
"version": "1.8.0-beta.16",
"name": "@tmagic/core",
"type": "module",
"sideEffects": false,
@ -39,11 +39,11 @@
"@tmagic/schema": "workspace:*",
"@tmagic/utils": "workspace:*",
"events": "^3.3.0",
"lodash-es": "^4.18.1"
"lodash-es": "^4.17.21"
},
"devDependencies": {
"@types/events": "^3.0.3",
"@types/lodash-es": "^4.17.12"
"@types/lodash-es": "^4.17.4"
},
"peerDependencies": {
"typescript": "catalog:"

View File

@ -341,20 +341,6 @@ describe('App 配置/方法/组件注册', () => {
expect(app.page).toBeUndefined();
});
test('deletePage 销毁当前 page', () => {
const app = new App({
config: {
type: NodeType.ROOT,
id: 'app',
items: [{ type: NodeType.PAGE, id: 'p1', items: [] }],
},
});
expect(app.page?.data.id).toBe('p1');
app.deletePage();
expect(app.page).toBeUndefined();
});
test('runCode 执行代码块', async () => {
const fn = vi.fn();
const app = new App({

View File

@ -1,5 +1,5 @@
{
"version": "1.8.0-beta.27",
"version": "1.8.0-beta.16",
"name": "@tmagic/data-source",
"type": "module",
"sideEffects": false,
@ -32,9 +32,9 @@
"data-source"
],
"dependencies": {
"deep-state-observer": "^5.5.17",
"deep-state-observer": "^5.5.13",
"events": "^3.3.0",
"lodash-es": "^4.18.1"
"lodash-es": "^4.17.21"
},
"peerDependencies": {
"@tmagic/core": "workspace:*",
@ -47,6 +47,6 @@
},
"devDependencies": {
"@types/events": "^3.0.3",
"@types/lodash-es": "^4.17.12"
"@types/lodash-es": "^4.17.4"
}
}

View File

@ -57,7 +57,7 @@ class DataSourceManager extends EventEmitter {
for (let config = list.shift(); config; config = list.shift()) {
const ds = app.addDataSource(config);
if (ds) {
app.initAndMount(ds);
app.init(ds);
}
}
});
@ -84,8 +84,6 @@ class DataSourceManager extends EventEmitter {
public data: DataSourceManagerData = {};
public initialData: DataSourceManagerData = {};
public useMock?: boolean = false;
/** 页面是否已经渲染完成 */
public isMounted = false;
constructor({ app, useMock, initialData }: DataSourceManagerOptions) {
super();
@ -111,12 +109,6 @@ class DataSourceManager extends EventEmitter {
this.callDsInit();
});
}
// 由runtime在顶层组件渲染完成后触发
this.on('mounted', () => {
this.isMounted = true;
this.callDsMounted();
});
}
public async init(ds: DataSource) {
@ -145,29 +137,6 @@ class DataSourceManager extends EventEmitter {
}
}
/**
* mounted
* @param {DataSource} ds
*/
public async mounted(ds: DataSource) {
if (ds.isMounted) {
return;
}
if (this.app.jsEngine && ds.schema.disabledInitInJsEngine?.includes(this.app.jsEngine)) {
return;
}
await ds.mounted?.();
for (const method of ds.methods) {
if (typeof method.content !== 'function') return;
if (method.timing === 'mounted') {
await method.content({ params: {}, dataSource: ds, app: this.app });
}
}
}
public get(id: string) {
return this.dataSourceMap.get(id);
}
@ -250,7 +219,7 @@ class DataSourceManager extends EventEmitter {
this.addDataSource(cloneDeep(schema));
const newDs = this.get(schema.id);
if (newDs) {
this.initAndMount(newDs);
this.init(newDs);
}
}
}
@ -421,28 +390,6 @@ class DataSourceManager extends EventEmitter {
});
}
}
private callDsMounted() {
const promises = Array.from(this.dataSourceMap).map(([, ds]) => this.mounted(ds));
if (typeof Promise.allSettled === 'function') {
return Promise.allSettled(promises);
}
return Promise.all(promises.map((promise) => promise.catch(() => undefined)));
}
/**
* mounted
* @param {DataSource} ds
*/
private async initAndMount(ds: DataSource) {
await this.init(ds);
if (this.isMounted) {
await this.mounted(ds);
}
}
}
export default DataSourceManager;

View File

@ -31,7 +31,6 @@ import type { ChangeEvent, DataSourceOptions } from '@data-source/types';
*/
export default class DataSource<T extends DataSourceSchema = DataSourceSchema> extends EventEmitter {
public isInit = false;
public isMounted = false;
/** @tmagic/core 实例 */
public app: TMagicApp;
@ -153,13 +152,6 @@ export default class DataSource<T extends DataSourceSchema = DataSourceSchema> e
this.isInit = true;
}
/**
* DataSourceManager mounted
*/
public async mounted() {
this.isMounted = true;
}
public destroy() {
this.#fields = [];
this.removeAllListeners();

View File

@ -7,7 +7,8 @@ import {
DATA_SOURCE_FIELDS_SELECT_VALUE_PREFIX,
dataSourceTemplateRegExp,
getValueByKeyPath,
isPageOrFragment,
isPage,
isPageFragment,
NODE_CONDS_KEY,
replaceChildNode,
} from '@tmagic/core';
@ -67,7 +68,7 @@ export const compliedConditions = (node: { [NODE_CONDS_KEY]?: DisplayCond[] }, d
};
export const updateNode = (node: MNode, dsl: MApp) => {
if (isPageOrFragment(node)) {
if (isPage(node) || isPageFragment(node)) {
const index = dsl.items?.findIndex((child: MNode) => child.id === node.id);
dsl.items.splice(index, 1, node as MPage | MPageFragment);
} else {

View File

@ -38,25 +38,6 @@ describe('DataSource', () => {
expect(ds.isInit).toBeTruthy();
});
test('mounted', async () => {
const ds = new DataSource({
schema: {
type: 'base',
id: '1',
fields: [{ name: 'name' }],
methods: [],
events: [],
},
app: new App({}),
});
expect(ds.isMounted).toBe(false);
await ds.mounted();
expect(ds.isMounted).toBe(true);
});
});
describe('DataSource setData', () => {

View File

@ -302,227 +302,6 @@ describe('DataSourceManager - init 生命周期', () => {
});
});
describe('DataSourceManager - mounted 生命周期', () => {
afterEach(() => {
DataSourceManager.clearDataSourceClass();
});
// 等待 mounted 事件触发的异步流程执行完
const flush = () => new Promise<void>((resolve) => setTimeout(resolve, 0));
const createApp = (id: string, dataSources: any[] = [], jsEngine?: any) =>
new TMagicApp({
...(jsEngine ? { jsEngine } : {}),
config: {
type: NodeType.ROOT,
id,
items: [],
dataSources,
},
} as any);
test('mounted 事件会统一执行所有数据源的 mounted', async () => {
const app = createApp('app_mounted', [
{ type: 'base', id: 'ds_m1', fields: [], methods: [], events: [] },
{ type: 'base', id: 'ds_m2', fields: [], methods: [], events: [] },
]);
const dsm = new DataSourceManager({ app });
expect(dsm.isMounted).toBe(false);
expect(dsm.get('ds_m1')?.isMounted).toBe(false);
dsm.emit('mounted');
await flush();
expect(dsm.isMounted).toBe(true);
expect(dsm.get('ds_m1')?.isMounted).toBe(true);
expect(dsm.get('ds_m2')?.isMounted).toBe(true);
});
test('methods 中 timing=mounted 的 content 会在 ds.mounted 之后调用', async () => {
const app = createApp('app_mounted_method');
const dsm = new DataSourceManager({ app });
const order: string[] = [];
const mountedContent = vi.fn(() => {
order.push('method');
});
const ds = new DataSource({
app,
schema: {
type: 'base',
id: 'ds_mounted_method',
fields: [],
events: [],
methods: [{ name: 'onMounted', content: mountedContent, timing: 'mounted', params: [] }],
} as any,
});
const origMounted = ds.mounted.bind(ds);
ds.mounted = async () => {
order.push('mounted');
await origMounted();
};
await dsm.mounted(ds);
expect(mountedContent).toHaveBeenCalledTimes(1);
const arg = mountedContent.mock.calls[0][0] as any;
expect(arg.dataSource).toBe(ds);
expect(arg.app).toBe(app);
expect(order).toEqual(['mounted', 'method']);
});
test('ds.isMounted 为 true 时直接跳过', async () => {
const app = createApp('app_mounted_skip');
const dsm = new DataSourceManager({ app });
const content = vi.fn();
const ds = new DataSource({
app,
schema: {
type: 'base',
id: 'ds_mounted_skip',
fields: [],
events: [],
methods: [{ name: 'onMounted', content, timing: 'mounted', params: [] }],
} as any,
});
await dsm.mounted(ds);
await dsm.mounted(ds);
expect(content).toHaveBeenCalledTimes(1);
});
test('jsEngine 命中 disabledInitInJsEngine 时跳过 mounted', async () => {
const app = createApp('app_mounted_disabled', [], 'nodejs');
const dsm = new DataSourceManager({ app });
const ds = new DataSource({
app,
schema: {
type: 'base',
id: 'ds_mounted_disabled',
fields: [],
methods: [],
events: [],
disabledInitInJsEngine: ['nodejs'],
} as any,
});
await dsm.mounted(ds);
expect(ds.isMounted).toBe(false);
});
test('method.content 非函数时提前返回', async () => {
const app = createApp('app_mounted_bad');
const dsm = new DataSourceManager({ app });
const content = vi.fn();
const ds = new DataSource({
app,
schema: {
type: 'base',
id: 'ds_mounted_bad',
fields: [],
events: [],
methods: [
{ name: 'bad', content: 'not-a-function', timing: 'mounted', params: [] } as any,
{ name: 'onMounted', content, timing: 'mounted', params: [] } as any,
],
} as any,
});
await dsm.mounted(ds);
expect(ds.isMounted).toBe(true);
expect(content).not.toHaveBeenCalled();
});
test('mounted 抛错时不会产生未处理的异常', async () => {
const mountedSpy = vi.spyOn(DataSource.prototype, 'mounted').mockRejectedValue(new Error('mounted-boom'));
try {
const app = createApp('app_mounted_err', [{ type: 'base', id: 'ds_me', fields: [], methods: [], events: [] }]);
const dsm = new DataSourceManager({ app });
dsm.emit('mounted');
await flush();
expect(dsm.isMounted).toBe(true);
} finally {
mountedSpy.mockRestore();
}
});
test('Promise.allSettled 不可用时走 Promise.all 兼容分支', async () => {
const original = Promise.allSettled;
(Promise as any).allSettled = undefined;
const mountedSpy = vi.spyOn(DataSource.prototype, 'mounted').mockRejectedValueOnce(new Error('compat-boom'));
try {
const app = createApp('app_mounted_compat', [
{ type: 'base', id: 'ds_mc1', fields: [], methods: [], events: [] },
{ type: 'base', id: 'ds_mc2', fields: [], methods: [], events: [] },
]);
const dsm = new DataSourceManager({ app });
dsm.emit('mounted');
await flush();
expect(mountedSpy).toHaveBeenCalledTimes(2);
expect(dsm.get('ds_mc2')?.isMounted).toBe(true);
} finally {
(Promise as any).allSettled = original;
mountedSpy.mockRestore();
}
});
test('页面渲染后注册的数据源类型会在 init 之后补充执行 mounted', async () => {
const app = createApp('app_mounted_register', [
{ type: 'mounted-late', id: 'ds_late', fields: [], methods: [], events: [] },
]);
const dsm = new DataSourceManager({ app });
expect(dsm.get('ds_late')).toBeUndefined();
dsm.emit('mounted');
await flush();
class LateDataSource extends DataSource {}
DataSourceManager.register('mounted-late', LateDataSource as any);
await flush();
expect(dsm.get('ds_late')?.isInit).toBe(true);
expect(dsm.get('ds_late')?.isMounted).toBe(true);
});
test('页面渲染后 updateSchema 重建的数据源会执行 mounted', async () => {
const app = createApp('app_mounted_update', [
{ type: 'base', id: 'ds_up', fields: [{ name: 'a' }], methods: [], events: [] },
]);
const dsm = new DataSourceManager({ app });
dsm.emit('mounted');
await flush();
dsm.updateSchema([{ type: 'base', id: 'ds_up', fields: [{ name: 'b' }], methods: [], events: [] }]);
await flush();
expect(dsm.get('ds_up')?.isMounted).toBe(true);
});
test('页面未渲染时 updateSchema 不会执行 mounted', async () => {
const app = createApp('app_update_not_mounted', [
{ type: 'base', id: 'ds_nm', fields: [{ name: 'a' }], methods: [], events: [] },
]);
const dsm = new DataSourceManager({ app });
dsm.updateSchema([{ type: 'base', id: 'ds_nm', fields: [{ name: 'b' }], methods: [], events: [] }]);
await flush();
expect(dsm.get('ds_nm')?.isInit).toBe(true);
expect(dsm.get('ds_nm')?.isMounted).toBe(false);
});
});
describe('DataSourceManager - addDataSource 边界', () => {
afterEach(() => {
DataSourceManager.clearDataSourceClass();

View File

@ -1,5 +1,5 @@
{
"version": "1.8.0-beta.27",
"version": "1.8.0-beta.16",
"name": "@tmagic/dep",
"type": "module",
"sideEffects": false,

View File

@ -1,6 +1,6 @@
import type { DepData } from '@tmagic/schema';
import { DepTargetType, type IsTarget, type TargetDescriptor, type TargetOptions } from './types';
import { DepTargetType, type IsTarget, type TargetOptions } from './types';
export interface DepUpdateOptions {
id: string | number;
@ -40,17 +40,12 @@ export default class Target {
* truefalse时需要传入type参数给collect方法才会被收集
*/
public isCollectByDefault?: boolean;
/**
* target worker 线
*/
public descriptor?: TargetDescriptor;
constructor(options: TargetOptions) {
this.isTarget = options.isTarget;
this.id = options.id;
this.name = options.name;
this.isCollectByDefault = options.isCollectByDefault ?? true;
this.descriptor = options.descriptor;
if (options.type) {
this.type = options.type;
}

View File

@ -1,4 +1,4 @@
import type { CodeBlockContent, DataSourceSchema, DepData, Id } from '@tmagic/schema';
import type { DepData } from '@tmagic/schema';
import type Target from './Target';
@ -17,30 +17,6 @@ export enum DepTargetType {
export type IsTarget = (key: string | number, value: any, data?: Record<string, any>) => boolean;
/** 创建代码块 target 只需要名称Record 用于兼容直接传入完整代码块 */
export type CodeBlockName = Pick<CodeBlockContent, 'name'> & Record<string, any>;
/**
* target
*
* isTarget 线
* / target worker
* target 线
*
* isTarget
* - CODE_BLOCK: id + name
* - DATA_SOURCE / DATA_SOURCE_COND: id + fields type /
* - DATA_SOURCE_METHOD: id + / content
*/
export type TargetDescriptor =
| { type: DepTargetType.CODE_BLOCK; id: Id; codeBlock: CodeBlockName }
| { type: DepTargetType.DATA_SOURCE; ds: Pick<DataSourceSchema, 'id' | 'fields'> }
| { type: DepTargetType.DATA_SOURCE_COND; ds: Pick<DataSourceSchema, 'id' | 'fields'> }
| {
type: DepTargetType.DATA_SOURCE_METHOD;
ds: { id: Id; methods: Array<{ name?: string }>; fields: Array<{ name?: string }> };
};
export interface TargetOptions {
isTarget: IsTarget;
id: string | number;
@ -50,8 +26,6 @@ export interface TargetOptions {
initialDeps?: DepData;
/** 是否默认收集默认为true当值为false时需要传入type参数给collect方法才会被收集 */
isCollectByDefault?: boolean;
/** 可序列化描述,用于在 worker 中重建该 target */
descriptor?: TargetDescriptor;
}
export interface TargetList {

View File

@ -1,4 +1,5 @@
import {
type CodeBlockContent,
type DataSchema,
type DataSourceSchema,
type DepData,
@ -15,17 +16,16 @@ import {
} from '@tmagic/utils';
import Target from './Target';
import { type CodeBlockName, DepTargetType, type TargetDescriptor, type TargetList } from './types';
import { DepTargetType, type TargetList } from './types';
const INTEGER_REGEXP = /^\d+$/;
export const createCodeBlockTarget = (id: Id, codeBlock: CodeBlockName, initialDeps: DepData = {}) =>
export const createCodeBlockTarget = (id: Id, codeBlock: CodeBlockContent, initialDeps: DepData = {}) =>
new Target({
type: DepTargetType.CODE_BLOCK,
id,
initialDeps,
name: codeBlock.name,
descriptor: { type: DepTargetType.CODE_BLOCK, id, codeBlock: { name: codeBlock.name } },
isTarget: (_key: string | number, value: any) => {
if (id === value) {
return true;
@ -238,8 +238,6 @@ export const createDataSourceTarget = (ds: Pick<DataSourceSchema, 'id' | 'fields
type: DepTargetType.DATA_SOURCE,
id: ds.id,
initialDeps,
// isTarget 需要完整 fields 结构(含 type / 嵌套 fields但不必带上 methods 等无关字段
descriptor: { type: DepTargetType.DATA_SOURCE, ds: { id: ds.id, fields: ds.fields || [] } },
isTarget: (key: string | number, value: any) => isDataSourceTarget(ds, key, value),
});
@ -248,8 +246,6 @@ export const createDataSourceCondTarget = (ds: Pick<DataSourceSchema, 'id' | 'fi
type: DepTargetType.DATA_SOURCE_COND,
id: ds.id,
initialDeps,
// 与 DATA_SOURCE 相同,只序列化 isTarget 所需的 id + fields
descriptor: { type: DepTargetType.DATA_SOURCE_COND, ds: { id: ds.id, fields: ds.fields || [] } },
isTarget: (key: string | number, value: any) => isDataSourceCondTarget(ds, key, value),
});
@ -261,15 +257,6 @@ export const createDataSourceMethodTarget = (
type: DepTargetType.DATA_SOURCE_METHOD,
id: ds.id,
initialDeps,
// isTarget 只用方法名/字段名,不序列化 content 等函数,降低 idle 收集通信成本
descriptor: {
type: DepTargetType.DATA_SOURCE_METHOD,
ds: {
id: ds.id,
methods: (ds.methods || []).map((method) => ({ name: method.name })),
fields: (ds.fields || []).map((field) => ({ name: field.name })),
},
},
isTarget: (_key: string | number, value: any) => {
// 使用data-source-method-select 可以配置出来
if (!Array.isArray(value)) {
@ -295,31 +282,6 @@ export const createDataSourceMethodTarget = (
},
});
/**
* target使 worker
* @param descriptor target
* @param initialDeps
* @returns Target
*/
export const createTargetByDescriptor = (descriptor: TargetDescriptor, initialDeps: DepData = {}): Target => {
switch (descriptor.type) {
case DepTargetType.CODE_BLOCK:
return createCodeBlockTarget(descriptor.id, descriptor.codeBlock, initialDeps);
case DepTargetType.DATA_SOURCE:
return createDataSourceTarget(descriptor.ds, initialDeps);
case DepTargetType.DATA_SOURCE_COND:
return createDataSourceCondTarget(descriptor.ds, initialDeps);
case DepTargetType.DATA_SOURCE_METHOD:
// descriptor 只保留名称,对 isTarget 已足够;重建时按同样结构传入
return createDataSourceMethodTarget(
descriptor.ds as Pick<DataSourceSchema, 'id' | 'methods' | 'fields'>,
initialDeps,
);
default:
throw new Error(`unknown target descriptor: ${JSON.stringify(descriptor)}`);
}
};
export const traverseTarget = (
targetsList: TargetList,
cb: (target: Target) => void,

View File

@ -266,65 +266,6 @@ describe('utils', () => {
expect(t3.isTarget('k', ['ds_1', 'unknown'])).toBe(true);
});
test('内置 target 带可序列化描述,可在 worker 中重建', () => {
const ds = { id: 'ds_1', fields: [{ name: 'name' }] as DataSchema[] };
expect(utils.createCodeBlockTarget('code_1', { name: 'fn', content: () => false, params: [] }).descriptor).toEqual({
type: DepTargetType.CODE_BLOCK,
id: 'code_1',
codeBlock: { name: 'fn' },
});
const dsWithMethods = {
...ds,
methods: [{ name: 'load', content: () => undefined, params: [] } as any],
};
// DATA_SOURCE / COND 只带 id + fields不透传完整数据源对象
expect(utils.createDataSourceTarget(dsWithMethods).descriptor).toEqual({
type: DepTargetType.DATA_SOURCE,
ds: { id: 'ds_1', fields: ds.fields },
});
expect(utils.createDataSourceCondTarget(dsWithMethods).descriptor).toEqual({
type: DepTargetType.DATA_SOURCE_COND,
ds: { id: 'ds_1', fields: ds.fields },
});
// METHOD 描述只保留名称,不带 content 等函数
expect(utils.createDataSourceMethodTarget(dsWithMethods).descriptor).toEqual({
type: DepTargetType.DATA_SOURCE_METHOD,
ds: { id: 'ds_1', methods: [{ name: 'load' }], fields: [{ name: 'name' }] },
});
// 自定义 target 无法序列化 isTarget因此没有描述
expect(new Target({ id: 'custom', isTarget: () => true }).descriptor).toBeUndefined();
});
test('createTargetByDescriptor 用描述重建出等价的 target', () => {
const ds = { id: 'ds_1', fields: [{ name: 'name' }] as DataSchema[] };
const codeBlockTarget = utils.createTargetByDescriptor({
type: DepTargetType.CODE_BLOCK,
id: 'code_1',
codeBlock: { name: 'fn' },
});
expect(codeBlockTarget.type).toBe(DepTargetType.CODE_BLOCK);
expect(codeBlockTarget.name).toBe('fn');
expect(codeBlockTarget.isTarget('created', 'code_1')).toBe(true);
const dsTarget = utils.createTargetByDescriptor({ type: DepTargetType.DATA_SOURCE, ds });
expect(dsTarget.type).toBe(DepTargetType.DATA_SOURCE);
expect(dsTarget.isTarget('text', '${ds_1.name}')).toBe(true);
const condTarget = utils.createTargetByDescriptor({ type: DepTargetType.DATA_SOURCE_COND, ds });
expect(condTarget.isTarget(`${NODE_CONDS_KEY}_x`, ['ds_1', 'name'])).toBe(true);
const methodTarget = utils.createTargetByDescriptor(
{ type: DepTargetType.DATA_SOURCE_METHOD, ds: { ...ds, methods: [] } },
{ n1: { name: 'n1', keys: ['k'] } },
);
expect(methodTarget.isTarget('k', ['ds_1', 'load'])).toBe(true);
expect(methodTarget.deps.n1.keys).toEqual(['k']);
expect(() => utils.createTargetByDescriptor({ type: 'unknown' } as any)).toThrow();
});
test('traverseTarget 遍历所有 / 指定 type', () => {
const t1 = new Target({ id: '1', isTarget: () => true, type: 'a' });
const t2 = new Target({ id: '2', isTarget: () => true, type: 'b' });

View File

@ -1,5 +1,5 @@
{
"version": "1.8.0-beta.27",
"version": "1.8.0-beta.16",
"name": "@tmagic/design",
"type": "module",
"sideEffects": [
@ -16,11 +16,6 @@
"import": "./dist/es/index.js",
"require": "./dist/tmagic-design.umd.cjs"
},
"./headless": {
"types": "./types/headless.d.ts",
"import": "./dist/es/headless.js",
"require": "./dist/tmagic-design-headless.umd.cjs"
},
"./*": "./*"
},
"files": [

View File

@ -1,9 +1,5 @@
<template>
<component
:is="uiComponent"
:class="['tmagic-design-card', { 'tmagic-design-card--flat': isFlat, 'm-flat-hide-body': isHideBody }]"
v-bind="uiProps"
>
<component :is="uiComponent" :class="['tmagic-design-card', { 'tmagic-design-card--flat': isFlat }]" v-bind="uiProps">
<template #header v-if="$slots.header">
<slot name="header" class="header"></slot>
</template>
@ -34,7 +30,7 @@ const uiComponent = ui?.component || 'el-card';
// `<MEditor>` / `<MForm>` theme `magic-admin`
// `flat=true` `flat`
const isFlat = computed(() => !!props.flat || isGlobalFlat.value);
const isHideBody = computed(() => isFlat.value && props.bodyStyle?.display === 'none');
// `flat` UI el-card / t-card props
// / DOM
const uiProps = computed<CardProps>(() => {

View File

@ -1,11 +1,5 @@
<template>
<!-- ElTooltip ElOnlyChild 要求默认插槽至少有一个真实节点v-if false 时插槽是 Comment会报 no valid child node found -->
<component
v-if="isLegitTooltipTrigger($slots.default?.())"
class="tmagic-design-tooltip"
:is="uiComponent"
v-bind="uiProps"
>
<component class="tmagic-design-tooltip" :is="uiComponent" v-bind="uiProps">
<template #content>
<slot name="content"></slot>
</template>
@ -14,7 +8,7 @@
</template>
<script setup lang="ts">
import { Comment, computed, Fragment, Text, type VNode } from 'vue';
import { computed } from 'vue';
import { getDesignConfig } from './config';
import type { TooltipProps } from './types';
@ -30,30 +24,4 @@ const ui = getDesignConfig('components')?.tooltip;
const uiComponent = ui?.component || 'el-tooltip';
const uiProps = computed<TooltipProps>(() => ui?.props(props) || props);
/** 与 Element Plus `findFirstLegitChild` 对齐Comment / 空文本不算合法 trigger。 */
const isLegitTooltipTrigger = (nodes: VNode[] | undefined): boolean => {
if (!nodes?.length) return false;
for (const child of nodes) {
if (!child) continue;
switch (child.type) {
case Comment:
continue;
case Text: {
const text = typeof child.children === 'string' ? child.children.trim() : '';
if (text) return true;
continue;
}
case Fragment:
if (isLegitTooltipTrigger(child.children as VNode[])) return true;
continue;
default:
return true;
}
}
return false;
};
</script>

View File

@ -1,35 +0,0 @@
/*
* Tencent is pleased to support the open source community by making TMagicEditor available.
*
* Copyright (C) 2025 Tencent. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @fileoverview `@tmagic/design/headless` design
*
* `@tmagic/form/headless`
* ES `@tmagic/design`
* `config` `setDesignConfig`
*
* @module @tmagic/design/headless
*/
export { getDesignConfig, setDesignConfig } from './config';
export {
appendValidateSuggestion,
stripValidateSuggestion,
VALIDATE_SUGGESTION_SEPARATOR,
} from './formValidateMessage';
export type { DesignPluginOptions } from './types';

View File

@ -11,11 +11,7 @@
border-right: 0;
border-radius: 0;
border-bottom: 0;
&.m-flat-hide-body {
.el-card__header {
border-bottom: 0 !important;
}
}
&.m-fields-group-list-item {
margin-bottom: 0;
}
@ -33,10 +29,6 @@
}
}
.m-fields-group-list-footer {
margin-bottom: 4px;
margin-top: 4px;
}
.el-card__body {
padding: 0 16px 0 16px;
// 这里每个form-item应该要有一个16px间距但是除了tbody中的form-item
@ -69,7 +61,7 @@
}
> .el-card__body {
background-color: #fff;
padding-top: 8px;
padding-top: 16px;
}
}
}

View File

@ -1,5 +1,5 @@
{
"version": "1.8.0-beta.27",
"version": "1.8.0-beta.16",
"name": "@tmagic/editor",
"type": "module",
"sideEffects": [
@ -17,11 +17,6 @@
"import": "./dist/es/index.js",
"require": "./dist/tmagic-editor.umd.cjs"
},
"./headless": {
"types": "./types/headless.d.ts",
"import": "./dist/es/headless.js",
"require": "./dist/tmagic-editor-headless.umd.cjs"
},
"./dist/style.css": {
"import": "./dist/style.css",
"require": "./dist/style.css"
@ -64,17 +59,17 @@
"events": "^3.3.0",
"gesto": "^1.19.4",
"keycon": "^1.4.0",
"lodash-es": "^4.18.1",
"lodash-es": "^4.17.21",
"moveable": "^0.53.0",
"serialize-javascript": "^7.0.7",
"sortablejs": "^1.15.7"
"serialize-javascript": "^7.0.0",
"sortablejs": "^1.15.6"
},
"devDependencies": {
"@types/events": "^3.0.3",
"@types/lodash-es": "^4.17.12",
"@types/lodash-es": "^4.17.4",
"@types/serialize-javascript": "^5.0.4",
"@types/sortablejs": "^1.15.9",
"@vue/test-utils": "^2.4.11"
"@vue/test-utils": "^2.4.6"
},
"peerDependencies": {
"@tmagic/core": "workspace:*",

View File

@ -101,6 +101,7 @@
<template #props-panel>
<slot name="props-panel">
<PropsPanel
:extend-state="extendFormState"
:disabled-show-src="disabledShowSrc"
@mounted="propsPanelMountedHandler"
@unmounted="propsPanelUnmountedHandler"
@ -135,13 +136,11 @@
<script lang="ts" setup>
import { EventEmitter } from 'events';
import { computed, provide } from 'vue';
import { computed, provide, ref } from 'vue';
import type { MApp } from '@tmagic/core';
import { M_THEME_KEY } from '@tmagic/design';
import { FORM_CONTEXT_KEY } from '@tmagic/form';
import { useEditorFormContext } from './hooks/use-form-context';
import Framework from './layouts/Framework.vue';
import TMagicNavMenu from './layouts/NavMenu.vue';
import FormPanel from './layouts/props-panel/FormPanel.vue';
@ -219,7 +218,6 @@ const stageOptions: StageOptions = {
containerHighlightClassName: props.containerHighlightClassName,
containerHighlightDuration: props.containerHighlightDuration,
containerHighlightType: props.containerHighlightType,
containerHighlightAddOnly: props.containerHighlightAddOnly,
disabledDragStart: props.disabledDragStart,
renderType: props.renderType,
guidesOptions: props.guidesOptions,
@ -231,6 +229,8 @@ const stageOptions: StageOptions = {
stageOverlayService.set('stageOptions', stageOptions);
const propsPanelRef = ref<InstanceType<typeof FormPanel> | null>(null);
provide('services', services);
provide('codeOptions', props.codeOptions);
@ -238,16 +238,11 @@ provide('stageOptions', stageOptions);
/** 是否启用「属性配置表单校验」联动能力,供 PropsPanel / FormPanel 判断校验失败时是否仍更新节点并记录错误 */
provide(ENABLE_PROPS_FORM_VALIDATE, props.enablePropsFormValidate ?? false);
/**
* 编辑器注入给整棵表单树的业务上下文`services` / `stage`属性面板对比表单
* 侧边栏里的嵌套 MForm 都通过 inject 自动继承
*
* 业务方要追加自己的字段 `<MEditor>` 外层再 `provide(FORM_CONTEXT_KEY, computed(...))`
* 即可配置回调统一通过 `mForm.xxx` 读取
* 把顶层 `extendFormState` 提供给非 PropsPanel 链路上的组件使用例如历史差异对话框 HistoryDiffDialog
* 内部的 CompareForm这样所有依赖业务上下文的表单 filterFunction 都能拿到一致的扩展状态
* PropsPanel 通过 `:extend-state` 显式传入的方式保持等价
*/
provide(
FORM_CONTEXT_KEY,
useEditorFormContext(() => services),
);
provide('extendFormState', props.extendFormState);
// computed provide provide
// props.isLargeStageContainer @tmagic/design/ColorPicker
@ -257,6 +252,12 @@ provide(
'isLargeStageContainer',
computed(() => props.isLargeStageContainer),
);
/**
* 提供 PropsPanel 主属性表单的 formState getter供历史差异弹窗复用
* CompareForm PropsPanel filterFunction 上下文保持一致
*/
provide('getPropsPanelFormState', () => propsPanelRef.value?.configForm?.formState);
/**
* 把历史记录面板的自定义扩展 tab 提供给深层的 HistoryListPanel它挂在 NavMenu
* markRaw component 形式渲染无法直接通过 props 透传业务方可借此在历史记录
@ -277,9 +278,11 @@ provide(
);
const propsPanelMountedHandler = (e: InstanceType<typeof FormPanel>) => {
propsPanelRef.value = e;
emit('props-panel-mounted', e);
};
const propsPanelUnmountedHandler = () => {
propsPanelRef.value = null;
emit('props-panel-unmounted');
};

View File

@ -15,13 +15,7 @@
<script lang="ts" setup>
import { computed, useTemplateRef } from 'vue';
import {
type ContainerChangeEventData,
defineFormItem,
type FormItemConfig,
type FormValue,
MForm,
} from '@tmagic/form';
import { type ContainerChangeEventData, type FormItemConfig, type FormValue, MForm } from '@tmagic/form';
import type { CodeParamStatement } from '@editor/type';
import { error } from '@editor/utils';
@ -47,13 +41,13 @@ const emit = defineEmits(['change']);
const formRef = useTemplateRef<InstanceType<typeof MForm>>('form');
const getFormConfig = (items: FormItemConfig[] = []) => [
defineFormItem({
{
type: 'fieldset',
items,
legend: '参数',
labelPosition: 'top',
labelWidth: '120px',
name: props.name,
}),
},
];
const codeParamsConfig = computed(() =>

View File

@ -10,7 +10,7 @@
:is-compare="true"
:disabled="true"
:label-width="labelWidth"
:context="formContext"
:extend-state="mergedExtendState"
:show-diff="showDiff"
:self-diff-field-types="selfDiffFieldTypes"
:size="size"
@ -47,7 +47,7 @@ const props = withDefaults(
},
);
const { config, currentValues, wrapperStyle, formContext, loadConfig, formRef, normalizeCodeBlockValue } =
const { config, currentValues, wrapperStyle, mergedExtendState, loadConfig, formRef, normalizeCodeBlockValue } =
useCompareForm(props);
const lastValuesProcessed = computed<FormValue>(() => {
@ -60,8 +60,9 @@ const lastValuesProcessed = computed<FormValue>(() => {
/**
* `code-select` 字段在历史数据中存在两种"语义为空"的形态
* - 字符串 `''`旧数据 / 用户从未配置过钩子
* - `{ hookType: HookType.CODE, hookData: [] }``normalizeCodeSelectValue`
* 写入的默认结构
* - `{ hookType: HookType.CODE, hookData: [] }`CodeSelect.vue 在挂载时
* 写入的默认结构参见 packages/editor/src/fields/CodeSelect.vue
* `props.model[props.name] = { hookType: HookType.CODE, hookData: [] }`
*
* 直接 `isEqual` 会把两者判为不等从而在历史对比里对每个未配置过钩子的组件
* 都展示一份"差异"体验很糟糕这里把它们视为相等跳过对比

View File

@ -8,7 +8,7 @@
:init-values="currentValues"
:disabled="disabled"
:label-width="labelWidth"
:context="formContext"
:extend-state="mergedExtendState"
:size="size"
></MForm>
</div>
@ -37,10 +37,11 @@ const props = withDefaults(
category: 'node',
labelWidth: '120px',
disabled: true,
// extendState useCompareForm props.extendState ?? ...
},
);
const { config, currentValues, wrapperStyle, formContext, loadConfig, formRef } = useCompareForm(props);
const { config, currentValues, wrapperStyle, mergedExtendState, loadConfig, formRef } = useCompareForm(props);
defineExpose<{
form: ShallowRef<InstanceType<typeof MForm> | null>;

View File

@ -1,7 +1,7 @@
import type { InjectionKey } from 'vue';
import type { DataSourceSchema, EventOption, Id, MApp, MNode, MPage, MPageFragment } from '@tmagic/core';
import type { FormConfig } from '@tmagic/form';
import type { FormConfig, FormState } from '@tmagic/form';
import StageCore, {
CONTAINER_HIGHLIGHT_CLASS_NAME,
ContainerHighlightType,
@ -82,11 +82,6 @@ export interface EditorProps {
containerHighlightDuration?: number;
/** 拖入画布中容器时,识别容器的操作类型 */
containerHighlightType?: ContainerHighlightType;
/**
*
* false
*/
containerHighlightAddOnly?: boolean;
/** 画布大小 */
stageRect?: StageRect;
/** monaco editor 的配置 */
@ -149,6 +144,7 @@ export interface EditorProps {
beforeDblclick?: (event: MouseEvent) => Promise<boolean | void> | boolean | void;
/** 组件树节点双击前的钩子函数,返回 false 则阻止默认的双击行为 */
beforeLayerNodeDblclick?: (event: MouseEvent, data: TreeNodeData) => Promise<boolean | void> | boolean | void;
extendFormState?: (state: FormState) => Record<string, any> | Promise<Record<string, any>>;
/** 历史记录面板的自定义扩展 tab追加在内置的页面/数据源/代码块 tab 之后 */
historyListExtraTabs?: HistoryListExtraTab[];
/** 页面顺序拖拽配置参数 */
@ -167,7 +163,6 @@ export const defaultEditorProps = {
containerHighlightClassName: CONTAINER_HIGHLIGHT_CLASS_NAME,
containerHighlightDuration: 800,
containerHighlightType: ContainerHighlightType.DEFAULT,
containerHighlightAddOnly: false,
disabledShowSrc: false,
disabledDataSource: false,
disabledCodeBlock: false,

View File

@ -1,5 +1,6 @@
<template>
<MagicCodeEditor
v-if="!silentMode"
:height="config.height"
:type="diffMode ? 'diff' : undefined"
:init-values="diffMode ? (lastValues || {})[name] : model[name]"
@ -17,9 +18,9 @@
</template>
<script lang="ts" setup>
import { computed } from 'vue';
import { computed, inject } from 'vue';
import { type CodeConfig, type FieldProps } from '@tmagic/form';
import { type CodeConfig, type FieldProps, FORM_SILENT_MODE_KEY } from '@tmagic/form';
import MagicCodeEditor from '@editor/layouts/CodeEditor.vue';
@ -27,6 +28,13 @@ defineOptions({
name: 'MFieldsVsCode',
});
/**
* 静默模式submitForm/validateForm 隐藏挂载下跳过 monaco 渲染
* 校验由 FormItem 针对 model 中的值完成与编辑器实例无关本组件挂载无值副作用
* save 仅由用户操作/编辑器内容变更触发跳过可省去 monaco worker/model 的无谓实例化
*/
const silentMode = inject(FORM_SILENT_MODE_KEY, false);
const emit = defineEmits<{
change: [value: string | any];
}>();

View File

@ -1,29 +1,36 @@
<template>
<div class="m-fields-code-select" :class="config.className">
<MContainer
:config="codeConfig"
:size="size"
class="code-select-content"
:prop="prop"
:disabled="disabled"
:is-compare="isCompareMode"
:last-values="lastValues?.[name]"
:model="model[name]"
:label-position="config.labelPosition"
:label-width="config.labelWidth"
@change="changeHandler"
>
</MContainer>
<TMagicCard :flat="config.flat">
<MContainer
:config="codeConfig"
:size="size"
class="code-select-content"
:prop="prop"
:disabled="disabled"
:is-compare="isCompareMode"
:last-values="lastValues?.[name]"
:model="model[name]"
@change="changeHandler"
>
</MContainer>
<TMagicButton class="create-button fullWidth" :icon="Plus" :size="size" :disabled="disabled" @click="newHandler()"
>添加{{ config.text }}</TMagicButton
>
</TMagicCard>
</div>
</template>
<script lang="ts" setup>
import { computed, watch } from 'vue';
import { Plus } from '@element-plus/icons-vue';
import { isEmpty } from 'lodash-es';
import type { CodeSelectConfig, ContainerChangeEventData, FieldProps } from '@tmagic/form';
import { HookCodeType, HookType } from '@tmagic/core';
import { TMagicButton, TMagicCard } from '@tmagic/design';
import type { CodeSelectConfig, ContainerChangeEventData, FieldProps, GroupListConfig } from '@tmagic/form';
import { MContainer } from '@tmagic/form';
import { createCodeSelectConfig, normalizeCodeSelectValue } from '@editor/fields/configs/codeSelect';
import { useServices } from '@editor/hooks/use-services';
defineOptions({
name: 'MFieldsCodeSelect',
@ -33,6 +40,8 @@ const emit = defineEmits<{
change: [v: any, eventData: ContainerChangeEventData];
}>();
const { dataSourceService, codeBlockService } = useServices();
const props = withDefaults(defineProps<FieldProps<CodeSelectConfig>>(), {});
/**
@ -49,14 +58,101 @@ const props = withDefaults(defineProps<FieldProps<CodeSelectConfig>>(), {});
* 仅当存在历史值时才启用对比避免 lastValues 缺失时退化为全部新增的空对比
*/
const isCompareMode = computed(() => Boolean(props.isCompare && props.lastValues));
const newHandler = () => {
const defaultCode = {
codeType: HookCodeType.CODE,
codeId: '',
};
const name = props.config.name || '';
const hookData = props.model[name]?.hookData || [];
emit('change', defaultCode, {
modifyKey: `hookData.${hookData.length}`,
});
};
const codeConfig = computed<GroupListConfig>(() => ({
type: 'group-list',
name: 'hookData',
enableToggleMode: false,
expandAll: true,
addable: () => false,
title: (mForm, { model, index }: any) => {
if (model.codeType === HookCodeType.DATA_SOURCE_METHOD) {
if (Array.isArray(model.codeId)) {
if (model.codeId.length < 2) {
return index;
}
const codeConfig = computed(() => createCodeSelectConfig(props.config));
const ds = dataSourceService.getDataSourceById(model.codeId[0]);
return `${ds?.title} / ${model.codeId[1]}`;
}
return Array.isArray(model.codeId) ? model.codeId.join('/') : index;
}
const codeContent = codeBlockService.getCodeContentById(model.codeId);
if (codeContent) {
return codeContent.name;
}
return model.codeId || index;
},
titlePrefix: props.config.name === undefined ? undefined : String(props.config.name),
items: [
{
text: '代码类型',
type: 'select',
name: 'codeType',
labelPosition: 'right',
rules: [{ typeMatch: true, trigger: 'change' }],
options: [
{ value: HookCodeType.CODE, text: '代码块' },
{ value: HookCodeType.DATA_SOURCE_METHOD, text: '数据源方法' },
],
defaultValue: HookCodeType.CODE,
onChange: (_mForm, v: HookCodeType, { setModel }) => {
if (v === HookCodeType.DATA_SOURCE_METHOD) {
setModel('codeId', []);
} else {
setModel('codeId', '');
}
return v;
},
},
{
type: 'code-select-col',
name: 'codeId',
text: '代码块',
rules: [{ typeMatch: true, trigger: 'change' }],
display: (_mForm, { model }) => model.codeType !== HookCodeType.DATA_SOURCE_METHOD,
notEditable: () => !codeBlockService.getEditStatus(),
},
{
type: 'data-source-method-select',
name: 'codeId',
text: '数据源字段',
rules: [{ typeMatch: true, trigger: 'change' }],
display: (_mForm, { model }) => model.codeType === HookCodeType.DATA_SOURCE_METHOD,
notEditable: () => !dataSourceService.get('editable'),
},
],
}));
// applyMountValueEffects code-select effect
watch(
() => props.model[props.name],
() => {
normalizeCodeSelectValue(props.model, props.name);
(value) => {
//
if (isEmpty(value)) {
//
props.model[props.name] = {
hookType: HookType.CODE,
hookData: [],
};
}
},
{
immediate: true,
},
);

View File

@ -84,7 +84,7 @@ defineOptions({
const mForm = inject<FormState | undefined>('mForm');
const { codeBlockService, uiService } = useServices();
const eventBus = inject<EventBus | null>('eventBus', null);
const eventBus = inject<EventBus>('eventBus');
const emit = defineEmits<{
change: [v: any, eventData: ContainerChangeEventData];
}>();

View File

@ -31,7 +31,6 @@ import { computed } from 'vue';
import { getDesignConfig, TMagicSelect } from '@tmagic/design';
import type { CondOpSelectConfig, FieldProps } from '@tmagic/form';
import { removeDataSourceFieldPrefix } from '@tmagic/utils';
import { useServices } from '@editor/hooks/use-services';
import { getCondOpOptionsByFieldType, getFieldType } from '@editor/utils';
@ -51,8 +50,8 @@ const props = defineProps<FieldProps<CondOpSelectConfig>>();
const optionComponent = getDesignConfig('components')?.option;
const options = computed(() => {
const [id, ...fieldNames] = [...(props.config.parentFields || []), ...(props.model.field || [])];
const ds = id ? dataSourceService.getDataSourceById(removeDataSourceFieldPrefix(id)) : undefined;
const [id, ...fieldNames] = [...(props.config.parentFields || []), ...props.model.field];
const ds = dataSourceService.getDataSourceById(id);
const type = getFieldType(ds, fieldNames);
return getCondOpOptionsByFieldType(type);
});

View File

@ -124,7 +124,7 @@ const optionComponent = getDesignConfig('components')?.option;
const { dataSourceService, uiService } = useServices();
const mForm = inject<FormState | undefined>('mForm');
const eventBus = inject<EventBus | null>('eventBus', null);
const eventBus = inject<EventBus>('eventBus');
const allDataSources = computed(() => dataSourceService.get('dataSources') || []);

View File

@ -141,10 +141,7 @@ const checkStrictly = computed(() => {
if (typeof props.config.checkStrictly !== 'function') {
value = props.config.checkStrictly;
} else {
const fieldValue = props.model[props.name];
// dataSourceId id config
const rawDsId = props.config.dataSourceId ?? (Array.isArray(fieldValue) ? fieldValue[0] : fieldValue);
const dsId = removeDataSourceFieldPrefix(`${rawDsId}`);
const dsId = removeDataSourceFieldPrefix(props.model[0]);
const dataSource = dataSources.value.find((ds) => ds.id === dsId);
value = props.config.checkStrictly(mForm, {

View File

@ -89,6 +89,7 @@ const emit = defineEmits<{
const { uiService } = useServices();
const mForm = inject<FormState | undefined>('mForm');
/** 对比模式下隐藏新增/编辑/删除等操作按钮,仅保留只读展示。 */
const isCompare = computed(() => Boolean(mForm?.isCompare));

View File

@ -67,7 +67,7 @@ defineOptions({
const { dataSourceService, uiService } = useServices();
const mForm = inject<FormState | undefined>('mForm');
const eventBus = inject<EventBus | null>('eventBus', null);
const eventBus = inject<EventBus>('eventBus');
const emit = defineEmits(['change']);

View File

@ -26,12 +26,7 @@ import { cloneDeep } from 'lodash-es';
import type { CodeBlockContent } from '@tmagic/core';
import { TMagicButton, tMagicMessageBox } from '@tmagic/design';
import {
type ContainerChangeEventData,
type DataSourceMethodsConfig,
type FieldProps,
type FormState,
} from '@tmagic/form';
import type { ContainerChangeEventData, DataSourceMethodsConfig, FieldProps, FormState } from '@tmagic/form';
import { type ColumnConfig, MagicTable } from '@tmagic/table';
import CodeBlockEditor from '@editor/components/CodeBlockEditor.vue';
@ -48,6 +43,7 @@ const props = withDefaults(defineProps<FieldProps<DataSourceMethodsConfig>>(), {
const emit = defineEmits(['change']);
const mForm = inject<FormState | undefined>('mForm');
/** 对比模式下隐藏新增/编辑/删除等操作按钮,仅保留只读展示。 */
const isCompare = computed(() => Boolean(mForm?.isCompare));

View File

@ -50,7 +50,7 @@ const props = withDefaults(defineProps<FieldProps<DataSourceSelect>>(), {
const mForm = inject<FormState | undefined>('mForm');
const { dataSourceService, uiService } = useServices();
const eventBus = inject<EventBus | null>('eventBus', null);
const eventBus = inject<EventBus>('eventBus');
const dataSources = computed(() => dataSourceService.get('dataSources'));

View File

@ -1,17 +1,15 @@
<template>
<div class="m-fields-display-conds">
<MGroupList
:config="config"
:name="name"
:disabled="disabled"
:model="model"
:last-values="lastValues"
:is-compare="isCompareMode"
:prop="prop"
:size="size"
@change="changeHandler"
></MGroupList>
</div>
<MGroupList
style="width: 100%"
:config="config"
:name="name"
:disabled="disabled"
:model="model"
:last-values="lastValues"
:prop="prop"
:size="size"
@change="changeHandler"
></MGroupList>
</template>
<script lang="ts" setup>
@ -24,32 +22,170 @@ import {
type FieldProps,
filterFunction,
type FormState,
type GroupListConfig,
MGroupList,
} from '@tmagic/form';
import { createDisplayCondsConfig } from '@editor/fields/configs/displayConds';
import { useServices } from '@editor/hooks/use-services';
import { getCascaderOptionsFromFields, getFieldType } from '@editor/utils';
defineOptions({
name: 'm-fields-display-conds',
});
const emit = defineEmits<{
change: [value: DisplayCond | DisplayCond[], eventData?: ContainerChangeEventData];
change: [value: DisplayCond[], eventData?: ContainerChangeEventData];
}>();
const props = withDefaults(defineProps<FieldProps<DisplayCondsConfig>>(), {
disabled: false,
});
const { dataSourceService } = useServices();
const mForm = inject<FormState | undefined>('mForm');
const parentFields = computed(() => filterFunction<string[]>(mForm, props.config.parentFields, props) || []);
const config = computed(() => createDisplayCondsConfig(props.config, props.name, parentFields.value));
const fieldOnChange = (_formState: FormState | undefined, v: string[], { model }: { model: Record<string, any> }) => {
const [id, ...fieldNames] = [...parentFields.value, ...v];
const ds = dataSourceService.getDataSourceById(id);
const type = getFieldType(ds, fieldNames);
if (type === 'number') {
model.value = Number(model.value);
} else if (type === 'boolean') {
model.value = Boolean(model.value);
} else if (type === 'null') {
model.value = null;
} else {
model.value = `${model.value}`;
}
return v;
};
const isCompareMode = computed(() => Boolean(props.isCompare && props.lastValues));
const config = computed<GroupListConfig>(() => ({
type: 'groupList',
name: props.name,
titlePrefix: props.config.titlePrefix,
expandAll: true,
enableToggleMode: false,
flat: props.config.flat,
items: [
{
type: 'table',
name: 'cond',
operateColWidth: props.config.operateColWidth,
enableToggleMode: false,
fixed: props.config.fixed,
flat: props.config.flat,
items: [
parentFields.value.length
? {
type: 'cascader',
options: () => {
const [dsId, ...keys] = parentFields.value;
const ds = dataSourceService.getDataSourceById(dsId);
if (!ds) {
return [];
}
let fields = ds.fields || [];
keys.forEach((key) => {
const field = fields.find((f) => f.name === key);
fields = field?.fields || [];
});
return getCascaderOptionsFromFields(fields, ['string', 'number', 'boolean', 'any']);
},
name: 'field',
value: 'key',
label: '字段',
checkStrictly: false,
onChange: fieldOnChange,
defaultValue: () => [],
rules: [
{ required: true, trigger: 'blur', message: '请选择字段' },
{ typeMatch: true, trigger: 'change' },
],
}
: {
type: 'data-source-field-select',
name: 'field',
value: 'key',
label: '字段',
checkStrictly: false,
dataSourceFieldType: ['string', 'number', 'boolean', 'any'],
onChange: fieldOnChange,
defaultValue: () => [],
rules: [
{ required: true, trigger: 'blur', message: '请选择字段' },
{ typeMatch: true, trigger: 'change' },
],
},
{
type: 'cond-op-select',
parentFields: parentFields.value,
label: '条件',
width: 140,
name: 'op',
rules: [
{ required: true, trigger: 'blur', message: '请选择条件' },
{ typeMatch: true, trigger: 'change' },
],
},
{
label: '值',
width: 160,
items: [
{
name: 'value',
type: (_mForm, { model }) => {
const [id, ...fieldNames] = [...parentFields.value, ...model.field];
const ds = dataSourceService.getDataSourceById(id);
const type = getFieldType(ds, fieldNames);
if (type === 'number') {
return 'number';
}
if (type === 'boolean') {
return 'select';
}
if (type === 'null') {
return 'display';
}
return 'text';
},
options: [
{ text: 'true', value: true },
{ text: 'false', value: false },
],
display: (_mForm, { model }) => !['between', 'not_between'].includes(model.op),
displayText: (_mForm: FormState | undefined, { model }: any) => {
if (model.value === null) {
return 'null';
}
return model.value;
},
},
{
name: 'range',
type: 'number-range',
display: (vm, { model }) => ['between', 'not_between'].includes(model.op),
},
],
},
],
},
],
}));
const changeHandler = (v: DisplayCond[], eventData?: ContainerChangeEventData) => {
if (!Array.isArray(props.model[props.name])) {
props.model[props.name] = [];
}
emit('change', v, eventData);
};
</script>

View File

@ -15,50 +15,101 @@
<div v-else class="fullWidth event-select-container">
<div class="event-select-header">
<div class="event-select-title">事件配置</div>
<TMagicButton
v-if="!isCompareMode && displayList.length > 0"
class="create-button"
text
type="primary"
:icon="Plus"
:size="size"
:disabled="disabled"
@click="addEvent()"
>添加事件</TMagicButton
>
</div>
<MGroupList
:config="eventConfig"
:name="name"
<MPanel
v-for="entry in displayList"
:key="entry.index"
:disabled="disabled"
:model="model"
:last-values="lastValues"
:is-compare="isCompareMode"
:prop="prop"
:size="size"
:prop="`${prop}.${entry.index}`"
:config="actionsConfig"
:model="entry.cardItem"
:last-values="entry.lastCardItem"
:is-compare="isCompareMode"
:hide-expand="true"
:label-width="config.labelWidth || '100px'"
@change="onChangeHandler"
>
<template #title="{ model: itemModel, lastValues: itemLastValues, prop: itemProp }">
<template #header>
<div class="event-item-header">
<div class="event-item-title">事件{{ Number(entry.index) + 1 }}</div>
<MFormContainer
class="fullWidth"
:config="eventNameConfig"
:model="itemModel"
:last-values="itemLastValues"
:model="entry.cardItem"
:last-values="entry.lastCardItem"
:is-compare="isCompareMode"
:disabled="disabled"
:size="size"
:prop="itemProp"
@change="onChangeHandler"
:prop="`${prop}.${entry.index}`"
@change="eventNameChangeHandler"
></MFormContainer>
<TMagicButton
class="event-item-delete-button"
v-if="!isCompareMode"
link
:icon="Delete"
:disabled="disabled"
:size="size"
@click="removeEvent(Number(entry.index))"
></TMagicButton>
</div>
</template>
</MGroupList>
</MPanel>
<TMagicButton
v-if="!isCompareMode"
class="create-button fullWidth"
:icon="Plus"
:disabled="disabled"
@click="addEvent()"
>添加事件</TMagicButton
>
</div>
</div>
</template>
<script lang="ts" setup>
import { computed } from 'vue';
import { Delete } from '@element-plus/icons-vue';
import { Plus } from '@element-plus/icons-vue';
import { has } from 'lodash-es';
import type { ContainerChangeEventData, EventSelectConfig, FieldProps } from '@tmagic/form';
import { MContainer as MFormContainer, MGroupList, MTable } from '@tmagic/form';
import { ActionType } from '@tmagic/core';
import { TMagicButton } from '@tmagic/design';
import type {
CodeSelectColConfig,
ContainerChangeEventData,
DataSourceMethodSelectConfig,
DynamicTypeConfig,
EventSelectConfig,
FieldProps,
FormState,
PanelConfig,
TableConfig,
UISelectConfig,
} from '@tmagic/form';
import { defineFormItem, MContainer as MFormContainer, MPanel, MTable } from '@tmagic/form';
import { useServices } from '@editor/hooks/use-services';
import {
createEventNameConfig,
createEventSelectConfig,
createLegacyTableConfig,
isLegacyEventValue,
} from '@editor/fields/configs/eventSelect';
getCompActionAllowedValues,
getCompActionOptions,
getEventNameAllowedValues,
getEventNameOptions,
normalizeCompActionValue,
} from '@editor/utils';
defineOptions({
name: 'MFieldsEventSelect',
@ -70,25 +121,314 @@ const emit = defineEmits<{
change: [v: any, eventData?: ContainerChangeEventData];
}>();
const tableConfig = computed(() => createLegacyTableConfig(props.config));
const { editorService, dataSourceService, eventsService, codeBlockService, propsService } = useServices();
const eventNameConfig = computed(() => createEventNameConfig(props.config));
//
const eventNameConfig = computed(() => {
const defaultEventNameConfig = {
name: 'name',
text: '事件类型',
type: (mForm: FormState | undefined, { formValue }: any) => {
if (
props.config.src !== 'component' ||
(formValue.type === 'page-fragment-container' && formValue.pageFragmentId)
) {
return 'cascader';
}
return 'select';
},
labelWidth: '70px',
checkStrictly: () => props.config.src !== 'component',
valueSeparator: '.',
options: (_mForm: FormState, { formValue }: any) => getEventNameOptions(props.config.src, formValue),
rules: [
{
validator: ({ value, callback }: any, { formValue }: any) => {
const allowedNames = getEventNameAllowedValues(props.config as any, formValue);
if (allowedNames && allowedNames.size > 0 && value && !allowedNames.has(value)) {
return callback(`事件名(${value})不存在`);
}
callback();
},
trigger: 'blur',
},
],
};
return { ...defaultEventNameConfig, ...props.config.eventNameConfig };
});
const eventConfig = computed(() => createEventSelectConfig(props.config, props.name));
const actionTypeOptions = computed(() => {
const o: {
text: string;
label: string;
value: string;
disabled?: boolean;
}[] = [
{
text: '组件',
label: '组件',
value: ActionType.COMP,
},
];
const isOldVersion = computed(() => isLegacyEventValue(props.model[props.name]));
if (!propsService.getDisabledCodeBlock()) {
o.push({
text: '代码',
label: '代码',
disabled: !Object.keys(codeBlockService.getCodeDsl() || {}).length,
value: ActionType.CODE,
});
}
if (!propsService.getDisabledDataSource()) {
o.push({
text: '数据源',
label: '数据源',
value: ActionType.DATA_SOURCE,
});
}
return o;
});
//
const actionTypeConfig = computed(() => {
const defaultActionTypeConfig = {
name: 'actionType',
text: '联动类型',
type: 'select',
labelPosition: 'left',
defaultValue: ActionType.COMP,
options: actionTypeOptions.value,
rules: [
{
required: true,
message: '联动类型不能为空',
},
{
typeMatch: true,
trigger: 'blur',
},
],
};
return { ...defaultActionTypeConfig, ...props.config.actionTypeConfig };
});
//
const targetCompConfig = computed(() => {
const defaultTargetCompConfig: UISelectConfig = {
name: 'to',
text: '联动组件',
type: 'ui-select',
labelPosition: 'left',
display: (_mForm, { model }) => model.actionType === ActionType.COMP,
onChange: (_MForm, _v, { setModel }) => {
setModel('method', '');
},
rules: [
{
typeMatch: true,
trigger: 'blur',
},
],
};
return { ...defaultTargetCompConfig, ...props.config.targetCompConfig };
});
//
const compActionConfig = computed(() => {
const defaultCompActionConfig: DynamicTypeConfig = {
name: 'method',
text: '动作',
labelPosition: 'left',
type: (mForm: FormState | undefined, { model }: any) => {
const to = editorService.getNodeById(model.to);
if (to && to.type === 'page-fragment-container' && to.pageFragmentId) {
return 'cascader';
}
return 'select';
},
checkStrictly: () => props.config.src !== 'component',
display: (mForm: FormState | undefined, { model }: any) => model.actionType === ActionType.COMP,
options: (_mForm: FormState, { model }: any) => getCompActionOptions(model.to),
rules: [
{
trigger: 'blur',
validator: ({ value, callback }: any, { model }: any) => {
const allowedMethods = getCompActionAllowedValues(props.config as any, model);
const normalized = normalizeCompActionValue(value);
if (allowedMethods && allowedMethods.size > 0 && normalized && !allowedMethods.has(normalized)) {
return callback(`动作名(${normalized})不存在`);
}
callback();
},
},
],
};
return { ...defaultCompActionConfig, ...props.config.compActionConfig };
});
//
const codeActionConfig = computed(() => {
const defaultCodeActionConfig: CodeSelectColConfig = {
type: 'code-select-col',
text: '代码块',
name: 'codeId',
notEditable: () => !codeBlockService.getEditStatus(),
display: (mForm, { model }) => model.actionType === ActionType.CODE,
};
return { ...defaultCodeActionConfig, ...props.config.codeActionConfig };
});
//
const dataSourceActionConfig = computed(() => {
const defaultDataSourceActionConfig: DataSourceMethodSelectConfig = {
type: 'data-source-method-select',
text: '数据源方法',
name: 'dataSourceMethod',
notEditable: () => !dataSourceService.get('editable'),
display: (mForm, { model }) => model.actionType === ActionType.DATA_SOURCE,
};
return { ...defaultDataSourceActionConfig, ...props.config.dataSourceActionConfig };
});
//
const tableConfig = computed(
() =>
defineFormItem({
type: 'table',
name: 'events',
items: [
{
name: 'name',
label: '事件名',
type: eventNameConfig.value.type,
options: (mForm: FormState, { formValue }: any) =>
eventsService.getEvent(formValue.type).map((option: any) => ({
text: option.label,
value: option.value,
})),
},
{
name: 'to',
label: '联动组件',
type: 'ui-select',
},
{
name: 'method',
label: '动作',
type: compActionConfig.value.type,
options: (mForm: FormState, { model }: any) => {
const node = editorService.getNodeById(model.to);
if (!node?.type) return [];
return eventsService.getMethod(node.type, model.to).map((option: any) => ({
text: option.label,
value: option.value,
}));
},
},
],
}) as TableConfig,
);
//
const actionsConfig = computed(
() =>
defineFormItem({
type: 'panel',
labelPosition: 'left',
items: [
{
type: 'group-list',
name: 'actions',
expandAll: true,
enableToggleMode: false,
titlePrefix: '动作',
labelPosition: 'left',
items: [
actionTypeConfig.value,
targetCompConfig.value,
compActionConfig.value,
codeActionConfig.value,
dataSourceActionConfig.value,
],
},
],
}) as PanelConfig,
);
//
const isOldVersion = computed(() => {
if (props.model[props.name].length === 0) return false;
return !has(props.model[props.name][0], 'actions');
});
/**
* 对比模式判定
*
* event-select 内部是事件列表 group-list父级 `MFormContainer` 已将其归入自接管对比字段
* Container.vue `SELF_DIFF_FIELD_TYPES`对比时只渲染一次本组件并把 `is-compare` /
* `lastValues` 透传给内部 MGroupList title slot 里的事件名表单
* event-select 内部由事件列表 + 嵌套子表单组成属于复合字段父级 `MFormContainer` 已将其
* 归入自接管对比字段 Container.vue `SELF_DIFF_FIELD_TYPES`即对比时只渲染一次本组件
* 并把当前值 `model` 与历史值 `lastValues` 一并传入由本组件把 `is-compare`/`lastValues` 透传给
* 内部的 MPanel / MFormContainer逐项事件名动作展示前后差异
*
* 仅当存在历史值时才启用对比避免 lastValues 缺失时退化为全部新增的空对比
*/
const isCompareMode = computed(() => Boolean(props.isCompare && props.lastValues));
const onChangeHandler = (_v: any, eventData?: ContainerChangeEventData) =>
/**
* 待渲染的事件卡片列表
*
* - 非对比模式直接映射当前事件列表`lastCardItem` 为空
* - 对比模式按索引对齐当前值与历史值取两者长度的最大值使得新增仅当前有
* 删除仅历史有的事件都能被渲染出来缺失的一侧用空对象兜底从而让子级正确高亮差异
*/
const displayList = computed<{ cardItem: any; lastCardItem: any; index: number }[]>(() => {
const current = props.model[props.name] || [];
if (!isCompareMode.value) {
return current.map((cardItem: any, index: number) => ({ cardItem, lastCardItem: undefined, index }));
}
const last = props.lastValues?.[props.name] || [];
const length = Math.max(current.length, last.length);
return Array.from({ length }, (_, index) => ({
cardItem: current[index] ?? {},
lastCardItem: last[index] ?? {},
index,
}));
});
//
const addEvent = () => {
const defaultEvent = {
name: '',
actions: [],
};
if (!props.model[props.name]) {
props.model[props.name] = [];
}
emit('change', defaultEvent, {
modifyKey: props.model[props.name].length,
});
};
//
const removeEvent = (index: number) => {
if (!props.name) return;
props.model[props.name].splice(index, 1);
emit('change', props.model[props.name]);
};
const eventNameChangeHandler = (v: any, eventData: ContainerChangeEventData) => {
emit('change', props.model[props.name], eventData);
};
const onChangeHandler = (v: any, eventData: ContainerChangeEventData) =>
emit('change', props.model[props.name], eventData);
</script>

View File

@ -75,7 +75,7 @@ import { computed, inject, ref, watchEffect } from 'vue';
import { Delete, Plus } from '@element-plus/icons-vue';
import { TMagicButton, TMagicInput } from '@tmagic/design';
import { type FieldProps, type FormState, type KeyValueConfig } from '@tmagic/form';
import type { FieldProps, FormState, KeyValueConfig } from '@tmagic/form';
import CodeIcon from '@editor/icons/CodeIcon.vue';
import MagicCodeEditor from '@editor/layouts/CodeEditor.vue';

View File

@ -52,14 +52,48 @@
import { computed, ref } from 'vue';
import type { ContainerChangeEventData, FormValue } from '@tmagic/form';
import { MContainer } from '@tmagic/form';
import { defineFormItem, MContainer } from '@tmagic/form';
import type { StyleSchema } from '@tmagic/schema';
import { createBorderDirectionConfig } from '../configs';
const direction = ref('');
const config = computed(() => createBorderDirectionConfig(direction.value));
const config = computed(() =>
defineFormItem({
items: [
{
name: `border${direction.value}Width`,
text: '边框宽度',
labelWidth: '68px',
type: 'data-source-field-select',
fieldConfig: {
type: 'text',
},
},
{
name: `border${direction.value}Color`,
text: '边框颜色',
labelWidth: '68px',
type: 'data-source-field-select',
fieldConfig: {
type: 'colorPicker',
},
},
{
name: `border${direction.value}Style`,
text: '边框样式',
labelWidth: '68px',
type: 'data-source-field-select',
fieldConfig: {
type: 'select',
options: ['solid', 'dashed', 'dotted'].map((item) => ({
value: item,
text: item,
})),
},
},
],
}),
);
const selectDirection = (d?: string) => (direction.value = d || '');

View File

@ -4,7 +4,7 @@
<span class="help-txt" v-if="item.text">{{ item.text }}</span>
<span class="next-input">
<input
:value="model[item.name]"
:model-value="model[item.name]"
placeholder="0"
:title="model[item.name]"
:disabled="disabled"

View File

@ -3,7 +3,7 @@
<div v-for="(item, index) in list" :key="index" :class="item.class">
<span class="next-input">
<input
:value="model[item.name]"
:model-value="model[item.name]"
placeholder="0"
:title="model[item.name]"
:disabled="disabled"

View File

@ -1,690 +0,0 @@
import { markRaw } from 'vue';
import { appendValidateSuggestion } from '@tmagic/design/headless';
import { defineFormItem, type FormConfig } from '@tmagic/form/headless';
import type { StyleSchema } from '@tmagic/schema';
import type { validateDataSourceFieldSelect } from '@editor/utils/type-match-rules';
import BackgroundPosition from './components/BackgroundPosition.vue';
import {
AlignItemsCenter,
AlignItemsFlexEnd,
AlignItemsFlexStart,
AlignItemsSpaceAround,
AlignItemsSpaceBetween,
} from './icons/align-items';
import { BackgroundNoRepeat, BackgroundRepeat, BackgroundRepeatX, BackgroundRepeatY } from './icons/background-repeat';
import { DisplayBlock, DisplayFlex, DisplayInline, DisplayInlineBlock, DisplayNone } from './icons/display';
import {
FlexDirectionColumn,
FlexDirectionColumnReverse,
FlexDirectionRow,
FlexDirectionRowReverse,
} from './icons/flex-direction';
import {
JustifyContentCenter,
JustifyContentFlexEnd,
JustifyContentFlexStart,
JustifyContentSpaceAround,
JustifyContentSpaceBetween,
} from './icons/justify-content';
import { AlignCenter, AlignLeft, AlignRight } from './icons/text-align';
/**
*
*
* `theme` `useTheme()` magic-admin
* radio button
*/
export const createLayoutConfig = (theme: string): FormConfig => [
defineFormItem({
name: 'display',
text: '模式',
type: 'radioGroup',
childType: 'button',
labelWidth: '90px',
iconSize: '24px',
options: [
{
value: 'inline',
icon: markRaw(DisplayInline),
tooltip: '内联布局 inline',
},
{
value: 'flex',
icon: markRaw(DisplayFlex),
tooltip: '弹性布局 flex',
},
{
value: 'block',
icon: markRaw(DisplayBlock),
tooltip: '块级布局 block',
},
{
value: 'inline-block',
icon: markRaw(DisplayInlineBlock),
tooltip: '内联块布局 inline-block',
},
{
value: 'none',
icon: markRaw(DisplayNone),
tooltip: '隐藏 none',
},
],
}),
defineFormItem({
name: 'flexDirection',
text: '主轴方向',
type: 'radioGroup',
childType: 'button',
labelWidth: '90px',
iconSize: '24px',
options: [
{ value: 'row', icon: markRaw(FlexDirectionRow), tooltip: '水平方向 起点在左侧 row' },
{
value: 'row-reverse',
icon: markRaw(FlexDirectionRowReverse),
tooltip: '水平方向 起点在右侧 row-reverse',
},
{
value: 'column',
icon: markRaw(FlexDirectionColumn),
tooltip: '垂直方向 起点在上沿 column',
},
{
value: 'column-reverse',
icon: markRaw(FlexDirectionColumnReverse),
tooltip: '垂直方向 起点在下沿 column-reverse',
},
],
display: (_mForm, { model }: { model: Record<any, any> }) => model.display === 'flex',
}),
defineFormItem({
name: 'justifyContent',
text: '主轴对齐',
type: 'radioGroup',
childType: 'button',
labelWidth: '90px',
iconSize: '24px',
options: [
{ value: 'flex-start', icon: markRaw(JustifyContentFlexStart), tooltip: '左对齐 flex-start' },
{ value: 'flex-end', icon: markRaw(JustifyContentFlexEnd), tooltip: '右对齐 flex-end' },
{ value: 'center', icon: markRaw(JustifyContentCenter), tooltip: '居中 center' },
{
value: 'space-between',
icon: markRaw(JustifyContentSpaceBetween),
tooltip: '两端对齐 space-between',
},
{
value: 'space-around',
icon: markRaw(JustifyContentSpaceAround),
tooltip: '横向平分 space-around',
},
],
display: (_mForm, { model }: { model: Record<any, any> }) => model.display === 'flex',
}),
defineFormItem({
name: 'alignItems',
text: '辅轴对齐',
type: 'radioGroup',
childType: 'button',
labelWidth: '90px',
iconSize: '24px',
options: [
{ value: 'flex-start', icon: markRaw(AlignItemsFlexStart), tooltip: '左对齐 flex-start' },
{ value: 'flex-end', icon: markRaw(AlignItemsFlexEnd), tooltip: '右对齐 flex-end' },
{ value: 'center', icon: markRaw(AlignItemsCenter), tooltip: '居中 center' },
{
value: 'space-between',
icon: markRaw(AlignItemsSpaceBetween),
tooltip: '两端对齐 space-between',
},
{
value: 'space-around',
icon: markRaw(AlignItemsSpaceAround),
tooltip: '横向平分 space-around',
},
],
display: (_mForm, { model }: { model: Record<any, any> }) => model.display === 'flex',
}),
defineFormItem({
name: 'flexWrap',
text: '换行',
type: 'radioGroup',
childType: theme !== 'magic-admin' ? 'button' : 'default',
labelWidth: '90px',
iconSize: '24px',
options: [
{ value: 'nowrap', text: '不换行', tooltip: '不换行 nowrap' },
{ value: 'wrap', text: '正换行', tooltip: '第一行在上方 wrap' },
{ value: 'wrap-reverse', text: '逆换行', tooltip: '第一行在下方 wrap-reverse' },
],
display: (_mForm, { model }: { model: Record<any, any> }) => model.display === 'flex',
}),
defineFormItem({
type: 'row',
items: [
{
name: 'width',
text: '宽度px',
labelWidth: '90px',
type: 'data-source-field-select',
fieldConfig: {
type: 'text',
},
},
],
}),
defineFormItem({
type: 'row',
items: [
{
name: 'height',
text: '高度px',
labelWidth: '90px',
type: 'data-source-field-select',
fieldConfig: {
type: 'text',
},
},
],
}),
defineFormItem({
type: 'row',
items: [
{
type: 'data-source-field-select',
text: 'overflow',
name: 'overflow',
labelWidth: '90px',
checkStrictly: false,
dataSourceFieldType: ['string'],
fieldConfig: {
type: 'select',
clearable: true,
allowCreate: true,
options: [
{ text: 'visible', value: 'visible' },
{ text: 'hidden', value: 'hidden' },
{ text: 'clip', value: 'clip' },
{ text: 'scroll', value: 'scroll' },
{ text: 'auto', value: 'auto' },
{ text: 'overlay', value: 'overlay' },
{ text: 'initial', value: 'initial' },
],
},
},
],
}),
defineFormItem({
type: 'row',
items: [
{
type: 'data-source-field-select',
text: '透明度(%',
name: 'opacity',
labelWidth: '90px',
dataSourceFieldType: ['string', 'number'],
fieldConfig: {
type: 'text',
},
},
],
}),
];
const positionText: Record<string, string> = {
static: '不定位',
relative: '相对定位',
absolute: '绝对定位',
fixed: '固定定位',
sticky: '粘性定位',
};
/**
*
*
* `values` style modelleft/top/right/bottom display
* `values.position`
*/
export const createPositionConfig = (values: Partial<StyleSchema>): FormConfig => [
defineFormItem({
name: 'position',
text: '定位',
labelWidth: '68px',
type: 'data-source-field-select',
fieldConfig: {
type: 'select',
options: Object.keys(positionText).map((item) => ({
value: item,
text: `${item}(${positionText[item]})`,
})),
},
}),
defineFormItem({
type: 'row',
labelWidth: '68px',
display: () => values.position !== 'static',
items: [
{
name: 'left',
type: 'data-source-field-select',
text: 'left',
fieldConfig: {
type: 'text',
},
rules: [
{
typeMatch: true,
message: appendValidateSuggestion('left 应为字符串', '请参考以下示例值:"10"'),
},
],
},
{
name: 'top',
type: 'data-source-field-select',
text: 'top',
fieldConfig: {
type: 'text',
},
rules: [
{
typeMatch: true,
message: appendValidateSuggestion('top 应为字符串', '请参考以下示例值:"10"'),
},
],
},
],
}),
defineFormItem({
type: 'row',
labelWidth: '68px',
display: () => values.position !== 'static',
items: [
{
name: 'right',
type: 'data-source-field-select',
text: 'right',
fieldConfig: {
type: 'text',
},
rules: [
{
typeMatch: true,
message: appendValidateSuggestion('right 应为字符串', '请参考以下示例值:"10"'),
},
],
},
{
name: 'bottom',
type: 'data-source-field-select',
text: 'bottom',
fieldConfig: {
type: 'text',
},
rules: [
{
typeMatch: true,
message: appendValidateSuggestion('bottom 应为字符串', '请参考以下示例值:"10"'),
},
],
},
],
}),
defineFormItem({
labelWidth: '68px',
name: 'zIndex',
text: 'zIndex',
type: 'data-source-field-select',
fieldConfig: {
type: 'text',
},
rules: [
{
typeMatch: true,
message: appendValidateSuggestion('zIndex 应为数字', '请参考以下示例值10'),
},
],
}),
];
/**
*
*
* `@tmagic/design` `appendValidateSuggestion`
* design
*
*/
export const createBackgroundConfig = (): FormConfig => [
defineFormItem({
name: 'backgroundColor',
text: '背景色',
labelWidth: '68px',
type: 'data-source-field-select',
fieldConfig: {
type: 'colorPicker',
},
rules: [
{
typeMatch: true,
message: appendValidateSuggestion('背景色应为字符串', '请参考以下示例值:"#000000"'),
},
],
}),
defineFormItem({
name: 'backgroundImage',
text: '背景图',
labelWidth: '68px',
type: 'data-source-field-select',
fieldConfig: {
type: 'img-upload',
} as any,
}),
defineFormItem({
name: 'backgroundSize',
text: '背景尺寸',
type: 'radioGroup',
childType: 'button',
labelWidth: '68px',
options: [
{ value: 'auto', text: '默认', tooltip: '默认 auto' },
{ value: 'contain', text: '等比填充', tooltip: '等比填充 contain' },
{ value: 'cover', text: '等比覆盖', tooltip: '等比覆盖 cover' },
],
rules: [
{
typeMatch: false,
},
{
validator: ({ value, callback }) => {
if (value === '' || value === null || value === undefined) {
return callback();
}
const keywords = ['auto', 'cover', 'contain', 'inherit', 'initial', 'revert', 'unset'];
// 单值:关键字 或 长度/百分比
const lengthPercent = /^-?\d+(\.\d+)?(px|em|rem|ex|ch|vw|vh|vmin|vmax|cm|mm|in|pt|pc|%)$/;
const singleValue = (v: string) => keywords.includes(v) || lengthPercent.test(v);
const str = String(value).trim();
const parts = str.split(/\s+/);
// cover / contain 不能与其他值组合
if (parts.length > 1 && (parts.includes('cover') || parts.includes('contain'))) {
return callback('cover/contain 不能与其他值组合');
}
// 多值最多两个
if (parts.length > 2) {
return callback('backgroundSize 最多支持两个值');
}
// 关键字 auto 在多值场景中允许与其他长度/百分比组合
if (parts.every((part) => singleValue(part))) {
return callback();
}
return callback('backgroundSize 值不合法');
},
},
],
}),
defineFormItem({
name: 'backgroundRepeat',
text: '重复显示',
type: 'radioGroup',
childType: 'button',
labelWidth: '68px',
options: [
{ value: 'no-repeat', icon: markRaw(BackgroundNoRepeat), tooltip: '不重复 no-repeat' },
{ value: 'repeat-x', icon: markRaw(BackgroundRepeatX), tooltip: '水平方向重复 repeat-x' },
{ value: 'repeat-y', icon: markRaw(BackgroundRepeatY), tooltip: '垂直方向重复 repeat-y' },
{
value: 'repeat',
icon: markRaw(BackgroundRepeat),
tooltip: '垂直和水平方向重复 repeat',
},
],
}),
defineFormItem({
name: 'backgroundPosition',
text: '背景定位',
type: 'component',
component: BackgroundPosition,
labelWidth: '68px',
}),
];
/**
*
*
* / `type-match-rules`
* `validateDataSourceFieldSelect`
*
*/
export const createFontConfig = (validateDataSourceField: typeof validateDataSourceFieldSelect): FormConfig => [
defineFormItem({
type: 'row',
items: [
{
labelWidth: '68px',
name: 'fontSize',
text: '字号',
type: 'data-source-field-select',
fieldConfig: {
type: 'text',
},
rules: [
{
typeMatch: true,
message: appendValidateSuggestion('字号应为字符串或数字', '请参考以下示例值24 或 "24"'),
},
],
},
{
labelWidth: '68px',
name: 'lineHeight',
text: '行高',
type: 'data-source-field-select',
fieldConfig: {
type: 'text',
},
},
],
}),
defineFormItem({
name: 'fontWeight',
text: '字重',
labelWidth: '68px',
type: 'data-source-field-select',
dataSourceFieldType: ['string', 'number'],
fieldConfig: {
type: 'select',
allowCreate: true,
options: ['normal', 'bold']
.concat(
Array(7)
.fill(1)
.map((x, i) => `${i + 1}00`),
)
.map((item) => ({
value: item,
text: item,
})),
},
rules: [
{
typeMatch: false,
},
{
validator: ({ value, callback }, { config, model, prop }, mForm) => {
if (value === '' || value === null || value === undefined) {
return callback();
}
const result = validateDataSourceField(
value,
{
fieldType: 'data-source-field-select',
mForm,
props: { config, model, prop },
},
{
// 字重允许 string含可创建项与 number如 700
validatePlainValue: (plainValue) => {
if (typeof plainValue === 'string' || (typeof plainValue === 'number' && !Number.isNaN(plainValue))) {
return undefined;
}
return '字重应为字符串或数字';
},
},
);
if (result && typeof (result as Promise<string | undefined>).then === 'function') {
(result as Promise<string | undefined>).then(
(error) => callback(error),
(error) => callback(error),
);
return;
}
return callback(result);
},
},
],
}),
defineFormItem({
labelWidth: '68px',
name: 'color',
text: '颜色',
type: 'data-source-field-select',
fieldConfig: {
type: 'colorPicker',
},
rules: [
{
typeMatch: true,
message: appendValidateSuggestion('颜色应为字符串', '请参考以下示例值:"#000000"'),
},
],
}),
defineFormItem({
name: 'textAlign',
text: '对齐',
type: 'radioGroup',
childType: 'button',
labelWidth: '68px',
options: [
{ value: 'left', icon: markRaw(AlignLeft), tooltip: '左对齐 row', text: '左对齐' },
{ value: 'center', icon: markRaw(AlignCenter), tooltip: '居中对齐 center', text: '居中对齐' },
{ value: 'right', icon: markRaw(AlignRight), tooltip: '右对齐 right', text: '右对齐' },
],
}),
];
/** 「边框与圆角」面板中圆角部分的配置,边框四向配置见 `createBorderDirectionConfig`。 */
export const borderRadiusConfig = defineFormItem({
labelWidth: '68px',
name: 'borderRadius',
text: '圆角',
type: 'data-source-field-select',
fieldConfig: {
type: 'text',
},
});
/** 「变形」面板配置。 */
export const transformConfig = defineFormItem({
name: 'transform',
items: [
{
name: 'rotate',
text: '旋转角度',
labelWidth: '68px',
type: 'data-source-field-select',
checkStrictly: false,
dataSourceFieldType: ['string', 'number'],
fieldConfig: {
type: 'text',
},
},
{
name: 'scale',
text: '缩放',
labelWidth: '68px',
type: 'data-source-field-select',
checkStrictly: false,
dataSourceFieldType: ['string', 'number'],
fieldConfig: {
type: 'text',
},
},
],
});
/**
* 6 FormItem `Index.vue`
*
*
*
* - Layout Boxmargin/padding input MContainer
* - Border MContainer `:prop`
*
* `theme` flexWrap UI `childType`
*/
export const createStyleSetterConfig = (
values: Partial<StyleSchema>,
theme: string,
validateDataSourceField: typeof validateDataSourceFieldSelect,
): FormConfig => [
...createLayoutConfig(theme),
...createPositionConfig(values),
...createBackgroundConfig(),
...createFontConfig(validateDataSourceField),
borderRadiusConfig,
transformConfig,
];
/**
*
*
* `direction` ''() / 'Top' / 'Right' / 'Bottom' / 'Left'
* `borderWidth`
*/
export const createBorderDirectionConfig = (direction: string) =>
defineFormItem({
items: [
{
name: `border${direction}Width`,
text: '边框宽度',
labelWidth: '68px',
type: 'data-source-field-select',
fieldConfig: {
type: 'text',
},
},
{
name: `border${direction}Color`,
text: '边框颜色',
labelWidth: '68px',
type: 'data-source-field-select',
fieldConfig: {
type: 'colorPicker',
},
},
{
name: `border${direction}Style`,
text: '边框样式',
labelWidth: '68px',
type: 'data-source-field-select',
fieldConfig: {
type: 'select',
options: ['solid', 'dashed', 'dotted'].map((item) => ({
value: item,
text: item,
})),
},
},
],
});

View File

@ -15,12 +15,13 @@
</template>
<script lang="ts" setup>
import { computed } from 'vue';
import { markRaw } from 'vue';
import { type ContainerChangeEventData, MContainer } from '@tmagic/form';
import { type ContainerChangeEventData, defineFormConfig, MContainer } from '@tmagic/form';
import type { StyleSchema } from '@tmagic/schema';
import { createBackgroundConfig } from '../configs';
import BackgroundPosition from '../components/BackgroundPosition.vue';
import { BackgroundNoRepeat, BackgroundRepeat, BackgroundRepeatX, BackgroundRepeatY } from '../icons/background-repeat';
defineProps<{
values: Partial<StyleSchema>;
@ -37,7 +38,99 @@ const emit = defineEmits<{
addDiffCount: [];
}>();
const formConfig = computed(() => createBackgroundConfig());
const formConfig = defineFormConfig([
{
name: 'backgroundColor',
text: '背景色',
labelWidth: '68px',
type: 'data-source-field-select',
fieldConfig: {
type: 'colorPicker',
},
},
{
name: 'backgroundImage',
text: '背景图',
labelWidth: '68px',
type: 'data-source-field-select',
fieldConfig: {
type: 'img-upload',
} as any,
},
{
name: 'backgroundSize',
text: '背景尺寸',
type: 'radioGroup',
childType: 'button',
labelWidth: '68px',
options: [
{ value: 'auto', text: '默认', tooltip: '默认 auto' },
{ value: 'contain', text: '等比填充', tooltip: '等比填充 contain' },
{ value: 'cover', text: '等比覆盖', tooltip: '等比覆盖 cover' },
],
rules: [
{
typeMatch: false,
},
{
validator: ({ value, callback }) => {
if (value === '' || value === null || value === undefined) {
return callback();
}
const keywords = ['auto', 'cover', 'contain', 'inherit', 'initial', 'revert', 'unset'];
// /
const lengthPercent = /^-?\d+(\.\d+)?(px|em|rem|ex|ch|vw|vh|vmin|vmax|cm|mm|in|pt|pc|%)$/;
const singleValue = (v: string) => keywords.includes(v) || lengthPercent.test(v);
const str = String(value).trim();
const parts = str.split(/\s+/);
// cover / contain
if (parts.length > 1 && (parts.includes('cover') || parts.includes('contain'))) {
return callback('cover/contain 不能与其他值组合');
}
//
if (parts.length > 2) {
return callback('backgroundSize 最多支持两个值');
}
// auto /
if (parts.every((part) => singleValue(part))) {
return callback();
}
return callback('backgroundSize 值不合法');
},
},
],
},
{
name: 'backgroundRepeat',
text: '重复显示',
type: 'radioGroup',
childType: 'button',
labelWidth: '68px',
options: [
{ value: 'no-repeat', icon: markRaw(BackgroundNoRepeat), tooltip: '不重复 no-repeat' },
{ value: 'repeat-x', icon: markRaw(BackgroundRepeatX), tooltip: '水平方向重复 repeat-x' },
{ value: 'repeat-y', icon: markRaw(BackgroundRepeatY), tooltip: '垂直方向重复 repeat-y' },
{
value: 'repeat',
icon: markRaw(BackgroundRepeat),
tooltip: '垂直和水平方向重复 repeat',
},
],
},
{
name: 'backgroundPosition',
text: '背景定位',
type: 'component',
component: BackgroundPosition,
labelWidth: '68px',
},
]);
const change = (value: StyleSchema, eventData: ContainerChangeEventData) => {
emit('change', value, eventData);

View File

@ -1,7 +1,7 @@
<template>
<MContainer
:prop="prop"
:config="borderRadiusConfig"
:config="config"
:model="values"
:last-values="lastValues"
:is-compare="isCompare"
@ -22,11 +22,10 @@
</template>
<script lang="ts" setup>
import { type ContainerChangeEventData, MContainer } from '@tmagic/form';
import { type ContainerChangeEventData, defineFormItem, MContainer } from '@tmagic/form';
import type { StyleSchema } from '@tmagic/schema';
import Border from '../components/Border.vue';
import { borderRadiusConfig } from '../configs';
defineProps<{
values: Partial<StyleSchema>;
@ -42,6 +41,16 @@ const emit = defineEmits<{
addDiffCount: [];
}>();
const config = defineFormItem({
labelWidth: '68px',
name: 'borderRadius',
text: '圆角',
type: 'data-source-field-select',
fieldConfig: {
type: 'text',
},
});
const change = (value: StyleSchema, eventData: ContainerChangeEventData) => {
emit('change', value, eventData);
};

View File

@ -15,14 +15,12 @@
</template>
<script lang="ts" setup>
import { computed } from 'vue';
import { markRaw } from 'vue';
import { type ContainerChangeEventData, MContainer } from '@tmagic/form';
import { type ContainerChangeEventData, defineFormConfig, MContainer } from '@tmagic/form';
import type { StyleSchema } from '@tmagic/schema';
import { validateDataSourceFieldSelect } from '@editor/utils/type-match-rules';
import { createFontConfig } from '../configs';
import { AlignCenter, AlignLeft, AlignRight } from '../icons/text-align';
defineProps<{
values: Partial<StyleSchema>;
@ -38,7 +36,71 @@ const emit = defineEmits<{
addDiffCount: [];
}>();
const formConfig = computed(() => createFontConfig(validateDataSourceFieldSelect));
const formConfig = defineFormConfig([
{
type: 'row',
items: [
{
labelWidth: '68px',
name: 'fontSize',
text: '字号',
type: 'data-source-field-select',
fieldConfig: {
type: 'text',
},
},
{
labelWidth: '68px',
name: 'lineHeight',
text: '行高',
type: 'data-source-field-select',
fieldConfig: {
type: 'text',
},
},
],
},
{
name: 'fontWeight',
text: '字重',
labelWidth: '68px',
type: 'data-source-field-select',
fieldConfig: {
type: 'select',
options: ['normal', 'bold']
.concat(
Array(7)
.fill(1)
.map((x, i) => `${i + 1}00`),
)
.map((item) => ({
value: item,
text: item,
})),
},
},
{
labelWidth: '68px',
name: 'color',
text: '颜色',
type: 'data-source-field-select',
fieldConfig: {
type: 'colorPicker',
},
},
{
name: 'textAlign',
text: '对齐',
type: 'radioGroup',
childType: 'button',
labelWidth: '68px',
options: [
{ value: 'left', icon: markRaw(AlignLeft), tooltip: '左对齐 row', text: '左对齐' },
{ value: 'center', icon: markRaw(AlignCenter), tooltip: '居中对齐 center', text: '居中对齐' },
{ value: 'right', icon: markRaw(AlignRight), tooltip: '右对齐 right', text: '右对齐' },
],
},
]);
const change = (value: StyleSchema, eventData: ContainerChangeEventData) => {
emit('change', value, eventData);

View File

@ -24,15 +24,35 @@
</template>
<script lang="ts" setup>
import { computed } from 'vue';
import { markRaw } from 'vue';
import { useTheme } from '@tmagic/design';
import type { ContainerChangeEventData } from '@tmagic/form';
import { MContainer } from '@tmagic/form';
import { defineFormConfig, MContainer } from '@tmagic/form';
import type { StyleSchema } from '@tmagic/schema';
import Box from '../components/Box.vue';
import { createLayoutConfig } from '../configs';
import {
AlignItemsCenter,
AlignItemsFlexEnd,
AlignItemsFlexStart,
AlignItemsSpaceAround,
AlignItemsSpaceBetween,
} from '../icons/align-items';
import { DisplayBlock, DisplayFlex, DisplayInline, DisplayInlineBlock, DisplayNone } from '../icons/display';
import {
FlexDirectionColumn,
FlexDirectionColumnReverse,
FlexDirectionRow,
FlexDirectionRowReverse,
} from '../icons/flex-direction';
import {
JustifyContentCenter,
JustifyContentFlexEnd,
JustifyContentFlexStart,
JustifyContentSpaceAround,
JustifyContentSpaceBetween,
} from '../icons/justify-content';
const props = defineProps<{
values: Partial<StyleSchema>;
@ -51,7 +71,202 @@ const emit = defineEmits<{
const displayTheme = useTheme(props);
const formConfig = computed(() => createLayoutConfig(displayTheme.value));
const formConfig = defineFormConfig([
{
name: 'display',
text: '模式',
type: 'radioGroup',
childType: 'button',
labelWidth: '90px',
iconSize: '24px',
options: [
{
value: 'inline',
icon: markRaw(DisplayInline),
tooltip: '内联布局 inline',
},
{
value: 'flex',
icon: markRaw(DisplayFlex),
tooltip: '弹性布局 flex',
},
{
value: 'block',
icon: markRaw(DisplayBlock),
tooltip: '块级布局 block',
},
{
value: 'inline-block',
icon: markRaw(DisplayInlineBlock),
tooltip: '内联块布局 inline-block',
},
{
value: 'none',
icon: markRaw(DisplayNone),
tooltip: '隐藏 none',
},
],
},
{
name: 'flexDirection',
text: '主轴方向',
type: 'radioGroup',
childType: 'button',
labelWidth: '90px',
iconSize: '24px',
options: [
{ value: 'row', icon: markRaw(FlexDirectionRow), tooltip: '水平方向 起点在左侧 row' },
{
value: 'row-reverse',
icon: markRaw(FlexDirectionRowReverse),
tooltip: '水平方向 起点在右侧 row-reverse',
},
{
value: 'column',
icon: markRaw(FlexDirectionColumn),
tooltip: '垂直方向 起点在上沿 column',
},
{
value: 'column-reverse',
icon: markRaw(FlexDirectionColumnReverse),
tooltip: '垂直方向 起点在下沿 column-reverse',
},
],
display: (_mForm, { model }: { model: Record<any, any> }) => model.display === 'flex',
},
{
name: 'justifyContent',
text: '主轴对齐',
type: 'radioGroup',
childType: 'button',
labelWidth: '90px',
iconSize: '24px',
options: [
{ value: 'flex-start', icon: markRaw(JustifyContentFlexStart), tooltip: '左对齐 flex-start' },
{ value: 'flex-end', icon: markRaw(JustifyContentFlexEnd), tooltip: '右对齐 flex-end' },
{ value: 'center', icon: markRaw(JustifyContentCenter), tooltip: '居中 center' },
{
value: 'space-between',
icon: markRaw(JustifyContentSpaceBetween),
tooltip: '两端对齐 space-between',
},
{
value: 'space-around',
icon: markRaw(JustifyContentSpaceAround),
tooltip: '横向平分 space-around',
},
],
display: (_mForm, { model }: { model: Record<any, any> }) => model.display === 'flex',
},
{
name: 'alignItems',
text: '辅轴对齐',
type: 'radioGroup',
childType: 'button',
labelWidth: '90px',
iconSize: '24px',
options: [
{ value: 'flex-start', icon: markRaw(AlignItemsFlexStart), tooltip: '左对齐 flex-start' },
{ value: 'flex-end', icon: markRaw(AlignItemsFlexEnd), tooltip: '右对齐 flex-end' },
{ value: 'center', icon: markRaw(AlignItemsCenter), tooltip: '居中 center' },
{
value: 'space-between',
icon: markRaw(AlignItemsSpaceBetween),
tooltip: '两端对齐 space-between',
},
{
value: 'space-around',
icon: markRaw(AlignItemsSpaceAround),
tooltip: '横向平分 space-around',
},
],
display: (_mForm, { model }: { model: Record<any, any> }) => model.display === 'flex',
},
{
name: 'flexWrap',
text: '换行',
type: 'radioGroup',
childType: displayTheme.value !== 'magic-admin' ? 'button' : 'default',
labelWidth: '90px',
iconSize: '24px',
options: [
{ value: 'nowrap', text: '不换行', tooltip: '不换行 nowrap' },
{ value: 'wrap', text: '正换行', tooltip: '第一行在上方 wrap' },
{ value: 'wrap-reverse', text: '逆换行', tooltip: '第一行在下方 wrap-reverse' },
],
display: (_mForm, { model }: { model: Record<any, any> }) => model.display === 'flex',
},
{
type: 'row',
items: [
{
name: 'width',
text: '宽度px',
labelWidth: '90px',
type: 'data-source-field-select',
fieldConfig: {
type: 'text',
},
},
],
},
{
type: 'row',
items: [
{
name: 'height',
text: '高度px',
labelWidth: '90px',
type: 'data-source-field-select',
fieldConfig: {
type: 'text',
},
},
],
},
{
type: 'row',
items: [
{
type: 'data-source-field-select',
text: 'overflow',
name: 'overflow',
labelWidth: '90px',
checkStrictly: false,
dataSourceFieldType: ['string'],
fieldConfig: {
type: 'select',
clearable: true,
allowCreate: true,
options: [
{ text: 'visible', value: 'visible' },
{ text: 'hidden', value: 'hidden' },
{ text: 'clip', value: 'clip' },
{ text: 'scroll', value: 'scroll' },
{ text: 'auto', value: 'auto' },
{ text: 'overlay', value: 'overlay' },
{ text: 'initial', value: 'initial' },
],
},
},
],
},
{
type: 'row',
items: [
{
type: 'data-source-field-select',
text: '透明度(%',
name: 'opacity',
labelWidth: '90px',
dataSourceFieldType: ['string', 'number'],
fieldConfig: {
type: 'text',
},
},
],
},
]);
const change = (value: string | StyleSchema, eventData: ContainerChangeEventData) => {
emit('change', value, eventData);

View File

@ -15,13 +15,9 @@
</template>
<script lang="ts" setup>
import { computed } from 'vue';
import { type ContainerChangeEventData, MContainer } from '@tmagic/form';
import { type ContainerChangeEventData, defineFormConfig, MContainer } from '@tmagic/form';
import type { StyleSchema } from '@tmagic/schema';
import { createPositionConfig } from '../configs';
const props = defineProps<{
values: Partial<StyleSchema>;
lastValues?: Partial<StyleSchema>;
@ -36,7 +32,84 @@ const emit = defineEmits<{
addDiffCount: [];
}>();
const formConfig = computed(() => createPositionConfig(props.values));
const positionText: Record<string, string> = {
static: '不定位',
relative: '相对定位',
absolute: '绝对定位',
fixed: '固定定位',
sticky: '粘性定位',
};
const formConfig = defineFormConfig([
{
name: 'position',
text: '定位',
labelWidth: '68px',
type: 'data-source-field-select',
fieldConfig: {
type: 'select',
options: Object.keys(positionText).map((item) => ({
value: item,
text: `${item}(${positionText[item]})`,
})),
},
},
{
type: 'row',
labelWidth: '68px',
display: () => props.values.position !== 'static',
items: [
{
name: 'left',
type: 'data-source-field-select',
text: 'left',
fieldConfig: {
type: 'text',
},
},
{
name: 'top',
type: 'data-source-field-select',
text: 'top',
fieldConfig: {
type: 'text',
},
},
],
},
{
type: 'row',
labelWidth: '68px',
display: () => props.values.position !== 'static',
items: [
{
name: 'right',
type: 'data-source-field-select',
text: 'right',
fieldConfig: {
type: 'text',
},
},
{
name: 'bottom',
type: 'data-source-field-select',
text: 'bottom',
fieldConfig: {
type: 'text',
},
},
],
},
{
labelWidth: '68px',
name: 'zIndex',
text: 'zIndex',
type: 'data-source-field-select',
fieldConfig: {
type: 'text',
},
},
]);
const change = (value: string | StyleSchema, eventData: ContainerChangeEventData) => {
emit('change', value, eventData);

View File

@ -1,7 +1,7 @@
<template>
<MContainer
:prop="prop"
:config="transformConfig"
:config="config"
:model="values"
:last-values="lastValues"
:is-compare="isCompare"
@ -13,11 +13,9 @@
</template>
<script lang="ts" setup>
import { type ContainerChangeEventData, MContainer } from '@tmagic/form';
import { type ContainerChangeEventData, defineFormItem, MContainer } from '@tmagic/form';
import type { StyleSchema } from '@tmagic/schema';
import { transformConfig } from '../configs';
defineProps<{
values: Partial<StyleSchema>;
lastValues?: Partial<StyleSchema>;
@ -32,6 +30,34 @@ const emit = defineEmits<{
addDiffCount: [];
}>();
const config = defineFormItem({
name: 'transform',
items: [
{
name: 'rotate',
text: '旋转角度',
labelWidth: '68px',
type: 'data-source-field-select',
checkStrictly: false,
dataSourceFieldType: ['string', 'number'],
fieldConfig: {
type: 'text',
},
},
{
name: 'scale',
text: '缩放',
labelWidth: '68px',
type: 'data-source-field-select',
checkStrictly: false,
dataSourceFieldType: ['string', 'number'],
fieldConfig: {
type: 'text',
},
},
],
});
const change = (value: StyleSchema, eventData: ContainerChangeEventData) => {
emit('change', value, eventData);
};

View File

@ -1,127 +0,0 @@
/*
* Tencent is pleased to support the open source community by making TMagicEditor available.
*
* Copyright (C) 2025 Tencent. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { isEmpty } from 'lodash-es';
import { HookCodeType, HookType } from '@tmagic/core';
import type { CodeSelectConfig, FormValue, GroupListConfig } from '@tmagic/form/headless';
import codeBlockService from '@editor/services/codeBlock';
import dataSourceService from '@editor/services/dataSource';
import { stickyAddButton } from './stickyAddButton';
/**
* `fields/CodeSelect.vue`
*
*
*/
export const createCodeSelectConfig = (config: CodeSelectConfig): GroupListConfig => {
const groupListConfig: GroupListConfig = {
type: 'group-list',
name: 'hookData',
enableToggleMode: false,
expandAll: true,
defaultAdd: () => ({
codeType: HookCodeType.CODE,
codeId: '',
}),
...stickyAddButton(`添加${config.text || ''}`),
title: (_mForm: any, { model, index }: any) => {
if (model.codeType === HookCodeType.DATA_SOURCE_METHOD) {
if (Array.isArray(model.codeId)) {
if (model.codeId.length < 2) {
return index;
}
const ds = dataSourceService.getDataSourceById(model.codeId[0]);
return `${ds?.title} / ${model.codeId[1]}`;
}
return Array.isArray(model.codeId) ? model.codeId.join('/') : index;
}
const codeContent = codeBlockService.getCodeContentById(model.codeId);
if (codeContent) {
return codeContent.name;
}
return model.codeId || index;
},
titlePrefix: config.name === undefined ? undefined : String(config.name),
items: [
{
text: '代码类型',
type: 'select',
name: 'codeType',
rules: [{ typeMatch: true, trigger: 'change' }],
options: [
{ value: HookCodeType.CODE, text: '代码块' },
{ value: HookCodeType.DATA_SOURCE_METHOD, text: '数据源方法' },
],
defaultValue: HookCodeType.CODE,
onChange: (_mForm: any, v: HookCodeType, { setModel }: any) => {
if (v === HookCodeType.DATA_SOURCE_METHOD) {
setModel('codeId', []);
} else {
setModel('codeId', '');
}
return v;
},
},
{
type: 'code-select-col',
name: 'codeId',
text: '代码块',
rules: [{ typeMatch: true, trigger: 'change' }],
display: (_mForm: any, { model }: any) => model.codeType !== HookCodeType.DATA_SOURCE_METHOD,
notEditable: () => !codeBlockService.getEditStatus(),
},
{
type: 'data-source-method-select',
name: 'codeId',
text: '数据源字段',
rules: [{ typeMatch: true, trigger: 'change' }],
display: (_mForm: any, { model }: any) => model.codeType === HookCodeType.DATA_SOURCE_METHOD,
notEditable: () => !dataSourceService.get('editable'),
},
],
} as any as GroupListConfig;
return groupListConfig;
};
/**
* `code-select` `{ hookType, hookData }`
*
* `code-select` `effect` `applyMountValueEffects`
* `watch` immediate
*/
export const normalizeCodeSelectValue = (model: FormValue | undefined, name: string): void => {
if (!model) return;
// 空值或者空数组
if (isEmpty(model[name])) {
model[name] = {
hookType: HookType.CODE,
hookData: [],
};
}
};

View File

@ -1,184 +0,0 @@
/*
* Tencent is pleased to support the open source community by making TMagicEditor available.
*
* Copyright (C) 2025 Tencent. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import type { DisplayCondsConfig, FormState, GroupListConfig } from '@tmagic/form/headless';
import { removeDataSourceFieldPrefix } from '@tmagic/utils';
import dataSourceService from '@editor/services/dataSource';
import { getCascaderOptionsFromFields, getFieldType } from '@editor/utils/data-source';
import { stickyAddButton } from './stickyAddButton';
/**
* `fields/DisplayConds.vue`
*
* `cond` groupList
*
*
* `parentFields` cascader
* data-source-field-select
*/
export const createDisplayCondsConfig = (
config: Pick<DisplayCondsConfig, 'titlePrefix' | 'flat' | 'defaultValue' | 'rules'>,
name: string,
parentFields: string[],
): GroupListConfig => {
const resolveFieldPath = (path: string[]) => {
const [id, ...fieldNames] = path;
const ds = id ? dataSourceService.getDataSourceById(removeDataSourceFieldPrefix(`${id}`)) : undefined;
return { ds, fieldNames };
};
// 字段变更后按新字段的类型把已填的值转成对应类型,避免类型校验与运行期取值不一致
const fieldOnChange = (_formState: FormState | undefined, v: string[], { model }: { model: Record<string, any> }) => {
const { ds, fieldNames } = resolveFieldPath([...parentFields, ...v]);
const type = getFieldType(ds, fieldNames);
if (type === 'number') {
model.value = Number(model.value);
} else if (type === 'boolean') {
model.value = Boolean(model.value);
} else if (type === 'null') {
model.value = null;
} else {
model.value = `${model.value}`;
}
return v;
};
const fieldItem = parentFields.length
? {
type: 'cascader',
options: () => {
const { ds, fieldNames } = resolveFieldPath(parentFields);
if (!ds) {
return [];
}
let fields = ds.fields || [];
fieldNames.forEach((key) => {
const field = fields.find((f) => f.name === key);
fields = field?.fields || [];
});
return getCascaderOptionsFromFields(fields, ['string', 'number', 'boolean', 'any']);
},
name: 'field',
value: 'key',
text: '字段',
checkStrictly: false,
onChange: fieldOnChange,
defaultValue: () => [],
rules: [
{ required: true, trigger: 'blur', message: '请选择字段' },
{ typeMatch: true, trigger: 'change' },
],
}
: {
type: 'data-source-field-select',
name: 'field',
value: 'key',
text: '字段',
checkStrictly: false,
dataSourceFieldType: ['string', 'number', 'boolean', 'any'],
onChange: fieldOnChange,
defaultValue: () => [],
rules: [
{ required: true, trigger: 'blur', message: '请选择字段' },
{ typeMatch: true, trigger: 'change' },
],
};
return {
type: 'groupList',
name,
titlePrefix: config.titlePrefix,
expandAll: true,
enableToggleMode: false,
defaultAdd: { cond: [] },
...stickyAddButton(`新增${config.titlePrefix || '条件组'}`),
flat: config.flat,
defaultValue: config.defaultValue ?? [],
rules: config.rules ?? [{ typeMatch: true }],
items: [
{
type: 'groupList',
name: 'cond',
titlePrefix: '条件',
expandAll: true,
enableToggleMode: false,
copyable: true,
movable: false,
flat: true,
labelWidth: '80px',
...stickyAddButton('新增条件'),
items: [
fieldItem,
{
type: 'cond-op-select',
parentFields,
text: '条件',
name: 'op',
rules: [
{ required: true, trigger: 'blur', message: '请选择条件' },
{ typeMatch: true, trigger: 'change' },
],
},
{
name: 'value',
text: '值',
type: (_mForm: FormState | undefined, { model }: any) => {
const { ds, fieldNames } = resolveFieldPath([...parentFields, ...(model.field || [])]);
const type = getFieldType(ds, fieldNames);
if (type === 'number') {
return 'number';
}
if (type === 'boolean') {
return 'select';
}
if (type === 'null') {
return 'display';
}
return 'text';
},
options: [
{ text: 'true', value: true },
{ text: 'false', value: false },
],
display: (_mForm: FormState | undefined, { model }: any) => !['between', 'not_between'].includes(model.op),
displayText: (_mForm: FormState | undefined, { model }: any) => {
if (model.value === null) {
return 'null';
}
return model.value;
},
},
{
name: 'range',
text: '值',
type: 'number-range',
display: (_mForm: FormState | undefined, { model }: any) => ['between', 'not_between'].includes(model.op),
},
],
},
],
} as any as GroupListConfig;
};

View File

@ -1,309 +0,0 @@
/*
* Tencent is pleased to support the open source community by making TMagicEditor available.
*
* Copyright (C) 2025 Tencent. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { has } from 'lodash-es';
import { ActionType, type MNode } from '@tmagic/core';
import type {
CodeSelectColConfig,
DataSourceMethodSelectConfig,
DynamicTypeConfig,
EventSelectConfig,
FormState,
GroupListConfig,
TableConfig,
UISelectConfig,
} from '@tmagic/form/headless';
import { defineFormItem } from '@tmagic/form/headless';
import codeBlockService from '@editor/services/codeBlock';
import dataSourceService from '@editor/services/dataSource';
import editorService from '@editor/services/editor';
import eventsService from '@editor/services/events';
import propsService from '@editor/services/props';
import {
getCompActionAllowedValues,
getCompActionOptions,
getEventNameAllowedValues,
getEventNameOptions,
normalizeCompActionValue,
} from '@editor/utils';
import { stickyAddButton } from './stickyAddButton';
/**
* `fields/EventSelect.vue`
*
*
* `config.xxxConfig`
*/
/** 事件名称下拉框配置,渲染在每张事件卡片的头部 */
export const createEventNameConfig = (config: EventSelectConfig) => {
const defaultEventNameConfig = {
name: 'name',
text: '事件类型',
type: (_mForm: FormState | undefined, { formValue }: any) => {
if (config.src !== 'component' || (formValue.type === 'page-fragment-container' && formValue.pageFragmentId)) {
return 'cascader';
}
return 'select';
},
labelWidth: '70px',
checkStrictly: () => config.src !== 'component',
valueSeparator: '.',
options: (_mForm: FormState, { formValue }: any) => getEventNameOptions(config.src, formValue),
rules: [
{
validator: ({ value, callback }: any, { formValue }: any) => {
const allowedNames = getEventNameAllowedValues(config as any, formValue);
if (allowedNames && allowedNames.size > 0 && value && !allowedNames.has(value)) {
return callback(`事件名(${value})不存在`);
}
callback();
},
trigger: 'blur',
},
],
};
return { ...defaultEventNameConfig, ...config.eventNameConfig };
};
const createActionTypeOptions = () => {
const o: {
text: string;
label: string;
value: string;
disabled?: boolean;
}[] = [
{
text: '组件',
label: '组件',
value: ActionType.COMP,
},
];
if (!propsService.getDisabledCodeBlock()) {
o.push({
text: '代码',
label: '代码',
disabled: !Object.keys(codeBlockService.getCodeDsl() || {}).length,
value: ActionType.CODE,
});
}
if (!propsService.getDisabledDataSource()) {
o.push({
text: '数据源',
label: '数据源',
value: ActionType.DATA_SOURCE,
});
}
return o;
};
/** 联动类型 */
const createActionTypeConfig = (config: EventSelectConfig) => {
const defaultActionTypeConfig = {
name: 'actionType',
text: '联动类型',
type: 'select',
defaultValue: ActionType.COMP,
options: createActionTypeOptions(),
rules: [
{
required: true,
message: '联动类型不能为空',
},
{
typeMatch: true,
trigger: 'blur',
},
],
onChange: (_mForm: FormState, _v: string, { setModel }: any) => {
setModel('to', '');
setModel('method', '');
setModel('codeId', '');
setModel('dataSourceMethod', []);
},
};
return { ...defaultActionTypeConfig, ...config.actionTypeConfig };
};
/** 联动组件 */
const createTargetCompConfig = (config: EventSelectConfig) => {
const defaultTargetCompConfig: UISelectConfig = {
name: 'to',
text: '联动组件',
type: 'ui-select',
display: (_mForm, { model }) => model.actionType === ActionType.COMP,
onChange: (_mForm, _v, { setModel }) => {
setModel('method', '');
},
rules: [
{
typeMatch: true,
trigger: 'blur',
},
],
};
return { ...defaultTargetCompConfig, ...config.targetCompConfig };
};
/** 联动组件动作 */
const createCompActionConfig = (config: EventSelectConfig) => {
const defaultCompActionConfig: DynamicTypeConfig = {
name: 'method',
text: '动作',
type: (_mForm: FormState | undefined, { model }: any) => {
const to = editorService.getNodeById(model.to);
if (to?.type === 'page-fragment-container' && to.pageFragmentId) {
return 'cascader';
}
return 'select';
},
checkStrictly: () => config.src !== 'component',
display: (_mForm: FormState | undefined, { model }: any) => model.actionType === ActionType.COMP,
options: (_mForm: FormState, { model }: any) => getCompActionOptions(model.to),
rules: [
{
trigger: 'blur',
validator: ({ value, callback }: any, { model }: any) => {
const allowedMethods = getCompActionAllowedValues(config as any, model);
const normalized = normalizeCompActionValue(value);
if (allowedMethods && allowedMethods.size > 0 && normalized && !allowedMethods.has(normalized)) {
return callback(`动作名(${normalized})不存在`);
}
callback();
},
},
],
};
return { ...defaultCompActionConfig, ...config.compActionConfig };
};
/** 代码联动 */
const createCodeActionConfig = (config: EventSelectConfig) => {
const defaultCodeActionConfig: CodeSelectColConfig = {
type: 'code-select-col',
text: '代码块',
name: 'codeId',
notEditable: () => !codeBlockService.getEditStatus(),
display: (_mForm, { model }) => model.actionType === ActionType.CODE,
};
return { ...defaultCodeActionConfig, ...config.codeActionConfig };
};
/** 数据源联动 */
const createDataSourceActionConfig = (config: EventSelectConfig) => {
const defaultDataSourceActionConfig: DataSourceMethodSelectConfig = {
type: 'data-source-method-select',
text: '数据源方法',
name: 'dataSourceMethod',
notEditable: () => !dataSourceService.get('editable'),
display: (_mForm, { model }) => model.actionType === ActionType.DATA_SOURCE,
};
return { ...defaultDataSourceActionConfig, ...config.dataSourceActionConfig };
};
/** 单张事件里的动作组 */
export const createActionsConfig = (config: EventSelectConfig): GroupListConfig =>
defineFormItem({
type: 'group-list',
name: 'actions',
expandAll: true,
enableToggleMode: false,
titlePrefix: '动作',
labelPosition: 'top',
flat: true,
...stickyAddButton('新增动作'),
items: [
createActionTypeConfig(config),
createTargetCompConfig(config),
createCompActionConfig(config),
createCodeActionConfig(config),
createDataSourceActionConfig(config),
],
}) as GroupListConfig;
/** 事件列表(外层 group-list。事件名走 title slotbody 只放动作组。 */
export const createEventSelectConfig = (
config: EventSelectConfig,
name: string,
options?: { includeEventName?: boolean },
): GroupListConfig =>
defineFormItem({
type: 'group-list',
name,
titlePrefix: '事件',
expandAll: true,
enableToggleMode: false,
movable: false,
defaultAdd: { name: '', actions: [] },
...stickyAddButton('添加事件'),
items: [...(options?.includeEventName ? [createEventNameConfig(config)] : []), createActionsConfig(config)],
}) as GroupListConfig;
/** 兼容旧数据格式(事件列表里没有 actions时渲染的表格配置本身不带校验规则 */
export const createLegacyTableConfig = (config: EventSelectConfig): TableConfig =>
defineFormItem({
type: 'table',
name: 'events',
items: [
{
name: 'name',
label: '事件名',
type: createEventNameConfig(config).type,
options: (_mForm: FormState, { formValue }: any) =>
eventsService
.getEvent(formValue.type, { node: editorService.getNodeById(formValue.id) })
.map((option: any) => ({
text: option.label,
value: option.value,
})),
},
{
name: 'to',
label: '联动组件',
type: 'ui-select',
},
{
name: 'method',
label: '动作',
type: createCompActionConfig(config).type,
options: (_mForm: FormState, { model, formValue }: any) => {
const node = editorService.getNodeById(model.to) || (formValue as MNode);
if (!node?.type) return [];
return eventsService.getMethod(node.type, { targetId: model.to, node }).map((option: any) => ({
text: option.label,
value: option.value,
}));
},
},
],
}) as TableConfig;
/** 事件列表是否为旧数据格式(列表项里没有 actions */
export const isLegacyEventValue = (events: any): boolean => {
if (!Array.isArray(events) || events.length === 0) return false;
return !has(events[0], 'actions');
};

View File

@ -1,31 +0,0 @@
/*
* Tencent is pleased to support the open source community by making TMagicEditor available.
*
* Copyright (C) 2025 Tencent. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* group-list
*
*
*/
export const stickyAddButton = (text: string) => ({
scrollLastItemIntoView: true as const,
addButtonConfig: {
sticky: true as const,
text,
props: { type: 'primary', plain: true, text: false },
},
});

View File

@ -1,177 +0,0 @@
/*
* Tencent is pleased to support the open source community by making TMagicEditor available.
*
* Copyright (C) 2025 Tencent. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {
type DisplayCondsConfig,
type EventSelectConfig,
type FieldInnerConfig,
type FieldMountValueEffect,
filterFunction,
type FormItemConfig,
type HeadlessFieldOptions,
} from '@tmagic/form/headless';
import type { StyleSchema } from '@tmagic/schema';
import { editorTypeMatchRules, validateDataSourceFieldSelect } from '@editor/utils/type-match-rules';
import { createCodeSelectConfig, normalizeCodeSelectValue } from './configs/codeSelect';
import { createDisplayCondsConfig } from './configs/displayConds';
import { createEventSelectConfig, isLegacyEventValue } from './configs/eventSelect';
import { createStyleSetterConfig } from './StyleSetter/configs';
const getName = (config: FormItemConfig): string => `${(config as any).name ?? ''}`;
/** `code-select` 旧数据兼容:空值改写成 `{ hookType, hookData }`。 */
const codeSelectEffect: FieldMountValueEffect = ({ config, model }) => {
normalizeCodeSelectValue(model, getName(config));
};
/** `event-select`:表单 init 对未声明 defaultValue 的自定义 type 会写成空串,统一收成数组。 */
const eventSelectEffect: FieldMountValueEffect = ({ config, model }) => {
const name = getName(config);
if (model && !Array.isArray(model[name])) {
model[name] = [];
}
};
/**
* `code-select`
*
* `fields/CodeSelect.vue`
* `<MContainer :config="codeConfig" :model="model[name]" :prop="prop">`
*
* @param ctx - innerConfig
* @returns config / model / prop
*/
const codeSelectInnerConfig: FieldInnerConfig = ({ config, model, prop }) => {
const name = getName(config);
return {
config: createCodeSelectConfig(config as any),
model: model?.[name],
prop,
};
};
/**
* `display-conds`
*
* `fields/DisplayConds.vue` groupList `MGroupList`
*
* @param ctx - innerConfig
* @returns group-list prop parentProp name
*/
const displayCondsInnerConfig: FieldInnerConfig = ({ config, model, prop, parentProp, mForm }) => {
const name = getName(config);
const parentFields =
filterFunction<string[]>(mForm, (config as DisplayCondsConfig).parentFields, {
model,
config,
prop,
}) || [];
return {
config: createDisplayCondsConfig(config as DisplayCondsConfig, name, parentFields),
// 内部 group-list 复用了字段自身的 nameprop 基准要退回父级,否则 name 会被拼两次
prop: parentProp,
};
};
/**
* `event-select`
*
* `fields/EventSelect.vue` group-list title slot
* `<prop>.<index>.name`
*
* @param ctx - innerConfig
* @returns group-list null
*/
const eventSelectInnerConfig: FieldInnerConfig = ({ config, model, parentProp }) => {
const name = getName(config);
const events = model?.[name];
// 旧数据格式走的是另一套表格配置,其中不含任何 rules不参与校验
if (!Array.isArray(events) || isLegacyEventValue(events)) return null;
return {
config: createEventSelectConfig(config as EventSelectConfig, name, { includeEventName: true }),
prop: parentProp,
};
};
/**
* `style-setter`
*
* `fields/StyleSetter/Index.vue`6 `:values="model[name]"``:prop="prop || name"`
* `theme` `useTheme` flexWrap UI childType
*
* @param ctx - innerConfig
* @returns style styleModel
*/
const styleSetterInnerConfig: FieldInnerConfig = ({ config, model, prop }) => {
const name = getName(config);
const styleModel = (model?.[name] ?? {}) as Partial<StyleSchema>;
return {
config: createStyleSetterConfig(styleModel, '', validateDataSourceFieldSelect),
model: styleModel,
prop,
};
};
/**
* Vue
*
* Node `registerFields(editorFields)` `validateForm` / `submitForm`
* plugin `component` `@tmagic/form`
*
* - UI MForm / MFormBox
* - innerConfig MContainer / MPanel / MGroupList
* - typeMatch type
*
* innerConfig config / model / prop
* `fields/configs/`
*/
export const editorFields: Record<string, HeadlessFieldOptions> = {
'vs-code': {},
'code-link': {},
'ui-select': { typeMatch: editorTypeMatchRules['ui-select'] },
'cond-op-select': { typeMatch: editorTypeMatchRules['cond-op-select'] },
'page-fragment-select': { typeMatch: editorTypeMatchRules['page-fragment-select'] },
'data-source-select': { typeMatch: editorTypeMatchRules['data-source-select'] },
'data-source-input': { typeMatch: editorTypeMatchRules['data-source-input'] },
'key-value': { typeMatch: editorTypeMatchRules['key-value'] },
'code-select-col': { typeMatch: editorTypeMatchRules['code-select-col'] },
'data-source-fields': { typeMatch: editorTypeMatchRules['data-source-fields'] },
'data-source-mocks': { typeMatch: editorTypeMatchRules['data-source-mocks'] },
'data-source-methods': { typeMatch: editorTypeMatchRules['data-source-methods'] },
'data-source-method-select': { typeMatch: editorTypeMatchRules['data-source-method-select'] },
'data-source-field-select': { typeMatch: editorTypeMatchRules['data-source-field-select'] },
'code-select': {
effect: codeSelectEffect,
innerConfig: codeSelectInnerConfig,
typeMatch: editorTypeMatchRules['code-select'],
},
'display-conds': { innerConfig: displayCondsInnerConfig, typeMatch: editorTypeMatchRules['display-conds'] },
'event-select': {
effect: eventSelectEffect,
innerConfig: eventSelectInnerConfig,
typeMatch: editorTypeMatchRules['event-select'],
},
'style-setter': { innerConfig: styleSetterInnerConfig, typeMatch: editorTypeMatchRules['style-setter'] },
};

View File

@ -1,33 +0,0 @@
/*
* Tencent is pleased to support the open source community by making TMagicEditor available.
*
* Copyright (C) 2025 Tencent. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @fileoverview `@tmagic/editor/headless`
*
* Editor.vuemonaco DOM Node import
* `@tmagic/form/headless``registerBuiltInFields(builtInFields); registerFields(editorFields);`
*
* Vue `style-setter` UI
* `fields/StyleSetter/configs.ts` `icon` / `component`
* SFCtypeMatch editor services
* import 访 DOM `@tmagic/form/headless`
*
* @module @tmagic/editor/headless
*/
export { editorFields } from './fields/headless-validation';

View File

@ -16,20 +16,20 @@
* limitations under the License.
*/
import { computed, type ComputedRef, inject, provide, type Ref, ref, useTemplateRef, watch } from 'vue';
import { computed, type ComputedRef, inject, provide, type Ref, ref, useTemplateRef, watch, watchEffect } from 'vue';
import type { CodeBlockContent, MNode } from '@tmagic/core';
import { type FormConfig, type FormContext, type FormValue, MForm } from '@tmagic/form';
import { type FormConfig, type FormState, type FormValue, MForm } from '@tmagic/form';
import { useEditorFormContext } from '@editor/hooks/use-form-context';
import type { CompareFormBaseProps } from '@editor/type';
import { getCodeBlockFormConfig } from '@editor/utils/code-block';
import { removeStyleDisplayConfig } from '@editor/utils/props';
export interface UseCompareFormReturn {
config: Ref<FormConfig>;
currentValues: ComputedRef<FormValue>;
wrapperStyle: ComputedRef<Record<string, string> | undefined>;
formContext: ComputedRef<FormContext>;
mergedExtendState: (state: FormState) => Record<string, any> | Promise<Record<string, any>>;
loadConfig: () => Promise<void>;
formRef: Readonly<Ref<InstanceType<typeof MForm> | null>>;
normalizeCodeBlockValue: (v: Partial<CodeBlockContent> | Record<string, any> | undefined) => Record<string, any>;
@ -40,7 +40,7 @@ export interface UseCompareFormReturn {
* - `category`(node / data-source / code-block) FormConfig `loadConfig`
* - `content`
* - + `wrapperStyle`
* - services / stage form context MForm filterFunction
* - services / stage MForm.formState filterFunction
*
*
*/
@ -88,7 +88,10 @@ export const useCompareForm = (props: CompareFormBaseProps): UseCompareFormRetur
return style;
});
const formContext = useEditorFormContext(() => props.services);
const mergedExtendState = (state: FormState) => {
const extendState = props.extendState ?? ((s: FormState) => s);
return extendState(props.baseFormState || state);
};
/**
* FormConfig `category` service /
@ -104,7 +107,9 @@ export const useCompareForm = (props: CompareFormBaseProps): UseCompareFormRetur
if (!props.type) {
return [];
}
return props.services.propsService.getPropsConfig(props.type, { node: props.value as unknown as MNode });
return removeStyleDisplayConfig(
await props.services.propsService.getPropsConfig(props.type, { node: props.value as unknown as MNode }),
);
}
case 'data-source': {
const config = props.services.dataSourceService.getFormConfig(props.type || 'base');
@ -154,11 +159,27 @@ export const useCompareForm = (props: CompareFormBaseProps): UseCompareFormRetur
const formRef = useTemplateRef<InstanceType<typeof MForm>>('form');
/**
* services / stage MForm formState propsService
* `display: ({ services }) => services.uiService.get(...)` filterFunction
* `formState.services`
*
* props-panel/FormPanel.vue
* - services useServices()
* - stage editorService.get('stage')
*/
watchEffect(() => {
if (formRef.value && props.services) {
formRef.value.formState.stage = props.services.editorService.get('stage');
formRef.value.formState.services = props.services;
}
});
return {
config,
currentValues,
wrapperStyle,
formContext,
mergedExtendState,
loadConfig,
formRef,
normalizeCodeBlockValue,

View File

@ -1,56 +0,0 @@
/*
* Tencent is pleased to support the open source community by making TMagicEditor available.
*
* Copyright (C) 2025 Tencent. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { computed, type ComputedRef, inject, unref } from 'vue';
import { FORM_CONTEXT_KEY, type FormContext, mergeFormContexts } from '@tmagic/form';
import type { Services } from '@editor/type';
/**
* `services` `stage`
*
* `Editor.vue`provide `FORM_CONTEXT_KEY``FormPanel.vue` `useCompareForm`
* `stage` computed
*
* 宿 `<MEditor>` provide
* provide 宿
* 宿`services` / `stage` 宿
*
* `@editor/type` `@tmagic/form-schema` `FormContext`
*/
export const useEditorFormContext = (getServices: () => Services | undefined): ComputedRef<FormContext> => {
// inject 只能在 setup 期取值,因此本 hook 必须在 setup 中调用(`use` 前缀即此约定)。
// 返回的 computed 可以随便传递,但 hook 本身不能延迟到事件回调或 onMounted 里再调。
const hostContext = inject(FORM_CONTEXT_KEY, undefined);
return computed(() => {
const services = getServices();
const host = unref(hostContext);
// 上层(通常是 Editor.vue已经用同一份 services 合并过了。FormPanel / useCompareForm
// 都是它的后代,再合并一次只会多套一层 Proxy让每次属性 miss 多一轮线性查找。
// services 相同即可判定 stage 也相同——两边都是从同一个 editorService 读的。
if (host && host.services === services) return host;
return mergeFormContexts(host, {
services,
stage: services?.editorService.get('stage'),
});
});
};

View File

@ -28,7 +28,6 @@ export const useStage = (stageOptions: StageOptions) => {
containerHighlightClassName: stageOptions.containerHighlightClassName,
containerHighlightDuration: stageOptions.containerHighlightDuration,
containerHighlightType: stageOptions.containerHighlightType,
containerHighlightAddOnly: stageOptions.containerHighlightAddOnly,
disabledDragStart: stageOptions.disabledDragStart,
renderType: stageOptions.renderType,
canSelect: (el, event, stop) => {

View File

@ -91,6 +91,4 @@ export { default as DisplayConds } from './fields/DisplayConds.vue';
export { default as CondOpSelect } from './fields/CondOpSelect.vue';
export { default as StyleSetter } from './fields/StyleSetter/Index.vue';
export { editorFields } from './fields/headless-validation';
export { default } from './plugin';

View File

@ -29,7 +29,6 @@ import { getDepNodeIds, getNodes, isPage, isValueIncludeDataSource } from '@tmag
import PropsPanel from './layouts/PropsPanel.vue';
import { isIncludeDataSource } from './utils/editor';
import { error as logError } from './utils/logger';
import { EditorProps } from './editorProps';
import { Services } from './type';
@ -37,19 +36,6 @@ export declare type LooseRequired<T> = {
[P in string & keyof T]: T[P];
};
/**
* select DSL
* watch Vue Unhandled error during execution of watcher callback
*
*/
const selectNode = async (editorService: Services['editorService'], id: Id) => {
try {
await editorService.select(id);
} catch (e) {
logError(e);
}
};
export const initServiceState = (
props: EditorProps,
{
@ -207,17 +193,9 @@ export const initServiceState = (
},
);
// defaultSelected 可能早于 modelValue 到位immediate 首次执行时 root 还是空的,或节点尚未出现在 DSL 中),
// 此时 select 会因为「获取不到组件信息」而抛错,交由 root-change 中的选中逻辑在 root 就绪后补上即可。
watch(
() => props.defaultSelected,
(defaultSelected) => {
if (!defaultSelected || !editorService.getNodeById(defaultSelected)) {
return;
}
selectNode(editorService, defaultSelected);
},
(defaultSelected) => defaultSelected && editorService.select(defaultSelected),
{
immediate: true,
},
@ -254,7 +232,6 @@ export const initServiceState = (
uiService.resetState();
componentListService.resetState();
codeBlockService.resetState();
eventsService.resetState();
keybindingService.reset();
depService.reset();
});
@ -356,11 +333,11 @@ export const initServiceEvents = (
Promise.all(
nodes.map((node) => {
if (node.type === NodeType.ROOT) {
return Promise.resolve(true);
return Promise.resolve();
}
return depService.collectIdle([node], { pageId: getPageIdByNode(node) }, deep, type);
}),
).then((results) => results.every(Boolean));
);
watch(
() => editorService.get('stage'),
@ -374,7 +351,7 @@ export const initServiceEvents = (
if (!node) return;
if (!(await collectIdle([node], true, DepTargetType.DATA_SOURCE))) return;
await collectIdle([node], true, DepTargetType.DATA_SOURCE);
updateStageNode(node);
});
},
@ -517,10 +494,8 @@ export const initServiceEvents = (
// 新增节点,收集依赖
const nodeAddHandler = (nodes: MComponent[]) => {
collectIdle(nodes, true).then((completed) => {
if (completed) {
updateStageNodes(nodes);
}
collectIdle(nodes, true).then(() => {
updateStageNodes(nodes);
});
};
@ -574,8 +549,8 @@ export const initServiceEvents = (
if (needRecollectNodes.length) {
// 有数据源依赖需要等依赖重新收集完才更新stage
const handler = async () => {
if (!(await collectIdle(needRecollectNodes, true, DepTargetType.DATA_SOURCE))) return;
if (!(await collectIdle(needRecollectNodes, true, DepTargetType.DATA_SOURCE_COND))) return;
await collectIdle(needRecollectNodes, true, DepTargetType.DATA_SOURCE);
await collectIdle(needRecollectNodes, true, DepTargetType.DATA_SOURCE_COND);
updateStageNodes(needRecollectNodes);
};
handler();
@ -597,10 +572,8 @@ export const initServiceEvents = (
// 历史记录变化时,需要重新收集依赖
const historyChangeHandler = (page: MPage | MPageFragment) => {
collectIdle([page], true).then((completed) => {
if (completed) {
updateStageNode(page);
}
collectIdle([page], true).then(() => {
updateStageNode(page);
});
};
@ -681,7 +654,7 @@ export const initServiceEvents = (
if (Array.isArray(root?.items)) {
depService.clearIdleTasks();
let collectIdlePromises: Promise<boolean>[] = [];
let collectIdlePromises: Promise<void[]>[] = [];
if (isModifyField) {
depService.removeTarget(config.id, DepTargetType.DATA_SOURCE);
depService.removeTarget(config.id, DepTargetType.DATA_SOURCE_COND);
@ -706,15 +679,10 @@ export const initServiceEvents = (
collectIdlePromises = [collectIdle(root.items, true, DepTargetType.DATA_SOURCE_METHOD)];
}
const handler = async () => {
const results = await Promise.all(collectIdlePromises);
if (!results.every(Boolean)) return;
updateDataSourceSchema();
await updateDsData();
updateStageNodes(root.items);
};
handler();
Promise.all(collectIdlePromises)
.then(() => updateDataSourceSchema())
.then(() => updateDsData())
.then(() => updateStageNodes(root.items));
}
} else if (root?.dataSources) {
updateDsData();
@ -738,12 +706,11 @@ export const initServiceEvents = (
const nodeIds = Object.keys(root.dataSourceDeps?.[id] || {});
const nodes = getNodes(nodeIds, root.items);
const results = await Promise.all([
await Promise.all([
collectIdle(nodes, false, DepTargetType.DATA_SOURCE),
collectIdle(nodes, false, DepTargetType.DATA_SOURCE_COND),
collectIdle(nodes, false, DepTargetType.DATA_SOURCE_METHOD),
]);
if (!results.every(Boolean)) return;
updateDataSourceSchema();

View File

@ -43,6 +43,8 @@
:data-source-type="payload.dataSourceType"
:value="rightValue"
:last-value="leftValue"
:base-form-state="compareFormState"
:extend-state="extendState"
:load-config="loadConfig"
:self-diff-field-types="selfDiffFieldTypes"
:services="props.services"
@ -84,6 +86,7 @@ import {
TMagicRadioGroup,
TMagicTag,
} from '@tmagic/design';
import type { FormState } from '@tmagic/form';
import CompareForm from '@editor/components/CompareForm.vue';
import CodeEditor from '@editor/layouts/CodeEditor.vue';
@ -97,6 +100,12 @@ const props = withDefaults(
defineProps<{
/** 编辑器服务集合,由调用方传入(不再通过 inject('services') 获取)。 */
services?: Services;
/**
* 来自 Editor 顶层的 `extendFormState`用于扩展 MForm.formState
* 透传给 CompareForm从而让差异对比时表单 item 中依赖业务上下文的
* `display` / `disabled` filterFunction 正常工作
*/
extendState?: (_state: FormState) => Record<string, any> | Promise<Record<string, any>>;
/**
* 自定义 FormConfig 加载逻辑透传给 CompareForm传入后将接管内置的按 `category`
* 取配置逻辑可通过 `ctx.defaultLoadConfig()` 复用默认结果再做二次加工
@ -108,6 +117,7 @@ const props = withDefaults(
isConfirm?: boolean;
onConfirm?: () => void;
selfDiffFieldTypes?: string[];
compareFormState?: FormState;
}>(),
{
width: '900px',

View File

@ -133,6 +133,7 @@ import { computed, inject, markRaw, ref, watch } from 'vue';
import { Clock, Close } from '@element-plus/icons-vue';
import { getDesignConfig, TMagicButton, tMagicMessage, TMagicPopover, TMagicTabs, TMagicTooltip } from '@tmagic/design';
import type { FormState } from '@tmagic/form';
import MIcon from '@editor/components/Icon.vue';
import { useServices } from '@editor/hooks/use-services';
@ -192,6 +193,17 @@ watch([disabledDataSource, disabledCodeBlock], ([dsDisabled, cbDisabled]) => {
}
});
/**
* 通过 inject 拿到 Editor 顶层注入的 `extendFormState`转交给 HistoryDiffDialog
* 内部的 CompareForm使差异对比表单的 filterFunction 能拿到完整的业务上下文
* 未提供时为 undefinedCompareForm/MForm 会跳过 extendState 处理
*/
const extendFormState = inject<((_state: FormState) => Record<string, any> | Promise<Record<string, any>>) | undefined>(
'extendFormState',
undefined,
);
const getPropsPanelFormState = inject<(() => FormState | undefined) | undefined>('getPropsPanelFormState', undefined);
const {
expanded,
toggleGroup,
@ -304,7 +316,7 @@ const onCodeBlockGotoInitial = (id: string | number) => {
* 业务方亦可直接 import useHistoryRevert(options, services) 调用无需自行挂载任何弹窗
*/
const { onPageRevert, onDataSourceRevert, onCodeBlockRevert, onPageDiff, onDataSourceDiff, onCodeBlockDiff } =
useHistoryRevert({}, services);
useHistoryRevert({ extendState: extendFormState, getPropsPanelFormState }, services);
/**
* 把内存中已清空对应类别后的历史状态重新写回 IndexedDB

View File

@ -74,7 +74,7 @@ interface MountedDiffDialog {
* import
*/
const mountHistoryDiffDialog = async (
options: Pick<UseHistoryRevertOptions, 'appContext'> &
options: Pick<UseHistoryRevertOptions, 'appContext' | 'extendState'> &
CustomDiffFormOptions & {
services?: Services;
isConfirm?: boolean;
@ -90,8 +90,10 @@ const mountHistoryDiffDialog = async (
const app = createApp(historyDiffDialog, {
services: options.services,
isConfirm: options.isConfirm,
extendState: options.extendState,
loadConfig: options.loadConfig,
selfDiffFieldTypes: options.selfDiffFieldTypes,
compareFormState: options.compareFormState,
width: options.width,
size: options.size ?? options.services?.uiService?.get('propsPanelSize'),
onClose: options.onClose,
@ -123,7 +125,7 @@ const mountHistoryDiffDialog = async (
*/
const confirmRevertWithDiffDialog = async (
payload: DiffDialogPayload,
options: Pick<UseHistoryRevertOptions, 'appContext'> &
options: Pick<UseHistoryRevertOptions, 'appContext' | 'extendState'> &
CustomDiffFormOptions & {
services?: Services;
},
@ -145,7 +147,7 @@ const confirmRevertWithDiffDialog = async (
*/
const viewHistoryDiffDialog = async (
payload: DiffDialogPayload,
options: Pick<UseHistoryRevertOptions, 'appContext'> &
options: Pick<UseHistoryRevertOptions, 'appContext' | 'extendState'> &
CustomDiffFormOptions & {
services?: Services;
},
@ -192,7 +194,7 @@ const viewHistoryDiffDialog = async (
export const useHistoryRevert = (options: UseHistoryRevertOptions = {}, services?: Services) => {
// 自动捕获调用方所在组件的 appContext在 setup 中调用时),业务方亦可显式覆盖。
const appContext = options.appContext ?? getCurrentInstance()?.appContext ?? null;
const { dialogWidth } = options;
const { extendState, getPropsPanelFormState, dialogWidth } = options;
/** 目标数据已被删除、无法回滚时的统一提示。 */
const showRevertTargetMissing = () => {
@ -218,6 +220,7 @@ export const useHistoryRevert = (options: UseHistoryRevertOptions = {}, services
if (payload) {
return confirmRevertWithDiffDialog(payload, {
appContext,
extendState,
services,
...extra,
width: extra?.width ?? dialogWidth,
@ -304,7 +307,7 @@ export const useHistoryRevert = (options: UseHistoryRevertOptions = {}, services
showRevertTargetMissing();
return Promise.resolve(null);
}
return runRevert(buildPageDiffPayload(index), {}).then((result) =>
return runRevert(buildPageDiffPayload(index), { compareFormState: getPropsPanelFormState?.() }).then((result) =>
result ? services?.editorService.revertPageStep(index) : null,
);
};
@ -338,20 +341,22 @@ export const useHistoryRevert = (options: UseHistoryRevertOptions = {}, services
if (payload) {
return viewHistoryDiffDialog(payload, {
appContext,
extendState,
services,
width: dialogWidth,
compareFormState: getPropsPanelFormState?.(),
});
}
};
const onDataSourceDiff = (id: string | number, index: number): Promise<void> | void => {
const payload = buildDataSourceDiffPayload(id, index);
if (payload) return viewHistoryDiffDialog(payload, { appContext, services, width: dialogWidth });
if (payload) return viewHistoryDiffDialog(payload, { appContext, extendState, services, width: dialogWidth });
};
const onCodeBlockDiff = (id: string | number, index: number): Promise<void> | void => {
const payload = buildCodeBlockDiffPayload(id, index);
if (payload) return viewHistoryDiffDialog(payload, { appContext, services, width: dialogWidth });
if (payload) return viewHistoryDiffDialog(payload, { appContext, extendState, services, width: dialogWidth });
};
/**
@ -393,6 +398,7 @@ export const useHistoryRevert = (options: UseHistoryRevertOptions = {}, services
if (payload)
return viewHistoryDiffDialog(payload, {
appContext,
extendState,
services,
...extra,
width: extra?.width ?? dialogWidth,

View File

@ -13,8 +13,7 @@
:init-values="values"
:config="config"
:type-match-valid="true"
:context="formContext"
:validate-on-init="true"
:extend-state="extendState"
@change="submit"
@error="errorHandler"
></MForm>
@ -45,18 +44,17 @@
</template>
<script setup lang="ts">
import { computed, getCurrentInstance, inject, onMounted, onUnmounted, ref, useTemplateRef } from 'vue';
import { computed, getCurrentInstance, inject, onMounted, onUnmounted, ref, useTemplateRef, watchEffect } from 'vue';
import { Document as DocumentIcon } from '@element-plus/icons-vue';
import { TMagicButton, tMagicMessage, TMagicScrollbar } from '@tmagic/design';
import type { ContainerChangeEventData, FormConfig, FormValue } from '@tmagic/form';
import type { ContainerChangeEventData, FormConfig, FormState, FormValue } from '@tmagic/form';
import { MForm, validateForm } from '@tmagic/form';
import { filterXSS } from '@tmagic/utils';
import MIcon from '@editor/components/Icon.vue';
import { ENABLE_PROPS_FORM_VALIDATE } from '@editor/editorProps';
import { useEditorContentHeight } from '@editor/hooks/use-editor-content-height';
import { useEditorFormContext } from '@editor/hooks/use-form-context';
import { useServices } from '@editor/hooks/use-services';
import CodeEditor from '../CodeEditor.vue';
@ -75,7 +73,8 @@ const props = defineProps<{
disabledShowSrc?: boolean;
labelWidth?: string;
codeValueKey?: string;
labelPosition?: 'top' | 'left' | 'right';
labelPosition?: string;
extendState?: (_state: FormState) => Record<string, any> | Promise<Record<string, any>>;
}>();
const emit = defineEmits<{
@ -89,18 +88,24 @@ const emit = defineEmits<{
const enablePropsFormValidate = inject(ENABLE_PROPS_FORM_VALIDATE, false);
const services = useServices();
const { uiService } = services;
const { editorService, uiService } = services;
const codeOptions = inject('codeOptions', {});
const showSrc = ref(false);
const propsPanelSize = computed(() => uiService.get('propsPanelSize') || 'small');
const { height: editorContentHeight } = useEditorContentHeight();
const formContext = useEditorFormContext(() => services);
const stage = computed(() => editorService.get('stage'));
const configFormRef = useTemplateRef<InstanceType<typeof MForm>>('configForm');
watchEffect(() => {
if (configFormRef.value) {
configFormRef.value.formState.stage = stage.value;
configFormRef.value.formState.services = services;
}
});
const internalInstance = getCurrentInstance();
onMounted(() => {
emit('mounted', internalInstance?.proxy);
@ -152,17 +157,23 @@ const saveCode = async (values: any) => {
return;
}
//
//
// MForm
//
// 使
//
// display / rules formState services context
try {
const error = await validateForm({
config: props.config,
typeMatchValid: true,
initValues: newValues,
context: formContext.value,
// provides Editor services / codeOptions provide
// appContext使 MForm DataSourceInput inject
appContext: internalInstance?.appContext ? { ...internalInstance?.appContext, provides: { services } } : null,
extendState: (state) => {
if (configFormRef.value?.formState) {
return { ...(configFormRef.value?.formState || {}) };
}
return props.extendState?.(state) || {};
},
});
if (error) {
@ -175,10 +186,9 @@ const saveCode = async (values: any) => {
emit('submit', newValues, undefined, error ? new Error(error) : undefined);
} catch (e: any) {
console.error('validateForm error', e);
// / initValue
// error
emit('submit', newValues, undefined, e instanceof Error ? e : new Error(String(e)));
console.log('validateForm error', e);
// 退
emit('submit', newValues);
}
};

View File

@ -8,6 +8,7 @@
:config="curFormConfig"
:values="values"
:disabledShowSrc="disabledShowSrc"
:extendState="extendState"
@submit="(v, eventData, error) => submit(v, eventData, error, 'props')"
@submit-error="errorHandler"
@form-error="errorHandler"
@ -25,6 +26,7 @@
:config="styleFormConfig"
:values="values"
:disabledShowSrc="disabledShowSrc"
:extendState="extendState"
@submit="(v, eventData, error) => submit(v, eventData, error, 'style')"
@submit-error="errorHandler"
@form-error="errorHandler"
@ -59,7 +61,7 @@ import type { OnDrag } from 'gesto';
import { type MNode } from '@tmagic/core';
import { TMagicButton } from '@tmagic/design';
import type { ContainerChangeEventData, FormValue } from '@tmagic/form';
import type { ContainerChangeEventData, FormState, FormValue } from '@tmagic/form';
import { setValueByKeyPath } from '@tmagic/utils';
import MIcon from '@editor/components/Icon.vue';
@ -82,6 +84,7 @@ defineOptions({
defineProps<{
disabledShowSrc?: boolean;
extendState?: (_state: FormState) => Record<string, any> | Promise<Record<string, any>>;
}>();
const emit = defineEmits<{
@ -155,34 +158,14 @@ const submit = async (
v.id = values.value.id;
}
// MForm @change eventData changeRecords
// CodeEditor @save saveCode eventData
const historySource = eventData ? 'props' : 'code';
// replace merge
const replace = historySource === 'code';
const newValue: MNode = {
...v,
style: {},
};
let newValue: MNode;
if (replace) {
if (source === 'style') {
// { style } style
newValue = {
...values.value,
id: v.id || values.value.id,
style: { ...(v.style || {}) },
};
} else {
// DSL
newValue = { ...v };
}
} else {
newValue = {
...v,
style: {},
};
if (v.style) {
// doUpdate mergeWith
if (v.style) {
// doUpdate mergeWith
if (eventData) {
// DSL
// changeRecords
Object.entries(v.style).forEach(([key, value]) => {
@ -191,18 +174,24 @@ const submit = async (
}
});
eventData?.changeRecords?.forEach((record) => {
eventData.changeRecords?.forEach((record) => {
if (record.propPath?.startsWith('style') && record.value === '') {
setValueByKeyPath(record.propPath, record.value, newValue);
}
});
} else {
// eventDatastyle
newValue.style = { ...v.style };
}
}
// MForm @change eventData changeRecords
// CodeEditor @save saveCode eventData
const historySource = eventData ? 'props' : 'code';
editorService.update(newValue, {
changeRecords: eventData?.changeRecords,
historySource,
replace,
// error editorService
// CodeEditor invalidInfo editorService update
...(enablePropsFormValidate && error ? { invalidInfo: { id: newValue.id, source, error: error?.message } } : {}),

View File

@ -71,11 +71,7 @@ const stage = computed(() => editorService.get('stage'));
const list = computed<ComponentGroup[]>(() =>
componentListService.getList().map((group: ComponentGroup) => ({
...group,
items: group.items.filter((item: ComponentItem) =>
`${item.text || ''}${item.desc || ''}${item.type}`
.toLocaleLowerCase()
.includes(searchText.value.toLocaleLowerCase()),
),
items: group.items.filter((item: ComponentItem) => item.text.includes(searchText.value)),
})),
);
@ -149,6 +145,6 @@ const dragHandler = (e: DragEvent) => {
if (timeout || !stage.value) return;
timeout = stage.value.delayedMarkContainer(e, [], true);
timeout = stage.value.delayedMarkContainer(e);
};
</script>

View File

@ -82,7 +82,7 @@ const props = defineProps<{
customContentMenu: CustomContentMenuFunction;
}>();
const eventBus = inject<EventBus | null>('eventBus', null);
const eventBus = inject<EventBus>('eventBus');
const { codeBlockService } = useServices();

View File

@ -6,7 +6,7 @@ import ContentMenu from '@editor/components/ContentMenu.vue';
import type { ContentMenuTarget, EventBus, MenuButton, MenuComponent, TreeNodeData } from '@editor/type';
export const useContentMenu = (deleteCode: (id: string) => void) => {
const eventBus = inject<EventBus | null>('eventBus', null);
const eventBus = inject<EventBus>('eventBus');
const menuRef = useTemplateRef<InstanceType<typeof ContentMenu>>('menu');
let selectId = '';

View File

@ -75,7 +75,7 @@ const props = defineProps<{
customContentMenu: CustomContentMenuFunction;
}>();
const eventBus = inject<EventBus | null>('eventBus', null);
const eventBus = inject<EventBus>('eventBus');
const { dataSourceService } = useServices();
const { editDialog, dataSourceValues, dialogTitle, editable, editHandler, submitDataSourceHandler } =

View File

@ -6,7 +6,7 @@ import ContentMenu from '@editor/components/ContentMenu.vue';
import type { ContentMenuTarget, EventBus, MenuButton, MenuComponent, TreeNodeData } from '@editor/type';
export const useContentMenu = () => {
const eventBus = inject<EventBus | null>('eventBus', null);
const eventBus = inject<EventBus>('eventBus');
const menuRef = useTemplateRef<InstanceType<typeof ContentMenu>>('menu');
let selectId = '';

Some files were not shown because too many files have changed in this diff Show More