经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » JS/JS库/框架 » JavaScript » 查看文章
Canvas简历编辑器-我的剪贴板里究竟有什么数据
来源:cnblogs  作者:WindrunnerMax  时间:2024/5/8 9:16:39  对本文有异议

Canvas图形编辑器-我的剪贴板里究竟有什么数据

在这里我们先来聊聊我们究竟应该如何操作剪贴板,也就是我们在浏览器的复制粘贴事件,并且在此基础上聊聊我们在Canvas图形编辑器中应该如何控制焦点以及如何实现复制粘贴行为。

关于Canvas简历编辑器项目的相关文章:

剪贴板

我们在平时使用一些在线文档编辑器的时候,可能会好奇一个问题,为什么我能够直接把格式复制出来,而不仅仅是纯文本,甚至于说从浏览器中复制内容到Office Word都可以保留格式,看起来是不是一件很神奇的事情,不过当我们了解到剪贴板的基本操作之后,就可以了解这其中的底层实现了。

说到剪贴板,我们可能以为我们复制的就是纯文本,当然显然光靠复制纯文本我们是做不到这一点的,所以实际上剪贴板是可以存储复杂内容的,那么在这里我们以Word为例,当我们从Word中复制文本时,其实际上是会在剪贴板中写入这么几个key值:

  1. text/plain
  2. text/html
  3. text/rtf
  4. image/png

看着text/plain是不是很眼熟,这明显就是我们常见的Content-Type或者称作MIME-Type,所以说我们是不是可以认为剪贴板是一个Record<string, string>的类型,但是别忽略了我们还有一个image/png类型,因为我们的剪贴板是可以复制文件的,所以我们常用的剪贴板类型就是Record<string, string | File>例如此时复制这段文字在剪贴板中就是如下内容

  1. text/plain
  2. 例如此时复制这段文字在剪贴板中就是如下内容
  3. text/html
  4. <meta charset='utf-8'><strong style="...">例如此时复制这段文字</strong><em style="...">在剪贴板中就是如下内容</em>

那么我们粘贴的时候就很明显了,我们只需要从剪贴板里读取内容就可以了,例如我们从语雀复制内容到飞书中,我们在语雀复制的时候会将text/plain以及text/html写入剪贴板,在粘贴到飞书的时候就可以首先检查是否有text/htmlkey,如果有的话就可以读取出来,并且将其解析成为飞书自己的私有格式,就可以通过剪贴板来保持内容格式粘贴到飞书了,如果没有text/html的话,就直接将text/plain的内容写到私有的JSON数据即可。

此外,我们还可以考虑到一个问题,在上边的例子中实际上我们是复制时需要将JSON转到HTML字符串,在粘贴时需要将HTML字符串转换为JSON,这都是需要进行序列化与反序列化的,是需要有性能消耗以及内容损失的,所以是不是能减少这部分消耗,那么当然是可以的,通常来说如果是在应用内直接直接粘贴的话,可以直接通过剪贴板的数据直接compose到当前的JSON即可,这样就可以更完整地保持内容以及减少对于HTML解析的消耗。例如在飞书中,会有docx/text的独立Clipboard Key以及data-lark-record-data作为独立JSON数据源。

那么至此我们已经了解到剪贴板的工作原理,紧接着我们就来聊一聊如何进行复制操作,说到复制我们可能通常会想到clipboard.js,如果需要兼容性比较高的话可以考虑,但是如果需要在现在浏览器中使用的话,则可以直接考虑使用HTML5规范的API完成,在浏览器中关于复制的API常用的有两种,分别是document.execCommand("copy")以及navigator.clipboard.write

对于document.execCommand("copy")来说,我们可以直接借助textarea + execCommand来执行写剪贴板的操作,在这里需要注意的是如果这个事件必须要是isTrusted的事件,也就是说这个事件必须要是用户触发的,例如点击事件、键盘事件等等,如果我们在打开页面后直接执行这段代码的话,则实际上是不会触发的。此外,如果在控制台执行这段代码的话,写入剪贴板是可行的,因为我们通常会用回车这个操作来执行代码,所以这个事件是isTrusted的。

  1. const TEXT_PLAIN = "text/plain";
  2. const data = {"text/plain": "1", "text/html":"<div>1</div>"};
  3. const textarea = document.createElement("textarea");
  4. textarea.addEventListener(
  5. "copy",
  6. event => {
  7. for (const [key, value] of Object.entries(data)) {
  8. event.clipboardData && event.clipboardData.setData(key, value);
  9. }
  10. event.stopPropagation();
  11. event.preventDefault();
  12. },
  13. true
  14. );
  15. textarea.style.position = "fixed";
  16. textarea.style.left = "-999px";
  17. textarea.style.top = "-999px";
  18. textarea.value = data[TEXT_PLAIN];
  19. document.body.appendChild(textarea);
  20. textarea.select();
  21. document.execCommand("copy");
  22. document.body.removeChild(textarea);

对于navigator.clipboard来说,如果我们只写入纯文本的话是比较简单的,直接调用write方法即可,只不过需要注意Document is focused,也就是焦点需要在当前页面内。如果需要在剪贴板中写入其他的值,则需要ClipboardItem对象来写入Blob,在这里需要注意的是,FireFox只有Nightly中有定义,所以在这里需要判断下,如果不存在这个对象的话就需要走降级的复制,可以使用上述的document.execCommand API

  1. const data = {"text/plain": "1", "text/html":"<div>1</div>"};
  2. if (navigator.clipboard && window.ClipboardItem) {
  3. const dataItems = {};
  4. for (const [key, value] of Object.entries(data)) {
  5. const blob = new Blob([value], { type: key });
  6. dataItems[key] = blob;
  7. }
  8. navigator.clipboard.write([new ClipboardItem(dataItems)]);
  9. }

紧接着我们可以聊下粘贴行为,在这里我们可以用onPaste事件以及navigator.clipboard.read方法,对于navigator.clipboard.read方法来说,我们可以直接读取并且打印即可,在这里需要注意的是需要Document is focused,所以这里我们需要在控制台延时几秒,然后将鼠标点击到页面上才可以正常打印,此外还有一个问题是打印的types并不完整,可能是必须要规范内的MIME Type才直接支持,自定义的key不支持。

  1. navigator.clipboard.read().then(res => {
  2. for (const item of res) {
  3. const types = item.types;
  4. for (const type of types) {
  5. item.getType(type).then(data => {
  6. const reader = new FileReader();
  7. reader.readAsText(data, "utf-8");
  8. reader.onload = () => {
  9. console.info(type, reader.result);
  10. };
  11. });
  12. }
  13. }
  14. });

针对onPaste事件,我们可以通过clipboardData获取更加完整的相关数据,我们可以获取比较完整的数据以及构造File数据,这里可以使用下面的代码直接在控制台执行,并且可以将内容粘贴到其中,这样就可以打印出当前剪贴板的内容了。

  1. const input = document.createElement("input");
  2. input.style.position = "fixed";
  3. input.style.top = "100px";
  4. input.style.right = "10px";
  5. input.style.zIndex = "999999";
  6. input.style.width = "200px";
  7. input.placeholder = "Read Clipboard On Paste";
  8. input.addEventListener("paste", event => {
  9. const clipboardData = event.clipboardData || window.clipboardData;
  10. for (const item of clipboardData.items) {
  11. console.log(`%c${item.type}`, "background-color: #165DFF; color: #fff; padding: 3px 5px;");
  12. console.log(item.kind === "file" ? item.getAsFile() : clipboardData.getData(item.type));
  13. }
  14. });
  15. document.body.appendChild(input);

Clipboard模块

上边我们已经了解到如何操作我们的剪贴板了,那么下面我们就需要将其应用在编辑器当中了,不过我们首先需要关注焦点问题,因为在编辑器中我们不能保证所有的焦点都是在编辑器Canvas上的,比如我弹出一个输入框输入画布大小的时候,也是可能会使用粘贴行为的,而如果此时进行粘贴是会触发document上的onPaste事件的,那么此时就有可能错误的将不应该粘贴的内容插入到剪贴板当中了,所以我们需要处理焦点,也就是说我们需要确定当前操作是在编辑器上的时候才触发Copy/Paste行为。

平时我做富文本相关的功能比较多,所以在实现画板的时候总想按照富文本的设计思路来实现,同样的因为之前也说过我们需要实现History以及在编辑面板富文本的能力,所以焦点就很重要,如果焦点不在画板上的时候如果按下Undo/Redo键画板是不应该响应的,所以现在就需要有一个状态来控制当前焦点是否在Canvas上,经过调研发现了两个方案,方案一是使用document.activeElement,但是Canvas是不会有焦点的,所以需要将tabIndex="-1"属性赋予Canvas元素,这样就可以通过activeElement拿到焦点状态了,方案二是在Canvas上方再覆盖一层div,通过pointerEvents: none来防止事件的鼠标指针事件,但是此时通过window.getSelection是可以拿到焦点元素的,此时只需要再判断焦点元素是不是设置的这个元素就可以了。

当焦点的问题解决之后,我们就可以直接进行剪贴板的读写了,这部分实现就比较简单了,在复制的时候需要注意到将内容序列化为JSON字符串,并且还要写入一个text/plain的占位符,这样可以让用户在其他地方粘贴的时候是有感知的,对于我们的编辑器自身而言是不需要感知的。

  1. public static KEY = "SKETCHING_CLIPBOARD_KEY";
  2. private copyFromCanvas = (e: ClipboardEvent, isCut = false) => {
  3. const clipboardData = e.clipboardData;
  4. if (clipboardData) {
  5. const ids = this.editor.selection.getActiveDeltaIds();
  6. if (ids.size === 0) return void 0;
  7. const data: Record<string, DeltaLike> = {};
  8. for (const id of ids) {
  9. const delta = this.editor.deltaSet.get(id);
  10. if (!delta) return void 0;
  11. data[id] = delta.toJSON();
  12. if (isCut) {
  13. const parentId = this.editor.state.getDeltaStateParentId(id);
  14. this.editor.state.apply(new Op(OP_TYPE.DELETE, { id, parentId }));
  15. }
  16. }
  17. const str = TSON.stringify(data);
  18. str && clipboardData.setData(Clipboard.KEY, str);
  19. clipboardData.setData("text/plain", "请在编辑器中粘贴");
  20. isCut && this.editor.canvas.mask.clearWithOp();
  21. e.stopPropagation();
  22. e.preventDefault();
  23. }
  24. };

粘贴的这部分需要处理一个交互问题,用户肯定是希望在多选时也可以直接粘贴多个图形的,所以在此处我们需要处理好粘贴的位置,在这里我用的方法是取的所有选中图形的中点,在用户触发粘贴行为时将中点对齐到此时鼠标所在的位置,并且计算好偏移量应用到反序列化的图形上,这样就可以做到跟随用户的鼠标进行粘贴了,这里还有一点是需要替换掉粘贴图形的id,这是新的图形当然就需要有新的唯一标识符。

  1. public static KEY = "SKETCHING_CLIPBOARD_KEY";
  2. private onPaste = (e: ClipboardEvent) => {
  3. if (!this.editor.canvas.isActive()) return void 0;
  4. const clipboardData = e.clipboardData;
  5. if (clipboardData) {
  6. const str = clipboardData.getData(Clipboard.KEY);
  7. const data = str && TSON.parse<Record<string, DeltaLike>>(str);
  8. if (data) {
  9. let range: Range | null = null;
  10. Object.values(data).forEach(deltaLike => {
  11. const { x, y, width, height } = deltaLike;
  12. const current = Range.fromRect(x, y, width, height);
  13. range = range ? range.compose(current) : current;
  14. });
  15. const compose = range as unknown as Range;
  16. if (compose) {
  17. const center = compose.center();
  18. const cursor = this.editor.canvas.root.cursor;
  19. const { x, y } = center.diff(cursor);
  20. Object.values(data).forEach(deltaLike => {
  21. const id = getUniqueId();
  22. deltaLike.id = id;
  23. deltaLike.x = deltaLike.x + x;
  24. deltaLike.y = deltaLike.y + y;
  25. const delta = DeltaSet.create(deltaLike);
  26. delta &&
  27. this.editor.state.apply(new Op(OP_TYPE.INSERT, { delta, parentId: ROOT_DELTA }));
  28. });
  29. }
  30. }
  31. e.stopPropagation();
  32. e.preventDefault();
  33. }
  34. };

最后

本文我们介绍总结了应该如何操作剪贴板,也就是我们在浏览器的复制粘贴行为,并且在此基础上聊到了在Canvas图形编辑器中的焦点问题以及如何实现复制粘贴行为,虽然暂时不涉及到Canvas本身,但是这都是作为编辑器本身的基础能力,也是通用的能力可以学习。针对于这个编辑器我们可以介绍的能力还有很多,整体来看会涉及到数据结构、History模块、复制粘贴模块、画布分层、事件管理、无限画布、按需绘制、性能优化、焦点控制、参考线、富文本、快捷键、层级控制、渲染顺序、事件模拟、PDF排版等等,整体来说还是比较有意思的,欢迎关注我并留意后续的文章。

原文链接:https://www.cnblogs.com/WindrunnerMax/p/18176735

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号