tmagic-editor

Appearance

editorService方法 ​

get ​

  • 参数：

    • {'root' | 'page' | 'parent' | 'node' | 'highlightNode' | 'nodes' | 'modifiedNodeIds' | 'pageLength' | 'stage'} name

  • 返回：

    • {any} value

  • 详情：

    获取当前指指定name的值

    'root': 当前整个配置，也就是当前编辑器的值

    'page': 当前正在编辑的页面配置

    'parent': 当前选中的节点的父节点

    'node': 当前选中的第一个节点

    'highlightNode': 当前高亮的节点

    'nodes': 当前选中的所有节点

    'modifiedNodeIds': 当前页面所有改动过的节点id

    'pageLength': 所以页面个数

    'stage': StageCore实例

  • 示例：

js
import { editorService } from '@tmagic/editor';

const node = editorService.get('node');

set ​

  • {'root' | 'page' | 'parent' | 'node' | 'highlightNode' | 'nodes' | 'modifiedNodeIds' | 'pageLength' | 'stage'} name

  • {any} value

  • 详情： 参考get方法

  • 示例：

js
import { editorService } from '@tmagic/editor';

const node = editorService.get('node');

editorService.set('node', {
  ...node,
  name: 'new name'
});

getNodeInfo ​

  • 参数：

    • {number | string} id 组件id

    • {boolean} raw 是否使用toRaw，默认为true

TIP

如果raw为false，对获取到的对象进行操作会触发vue响应式处理

  • 返回：

  • 详情：

    根据id获取组件、组件的父组件以及组件所属的页面节点

  • 示例：

js
import { editorService } from '@tmagic/editor';

const info = editorService.getNodeInfo('text_123');

console.log(info.node);
console.log(info.parent);
console.log(info.page);

getNodeById ​

  • 参数：

    • {number | string} id

    • {boolean} raw 是否使用toRaw，默认为true

  • 返回：

    • {MNode} 组件节点配置

  • 详情：

    根据id获取组件的信息

  • 示例：

js
import { editorService } from '@tmagic/editor';

const node = editorService.getNodeById('text_123');

console.log(node);

getParentById ​

  • 参数：

    • {number | string} id

    • {boolean} raw 是否使用toRaw，默认为true

  • 返回：

    • {MNode} 指点组件的父节点配置

  • 详情：

    根据ID获取指点节点的父节点配置

  • 示例：

js
import { editorService } from '@tmagic/editor';

const parent = editorService.getParentById('text_123');

console.log(parent);

getLayout ​

  • 扩展支持： 是

  • 参数：

  • 返回：

    • {Promise<Layout>} 当前布局模式

  • 详情：

    只有容器拥有布局，目前支持的布局有流式布局（relative），绝对定位布局（absolute），固定定位布局（fixed）

    TIP

    固定定位布局需要从当前选中节点判断，固需要传递可选参数 node

    其他布局则是从父组件（容器）来判断

  • 示例：

js
import { editorService } from '@tmagic/editor';

const parent = editorService.getParentById('text_123');
editorService.getLayout(parent).then((layout) => {
  console.log(parent);
});

select ​

  • 扩展支持： 是

  • 参数：

    • {number | string | MNode} config 需要选中的节点或节点ID

  • 返回：

    • {Promise<MNode>} 当前选中的节点配置

  • 详情：

    选中指点节点（将指点节点设置成当前选中状态）

    TIP

    editorService.select只是设置了编辑器的选中状态，并没有设置画布的选中状态，所以根据实际情况可以调用stage.select来设置画布的选中态

  • 示例：

js
import { editorService } from '@tmagic/editor';

editorService.select('text_123');
editorService.get('stage')?.select('text_123');

multiSelect ​

  • 参数：

    • {(number | string)[]} ids 需要选中的节点ID集合

  • 返回：

    • {Promise<void>}

  • 详情：

    选中多个节点

    TIP

    editorService.multiSelect只是设置了编辑器的选中状态，并没有设置画布的选中状态，所以根据实际情况可以调用stage.multiSelect来设置画布的选中态

  • 示例：

js
import { editorService } from '@tmagic/editor';

editorService.multiSelect(['text_123', 'button_123']);
editorService.get('stage')?.multiSelect(['text_123', 'button_123']);

highlight ​

  • 扩展支持： 是

  • 参数：

    • {number | string | MNode} config 需要高亮的节点或节点ID

  • 返回：

    • {Promise<void>}

  • 详情：

    高亮指定节点

  • 示例：

js
import { editorService } from '@tmagic/editor';

editorService.highlight('text_123');

doAdd ​

  • 扩展支持： 是

  • 参数：

  • 返回：

    • {Promise<MNode>} 新增的组件

  • 详情：

    往指定的容器中添加组件

add ​

  • 扩展支持： 是

  • 参数：

    • {MNode | MNode[]} node 新组件节点配置或多个节点集合

    • {MContainer} parent 指定的容器组件节点配置，如果不设置，默认为当前选中的组件的父节点

  • 返回：

    • {Promise<MNode | MNode[]>} 新增的组件或组件集合

  • 详情：

    往指定的容器或当前容器中添加组件

    TIP

    与doAdd的区别：

    add可以支持一次添加多个组件，add是通过调用doAdd来最终实现添加的。

    编辑器内部添加组件都是调用add来实现的，add除了添加操作外，还会记录历史堆栈，还会更新编辑中相关的状态，而doAdd就仅仅是完成添加的行为

doRemove ​

  • 扩展支持： 是

  • 参数：

    • {MNode} node 要删除的节点

  • 返回：

    • {Promise<void>}

  • 详情：

    删除指定的组件或者页面

remove ​

  • 扩展支持： 是

  • 参数：

    • {MNode | MNode[])} node 要删除的节点或节点集合

  • 返回：

    • {Promise<void>}

  • 详情：

    删除指定的组件或者页面或组件集合

    TIP

    与doRemove的区别：

    remove可以支持一次删除多个组件，remove是通过调用doRemove来最终实现删除的。

    编辑器内部删除组件都是调用remove来实现的，remove除了删除操作外，还会记录历史堆。

doUpdate ​

  • 扩展支持： 是

  • 参数：

  • {MNode | MNode)} node 新的节点

  • 返回：

  • 详情：

    更新节点

    TIP

    节点中应该要有id，不然不知道要更新哪个节点

update ​

  • 扩展支持： 是

  • 参数：

    • {Promise<MNode | MNode[]>} node 新的节点或节点集合

  • 返回：

    • {Promise<MNode | MNode[]>} 新的节点或节点集合

  • 详情：

    更新单个或多个节点

    TIP

    与doUpdate的区别：

    update可以支持一次更新多个组件，update是通过调用doUpdate来最终实现更新的。

    编辑器内部更新组件都是调用update来实现的，update除了更新操作外，还会记录历史堆，还会更新代码块关系链。

sort ​

  • 扩展支持： 是

  • 参数：

    • { string | number } id1
    • { string | number } id2

  • 返回：

    • {Promise<void>}

  • 详情：

    将id为id1的组件移动到id为id2的组件位置上，例如：[1,2,3,4] -> sort(1,3) -> [2,1,3,4]

    用于流式布局下的组件拖动更新

copy ​

  • 扩展支持： 是

  • 参数：

    • {Promise<MNode | MNode[]>} node 需要复制的节点或节点集合

  • 返回：

    • {Promise<void>}

  • 详情：

复制组件节点或节点集合

通过storageService.setItem,将组将节点配置转化成string，然后存储到localStorage中

doPaste ​

  • 扩展支持： 是

  • 参数：

  • 返回：

    • {Promise<void>}

  • 详情：

粘贴前置操作：返回分配了新id以及校准了坐标的配置

paste ​

粘贴组件节点或节点集合

通过storageService.getItem,从localStorage中获取节点，然后添加到当前容器中

doAlignCenter ​

  • 扩展支持： 是

  • 参数：

    • {MNode} config 需要居中的组件

  • 返回：

  • 详情：

    水平居中组件节点，仅在流式布局下有效

    WARNING

    仅是计算出left，并未更新到编辑器中

alignCenter ​

水平居中组件或者组件集合，仅在流式布局下有效

TIP

与doAlignCenter的区别：

alignCenter可以支持一次水平居中多个组件，alignCenter是通过调用doAlignCenter来获取到已设置好水平居中的位置信息的节点，然后调用update更新。

moveLayer ​

  • 扩展支持： 是

  • 参数：

    • {number | 'top' | 'bottom'} offset

  • 返回：

    • {Promise<void>}

  • 详情：

    移动当前选中节点位置

    用于实现上移一层、下移一层、置顶、置底

moveToContainer ​

  • 扩展支持： 是

  • 参数：

    • {MNode} config 需要移动的节点
    • {string | number} targetId 容器ID

  • 返回：

    • Promise<MNode | undefined>

  • 详情：

    移动到指定容器中

undo ​

redo ​

move ​

  • 扩展支持： 是

  • 参数：

    • {number} left
    • {number} top

  • 返回：

    • {Promise<void>}

  • 详情：

    更新当前选中组件位置，通常用于键盘上下左右快捷键操作

resetModifiedNodeId ​

  • 详情：

重置当前记录的修改过的节点id记录，通常用于保存之后

resetState ​

  • 详情：

清空state

destroy ​

  • 详情：

    销毁editorService

    移除所有事件监听，清空state，移除所有插件

use ​

使用中间件的方式扩展方法，上述方法中标记有扩展支持： 是的方法都支持使用use扩展

  • 示例：
js
import { editorService, getAddParent } from '@tmagic/editor';
import { ElMessageBox } from 'element-plus';

editorService.use({
  // 添加是否删除节点确认提示
  async remove(node, next) {
    await ElMessageBox.confirm('是否删除', '提示', {
      confirmButtonText: '确定',
      cancelButtonText: '取消',
      type: 'warning',
    });

    next();
  },

  add(node, next) {
    // text组件只能添加到container中
    const parentNode = getAddParent(node);
    if (node.type === 'text' && parentNode?.type !== 'container') {
      return;
    }

    next();
  },
});

usePlugin ​

  • 详情：

相对于use, usePlugin支持更加灵活更加细致的扩展， 上述方法中标记有扩展支持： 是的方法都支持使用usePlugin扩展

每个支持扩展的方法都支持定制before、after两个hook来干预原有方法的行为，before可以用于修改传入参数，after可以用于修改返回的值

  • 示例：
js
import { editorService } from '@tmagic/editor';

editorService.usePlugin({
  // 添加组件的时候设置一个添加时间
  beforeDoAdd: (config, parent) => {
    config.addTime = new Date().getTime();

    return [config, parent];
  },
});

removeAllPlugins ​

  • 详情：

删掉当前设置的所有扩展

Powered by 腾讯视频会员平台技术中心

Copyright (C) 2023 THL A29 Limited, a Tencent company.