tmagic-editor/docs/api/editor/editorServiceEvents.md
roymondchen 873a51fc87 docs: 升级 VitePress 至 v2 alpha,类型引用改为源码片段同步
- 升级 vitepress 到 ^2.0.0-alpha.17
- vite.optimizeDeps.rolldownOptions.transform.define 迁移至 vite.define 以适配 v2 API
- 同步升级 vitest/rolldown/vue/vite 等周边依赖
- 文档中类型链接统一改为 <<< 片段引用源码 region,避免 commit hash 链接失效
- packages/{core,editor,form-schema,schema,stage} 相关类型加 // #region 锚点
- 移除已废弃的 docs/guide/advanced/tmagic-ui.md 及侧栏入口

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-18 11:47:03 +08:00

2.7 KiB
Raw Blame History

editorService事件

root-change

  • 详情: dsl跟节点发生变化editorService.set('root', {})后触发

  • 事件回调函数: (value: MApp, preValue?: MApp) => void

    ::: details 查看 MApp 及关联类型定义 <<< @/../packages/schema/src/index.ts#MApp{ts}

    <<< @/../packages/schema/src/index.ts#MComponent{ts}

    <<< @/../packages/schema/src/index.ts#NodeType{ts}

    <<< @/../packages/schema/src/index.ts#MPage{ts}

    <<< @/../packages/schema/src/index.ts#MPageFragment{ts}

    <<< @/../packages/schema/src/index.ts#CodeBlockDSL{ts}

    <<< @/../packages/schema/src/index.ts#DataSourceSchema{ts}

    <<< @/../packages/schema/src/index.ts#DataSourceDeps{ts} :::

select

  • 详情: 选中组件,editorService.select()后触发

  • 事件回调函数: (node: MNode) => void

    ::: details 查看 MNode 及关联类型定义 <<< @/../packages/schema/src/index.ts#MNode{ts}

    <<< @/../packages/schema/src/index.ts#MComponent{ts}

    <<< @/../packages/schema/src/index.ts#MContainer{ts}

    <<< @/../packages/schema/src/index.ts#MPage{ts}

    <<< @/../packages/schema/src/index.ts#MPageFragment{ts} :::

add

  • 详情: 添加节点后触发,editorService.add()后触发

  • 事件回调函数: (node: MNode[]) => void

remove

  • 详情: 删除节点后触发,editorService.remove()后触发

  • 事件回调函数: (node: MNode[]) => void

update

  • 详情: 更新组件后触发,editorService.update()后触发

  • 事件回调函数: (data: Array<{ newNode: MNode; oldNode: MNode; changeRecords?: ChangeRecord[] }>) => void

    ::: details 查看 ChangeRecord 类型定义 <<< @/../packages/form-schema/src/base.ts#ChangeRecord{ts} :::

move-layer

  • 详情: 移动节点层级后触发,editorService.moveLayer()后触发

  • 事件回调函数: (offset: number | LayerOffset) => void

    其中 LayerOffset 枚举值为 'top' / 'bottom'

drag-to

  • 详情: 拖拽节点到指定容器后触发,editorService.dragTo()后触发

  • 事件回调函数: (data: { targetIndex: number; configs: MNode | MNode[]; targetParent: MContainer }) => void

    ::: details 查看 MContainer 类型定义 <<< @/../packages/schema/src/index.ts#MContainer{ts} :::

history-change