使用JS实现自定义复制的功能

本文介绍了JS与剪贴板相关的底层功能。

1. 背景

事情的起因是这样的,在从简书上面找了个别人的文章复制了一些内容,当复制的内容超过了一定字数的时候,就发现粘贴出来的东西多了一些内容,如下图所示。

1.png

由于最近刚好在研究JS的复制剪切,于是对这个功能进行深入研究。

2. document.execCommand

之前使用了一个插件Clipboard.js实现了JS的复制功能,研究之后发现是调用HTML5的document.execCommand,才能实现浏览器端的复制功能。

语法

bool = document.execCommand(aCommandName, aShowDefaultUI, aValueArgument)
返回值

一个 Boolean,如果是 false则表示操作不被支持或未被启用。

参数

我们这里只需要用到一些简单的功能,因此只使用第一个参数aCommandName就可以了。
一个 DOMString,命令的名称。可用命令列表请参阅文档。

命令

这里简单介绍一些用到的命令。

copy

拷贝当前选中内容到剪贴板。启用这个功能的条件因浏览器不同而不同,而且不同时期,其启用条件也不尽相同。使用之前请检查浏览器兼容表,以确定是否可用。

cut

剪贴当前选中的文字并复制到剪贴板。启用这个功能的条件因浏览器不同而不同,而且不同时期,其启用条件也不尽相同。使用之前请检查浏览器兼容表,以确定是否可用。

paste

在光标位置粘贴剪贴板的内容,如果有被选中的内容,会被替换。剪贴板功能必须在 user.js 配置文件中启用。


从上面的介绍可以看出,复制功能都是对当前选中内容进行的相关操作,这都需要能获取到当前选中的对象,因此找到了一个新的API。

3. Window.getSelection

这个方法是对用户选择的文本范围进行的一些操作。

概述

返回一个 Selection对象,表示用户选择的文本范围或光标的当前位置。

语法

const selection = window.getSelection() ;
  • selection
    是一个Selection对象。 如果想要将selection转换为字符串,可使用 String.toString()方法。

示例

function foo() {
    let selObj = window.getSelection(); 
    console.log(selObj);
    let selectedText = selObj.toString();
    let selRange = selObj.getRangeAt(0);
    // 其他代码
}
  • selObj 是一个Selection 对象。
  • selectedText 是一个字符串(被选中的文本)。

4. 实现思路

  1. 首先要响应浏览器的copy事件,使用e.preventDefault() 阻止默认的复制事件。
  2. 在响应浏览器的copy事件时,通过Window.getSelection()获取到当前选中内容。然后使用document.createRange()保存下此时用户选中区的状态,以供后面使用。
  3. 创建一个<textarea>标签,将他移到屏幕外边,将上一步中的内容,放到文本框内。并以字符串的形式添加上额外的内容。(注:为了能在添加的内容达到换行的效果,需要使用<textarea>标签而不是<input>,需要换行处添加'\n'字符串)
  4. 使用文本框的setSelectionRange()将文本框的内容选中,使用document.execCommand将此选中的内容进行复制。
  5. 最后,使用selectionObject.addRange(range)将此前选中的选区进行选中。(注:此处详见参考资料3)

5. 实现代码

此代码在新版的chorme和firefox均可生效。

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>addCopy</title>
    <style>
        #test {
            border: 1px solid #000;
        }
    </style>
</head>

<body>

    <dl id="test">
        <dt>
            <code>copy</code>
        </dt>
        <dd>拷贝当前选中内容到剪贴板。启用这个功能的条件因浏览器不同而不同,而且不同时期,其启用条件也不尽相同。使用之前请检查浏览器兼容表,以确定是否可用。</dd>
        <dt>
            <code>cut</code>
        </dt>
        <dd>&nbsp;剪贴当前选中的文字并复制到剪贴板。启用这个功能的条件因浏览器不同而不同,而且不同时期,其启用条件也不尽相同。使用之前请检查浏览器兼容表,以确定是否可用。</dd>
        <dt>
            <code>paste</code>
        </dt>
        <dd>在光标位置粘贴剪贴板的内容,如果有被选中的内容,会被替换。剪贴板功能必须在 user.js 配置文件中启用。</dd>
    </dl>

    <p>复制以上黑框内的内容后在下面textarea粘贴看一下</p>
    <textarea rows="4"></textarea>

    <script type="text/javascript">
        function makeAdditionMessage(targetDom, additionMsg) {
            var body = document.getElementsByTagName('body')[0];
            //使用textarea可以在添加内容的时候产生换行的效果
            var hideTextarea = document.createElement('textarea');
            body.appendChild(hideTextarea);
            hideTextarea.style.position = 'absolute';
            hideTextarea.style.left = '-9999px';
            hideTextarea.style.top = '-9999px';

            targetDom.addEventListener('copy', function (e) {
                // 禁止默认的copy事件
                e.preventDefault();
                var selectionObject = window.getSelection();
                var selectString = selectionObject.toString();

                // 注意,这里制作的range光标选中框需要放在 生成新选区之前进行制作
                var range = document.createRange();
                range.setStart(selectionObject.anchorNode, selectionObject.anchorOffset);
                range.setEnd(selectionObject.focusNode, selectionObject.focusOffset);

                // 添加新增的内容,并将它们放入剪切板
                hideTextarea.value = selectString;
                hideTextarea.value += additionMsg;
                hideTextarea.focus();
                hideTextarea.setSelectionRange(0, hideTextarea.value.length);
                var copy = document.execCommand('copy');

                // 将此前选中的文本再进行选中
                selectionObject.removeAllRanges();
                selectionObject.addRange(range);
            })
        }

        var test = document.getElementById('test');
        var msg = '\n\n这是额外的第一行内容\n这是第二行';
        makeAdditionMessage(test, msg);
    </script>

</body>

</html>

6. 实现效果

  1. 选中某些文本进行复制
3.png
  1. 粘贴出来的示意图
4.png

7. 参考资料

  1. https://developer.mozilla.org/zh-CN/docs/Web/API/Document/execCommand
  2. https://developer.mozilla.org/zh-CN/docs/Web/API/Window/getSelection
  3. http://www.zhangxinxu.com/wordpress/?p=1591
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,457评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,837评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,696评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,183评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,057评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,105评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,520评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,211评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,482评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,574评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,353评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,897评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,489评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,683评论 2 335

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • 内容来自于 iOS文档中 About Text Handling in iOS 部分 ios平台提供了显示及编辑文...
    纵横而乐阅读 6,701评论 2 21
  • 之前是在一些类似于www.bootcss.com类似的网站见到过复制按钮,点击之后一整行文字都可以复制,然后到指定...
    李博洋li阅读 23,652评论 4 9
  • 事件源对象 event.srcElement.tagName event.srcElement.type 捕获释放...
    孤魂草阅读 855评论 0 0
  • Objective 你对今天学的记得什么? 1.尊重就像空气。它存在的时候,你感觉不到它;但一旦它不存在了,你就立...
    太后只说话不发威阅读 186评论 0 0