tmagic-editor/docs/assets/guide_advanced_history-list.md.B-o7GZXj.js
2026-11-13 04:26:01 +00:00

55 lines
26 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{Pt as e,dt as t,n,pt as r}from"./chunks/framework.xVFRZL1t.js";var i=JSON.parse(`{"title":"历史记录面板","description":"","frontmatter":{},"headers":[],"relativePath":"guide/advanced/history-list.md","filePath":"guide/advanced/history-list.md"}`),a={name:`guide/advanced/history-list.md`};function o(n,i,a,o,s,c){return e(),t(`div`,null,[...i[0]||=[r(`<h1 id="历史记录面板" tabindex="-1">历史记录面板 <a class="header-anchor" href="#历史记录面板" aria-label="Permalink to “历史记录面板”">​</a></h1><p>编辑器内置了一个可视化的「历史记录面板」,用于查看与回溯编辑过程中产生的所有操作。相比顶部菜单栏只能「撤销 / 重做」相邻一步,历史记录面板提供了对整条历史栈的全局视角:可以按页面、数据源、代码块分类浏览,点击任意一步直接跳转,查看每一步的前后差异,甚至像 <code>git revert</code> 一样单独回滚某一步而不破坏后续操作。</p><h2 id="开启面板" tabindex="-1">开启面板 <a class="header-anchor" href="#开启面板" aria-label="Permalink to “开启面板”">​</a></h2><p>历史记录面板以一个内置菜单项 <code>&#39;history-list&#39;</code> 的形式提供,将它加入 <a href="/tmagic-editor/docs/api/editor/props.html#menu"><code>menu</code></a> 配置即可在顶部工具栏出现一个时钟图标,点击展开面板:</p><div class="language-html"><button title="Copy code" data-copied="Copied" class="copy"></button><span class="lang">html</span><pre class="shiki shiki-themes github-light github-dark" style="--shiki-light:#24292e;--shiki-dark:#e1e4e8;--shiki-light-bg:#fff;--shiki-dark-bg:#24292e;" tabindex="0" dir="ltr"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&lt;</span><span style="--shiki-light:#11782a;--shiki-dark:#85E89D;">template</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> &lt;</span><span style="--shiki-light:#11782a;--shiki-dark:#85E89D;">m-editor</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> :menu</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;menu&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&gt;&lt;/</span><span style="--shiki-light:#11782a;--shiki-dark:#85E89D;">m-editor</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&lt;/</span><span style="--shiki-light:#11782a;--shiki-dark:#85E89D;">template</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&gt;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&lt;</span><span style="--shiki-light:#11782a;--shiki-dark:#85E89D;">script</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> setup</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { ref } </span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &#39;vue&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> menu</span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> ref</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> left: [],</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> center: [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;delete&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;undo&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;redo&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;/&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;history-list&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">],</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> right: [],</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&lt;/</span><span style="--shiki-light:#11782a;--shiki-dark:#85E89D;">script</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&gt;</span></span></code></pre></div><h2 id="面板结构" tabindex="-1">面板结构 <a class="header-anchor" href="#面板结构" aria-label="Permalink to “面板结构”">​</a></h2><p>面板分为三个 tab,分别对应三类可被历史记录追踪的对象,tab 标题后的数字为各自的分组数量:</p><table tabindex="0"><thead><tr><th>Tab</th><th>内容</th><th>跳转 API</th></tr></thead><tbody><tr><td>页面</td><td>当前活动页面的节点操作历史</td><td><code>editorService.gotoPageStep(cursor)</code></td></tr><tr><td>数据源</td><td>按 <code>dataSource.id</code> 分组的数据源变更历史</td><td><code>dataSourceService.goto(id, cursor)</code></td></tr><tr><td>代码块</td><td>按 <code>codeBlock.id</code> 分组的代码块变更历史</td><td><code>codeBlockService.goto(id, cursor)</code></td></tr></tbody></table><h3 id="相邻同目标自动合并" tabindex="-1">相邻同目标自动合并 <a class="header-anchor" href="#相邻同目标自动合并" aria-label="Permalink to “相邻同目标自动合并”">​</a></h3><p>为了避免「连续微调同一个节点 / 数据源 / 代码块」时产生大量碎片化记录,面板会把<strong>相邻的、针对同一目标的连续 <code>update</code></strong> 自动合并成一个分组:</p><ul><li>页面 tab:连续修改同一节点(按节点 id 判定)的多步合并为一组,点击组头部可展开查看每一子步;</li><li>数据源 / 代码块 tab:相邻的连续 <code>update</code> 按目标 id 合并;<code>add</code> / <code>remove</code> 始终独立成组(语义上是一次性事件)。</li></ul><blockquote><p>合并仅作用于展示与交互,不改变底层 undo/redo 栈的真实结构。</p></blockquote><h2 id="交互能力" tabindex="-1">交互能力 <a class="header-anchor" href="#交互能力" aria-label="Permalink to “交互能力”">​</a></h2><p>每个分组 / 步骤支持以下操作:</p><h3 id="_1-点击跳转" tabindex="-1">1. 点击跳转 <a class="header-anchor" href="#_1-点击跳转" aria-label="Permalink to “1. 点击跳转”">​</a></h3><p>点击任意一条记录,编辑器会跳转到「应用至该步完成」的状态。其本质是把对应栈的游标(cursor)移动到 <code>step.index + 1</code>,由 service 层的 undo/redo 链路完成中间步骤的批量正向 / 反向应用。</p><h3 id="_2-回到初始状态" tabindex="-1">2. 回到初始状态 <a class="header-anchor" href="#_2-回到初始状态" aria-label="Permalink to “2. 回到初始状态”">​</a></h3><p>每个 tab 列表底部提供「回到初始状态」入口,等价于把对应栈游标移到 <code>0</code>(所有真实步骤全部撤销)。</p><h3 id="_3-单步回滚-类-git-revert" tabindex="-1">3. 单步回滚(类 git revert) <a class="header-anchor" href="#_3-单步回滚-类-git-revert" aria-label="Permalink to “3. 单步回滚(类 git revert)”">​</a></h3><p>对于历史中间的某一步,可以单独「回滚」它,而保留它之后的所有操作。该行为不会倒带游标,而是把目标步骤的修改<strong>反向应用为一次全新的操作</strong>并压入栈顶,因此不会破坏既有历史结构:</p><ul><li>页面:<code>editorService.revertPageStep(index)</code></li><li>数据源:<code>dataSourceService.revert(id, index)</code></li><li>代码块:<code>codeBlockService.revert(id, index)</code></li></ul><p>如果业务侧在执行操作时已通过 <code>*AndGetHistoryId</code> 拿到了该条记录的 uuid(见 <a href="/tmagic-editor/docs/api/editor/editorServiceMethods.html#历史记录-uuid-与-andgethistoryid">uuid 与 *AndGetHistoryId</a> 返回的 <code>historyIds</code>),也可以直接按 uuid 回滚(无需再关心 index / id,且 uuid 不会随栈内步骤增删而变化):</p><ul><li>页面:<code>editorService.revertPageStepById(uuids)</code></li><li>数据源:<code>dataSourceService.revertById(uuids)</code></li><li>代码块:<code>codeBlockService.revertById(uuids)</code></li></ul><h4 id="复用面板的「交互式回滚-查看差异」流程" tabindex="-1">复用面板的「交互式回滚 / 查看差异」流程 <a class="header-anchor" href="#复用面板的「交互式回滚-查看差异」流程" aria-label="Permalink to “复用面板的「交互式回滚 / 查看差异」流程”">​</a></h4><p>上面的 <code>revert*</code> 方法是<strong>静默</strong>的:它们直接执行反向应用,不做任何校验与二次确认。如果业务方想在自己的入口(自定义按钮、右键菜单等)里复用历史面板那一套<strong>完整交互流程</strong>——即「目标数据已删除的前置校验 + 失败提示」「可差异步骤弹差异确认弹窗 / 其余步骤弹普通二次确认框」「用户确认后才回滚」,以及「查看差异」弹窗——可以直接 import <code>useHistoryRevert</code>:</p><div class="language-ts"><button title="Copy code" data-copied="Copied" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark" style="--shiki-light:#24292e;--shiki-dark:#e1e4e8;--shiki-light-bg:#fff;--shiki-dark-bg:#24292e;" tabindex="0" dir="ltr"><code><span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { useHistoryRevert } </span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &#39;@tmagic/editor&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#62687b;--shiki-dark:#818e99;">// editorRef 为 &lt;m-editor&gt; 组件实例,其 expose 出的即各 service 集合(Services)</span></span>
<span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> onPageRevert</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> onDataSourceRevert</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> onCodeBlockRevert</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> onPageDiff</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> onDataSourceDiff</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> onCodeBlockDiff</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">} </span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> useHistoryRevert</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({}, editorRef.value);</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#62687b;--shiki-dark:#818e99;">// 回滚:可差异步骤弹出差异确认弹窗、其余步骤弹普通二次确认框;用户点「确定」后回滚第 index 步,</span></span>
<span class="line"><span style="--shiki-light:#62687b;--shiki-dark:#818e99;">// 命中前置校验或用户取消时不执行,返回 null</span></span>
<span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">await</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> onPageRevert</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(index);</span></span>
<span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">await</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> onDataSourceRevert</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(id, index);</span></span>
<span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">await</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> onCodeBlockRevert</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(id, index);</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#62687b;--shiki-dark:#818e99;">// 查看差异:可差异步骤弹出只读差异弹窗展示前后值差异,无可对比内容时不弹窗</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">onPageDiff</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(index);</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">onDataSourceDiff</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(id, index);</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">onCodeBlockDiff</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(id, index);</span></span></code></pre></div><p>回滚确认弹窗与查看差异弹窗均由 <code>useHistoryRevert</code> 内部<strong>按需动态挂载</strong> <code>HistoryDiffDialog</code> 实现,业务方无需自行挂载任何弹窗组件。第二个参数 <code>options</code> 可选:</p><table tabindex="0"><thead><tr><th>字段</th><th>必填</th><th>说明</th></tr></thead><tbody><tr><td><code>appContext</code></td><td>否</td><td>父级应用上下文,用于让动态挂载的差异确认弹窗继承全局组件 / 指令 / provide / 插件(Element Plus、<code>@tmagic/form</code> 字段组件等)。在组件 <code>setup</code> 中调用时会自动取当前组件的 <code>appContext</code>,无需手动传;仅当在组件 setup 之外调用时才需显式传入(如 <code>editorApp._context</code>)。</td></tr><tr><td><code>dialogWidth</code></td><td>否</td><td>内置页面 / 数据源 / 代码块的差异 / 回滚确认弹窗默认宽度(透传给 <code>TMagicDialog</code> 的 <code>width</code>),如 <code>&#39;1200px&#39;</code> / <code>&#39;80%&#39;</code>。缺省时使用弹窗内置默认宽度(<code>900px</code>)。业务自有历史可在 <code>viewDiff</code> / <code>confirmAndRevert</code> 调用时通过各自入参的 <code>width</code> 单独覆盖。</td></tr></tbody></table><blockquote><p>若只需要无确认、无校验的静默回滚,直接用上面的 <code>editorService.revertPageStep</code> 等即可,无需 <code>useHistoryRevert</code>。</p></blockquote><h3 id="_4-差异对比" tabindex="-1">4. 差异对比 <a class="header-anchor" href="#_4-差异对比" aria-label="Permalink to “4. 差异对比”">​</a></h3><p>在前后值都存在的 <code>update</code> 步骤上提供「查看差异」入口,点击后弹出差异对话框。对话框支持两个维度的切换:</p><ul><li><strong>对比对象</strong><ul><li><code>与修改前对比</code>:该步骤修改前 vs 修改后(默认,体现这一步带来的变化);</li><li><code>与当前对比</code>:该步骤修改后 vs 编辑器中的最新值(用于确认「这一步之后是否又被改动过」,当前值缺失时禁用)。</li></ul></li><li><strong>展示形态</strong><ul><li><code>表单对比</code>:以属性表单形式逐字段对比,可读性更好(基于 <a href="/tmagic-editor/docs/form-config/compare.html">表单对比</a> 能力);</li><li><code>源码对比</code>:以 JSON 源码做整体 diff(基于 monaco diff 编辑器),可以看到表单未覆盖到的字段。</li></ul></li></ul><div class="tip custom-block"><p class="custom-block-title custom-block-title-default">TIP</p><p>表单对比依赖 <code>@tmagic/form</code> 的对比模式(<code>isCompare</code> / <code>lastValues</code>)。对于 <code>event-select</code>、<code>code-select</code>、<code>code-select-col</code> 等由列表或嵌套子表单组成的复合字段,表单会逐项展示新增 / 删除 / 修改的高亮差异,并在对比模式下隐藏「添加 / 删除 / 编辑」等写操作按钮,仅保留只读展示。</p></div><h2 id="扩展自定义-tab" tabindex="-1">扩展自定义 tab <a class="header-anchor" href="#扩展自定义-tab" aria-label="Permalink to “扩展自定义 tab”">​</a></h2><p>内置的三个 tab 之外,业务方可以通过 Editor 的 <a href="/tmagic-editor/docs/api/editor/props.html#historylistextratabs"><code>historyListExtraTabs</code></a> 在面板中追加自定义的历史 tab,追加在「页面 / 数据源 / 代码块」之后。适用于某个自定义模块维护自己的操作历史,需要在历史记录面板中独立展示与回滚的场景。</p><div class="language-html"><button title="Copy code" data-copied="Copied" class="copy"></button><span class="lang">html</span><pre class="shiki shiki-themes github-light github-dark" style="--shiki-light:#24292e;--shiki-dark:#e1e4e8;--shiki-light-bg:#fff;--shiki-dark-bg:#24292e;" tabindex="0" dir="ltr"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&lt;</span><span style="--shiki-light:#11782a;--shiki-dark:#85E89D;">template</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> &lt;</span><span style="--shiki-light:#11782a;--shiki-dark:#85E89D;">m-editor</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> :menu</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;menu&quot;</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> :history-list-extra-tabs</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;historyListExtraTabs&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&gt;&lt;/</span><span style="--shiki-light:#11782a;--shiki-dark:#85E89D;">m-editor</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&lt;/</span><span style="--shiki-light:#11782a;--shiki-dark:#85E89D;">template</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&gt;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&lt;</span><span style="--shiki-light:#11782a;--shiki-dark:#85E89D;">script</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> setup</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { markRaw } </span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &#39;vue&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> MyModuleHistoryTab </span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &#39;./MyModuleHistoryTab.vue&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> historyListExtraTabs</span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> [</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> name: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;my-module&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#62687b;--shiki-dark:#818e99;"> // label 支持字符串或函数,函数形式便于展示动态数量</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> label</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: () </span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">=&gt;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> \`我的模块 (\${</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">getMyModuleHistory</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">().</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">length</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">})\`</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> component: </span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">markRaw</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(MyModuleHistoryTab),</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> props: { foo: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;bar&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> listeners: {</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> goto</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: (</span><span style="--shiki-light:#c13617;--shiki-dark:#FFAB70;">cursor</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">=&gt;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(cursor),</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">];</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&lt;/</span><span style="--shiki-light:#11782a;--shiki-dark:#85E89D;">script</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">&gt;</span></span></code></pre></div><p>每个扩展 tab 的字段说明:</p><table tabindex="0"><thead><tr><th>字段</th><th>必填</th><th>说明</th></tr></thead><tbody><tr><td><code>name</code></td><td>是</td><td>tab 唯一标识,作为内部 <code>TMagicTabs</code> 的 <code>name</code></td></tr><tr><td><code>label</code></td><td>是</td><td>tab 显示文案,支持字符串或返回字符串的函数(便于展示动态数量)</td></tr><tr><td><code>component</code></td><td>是</td><td>tab 内容区渲染的组件</td></tr><tr><td><code>props</code></td><td>否</td><td>传入内容组件的 props</td></tr><tr><td><code>listeners</code></td><td>否</td><td>内容组件的事件监听</td></tr></tbody></table><blockquote><p>内容组件内部可自行通过 <code>useServices()</code> 拿到 <code>historyService</code> 等服务,读取并回滚自定义模块自己维护的历史。</p></blockquote><h2 id="自定义对比判断" tabindex="-1">自定义对比判断 <a class="header-anchor" href="#自定义对比判断" aria-label="Permalink to “自定义对比判断”">​</a></h2><p>差异对话框中的「表单对比」最终透传到 <code>MForm</code>。Editor 会把 <code>services</code> / <code>stage</code> provide 为 <code>FORM_CONTEXT_KEY</code>,对比表单自动继承;业务字段在 <code>&lt;m-editor&gt;</code> 外层再 provide 一层即可,详见 <a href="/tmagic-editor/docs/api/editor/props.html#表单业务上下文">表单业务上下文</a>。配置回调通过 <code>mForm.xxx</code> 读穿取用。</p><p>若某些字段语义上相等但结构不同(例如 <code>code-select</code> 字段中 <code>&#39;&#39;</code> 与 <code>{ hookType: &#39;code&#39;, hookData: [] }</code> 应视为相等),可借助 <code>@tmagic/form</code> 的 <a href="/tmagic-editor/docs/api/form/form-props.html#showdiff"><code>showDiff</code></a> 自定义判断函数避免被误判为差异。</p><h2 id="相关-api" tabindex="-1">相关 API <a class="header-anchor" href="#相关-api" aria-label="Permalink to “相关 API”">​</a></h2><p>历史面板的数据均来自 <code>historyService</code> 暴露的聚合方法,详见 <a href="/tmagic-editor/docs/api/editor/historyServiceMethods.html">historyService 方法</a>。</p>`,44)]])}var s=n(a,[[`render`,o]]);export{i as __pageData,s as default};