只需 20 行 JavaScript 代码,轻松实现文本复制到剪贴板的功能
使用系统提供的剪贴板是一项基本的IT技能。作为一个开发者,相信你已经知道使用 Ctrl/Cmd+A, Ctrl/Cmd+C 以及 Ctrl/Cmd+V 组合键就能快捷地进行选中、复制、粘贴。
但对于普通用户来说就没那么容易了。即使用户知道剪贴板的存在,视力再好、反应再快的用户也很难选中他们想要的文字。接下来,如果用户没有掌握快捷键,或者没发现浏览器隐藏的“编辑”菜单,又或者没用过右键菜单,再或者不知道在触摸屏上需要进行长按,后续的复制过程也很难简单完成。
如果提供一个一键“复制到剪贴板”按钮,是不是就能帮到大家呢?这样的话即使是熟练的键盘快手也会乐于使用吧。
**剪贴板的安全机制 **
几年前,因为浏览器不具备直接访问剪贴板的能力,开发者只能借助于Flash插件来提供这一基本功能。
乍一看开放剪贴板权限似乎没什么危害,但试想如果浏览器能随意查看和操作剪贴板内容的话,页面脚本(包括第三方脚本)岂不是就能轻松偷窥其中的信息然后将密码,敏感信息,甚至整个页面发送给远端的服务器了。
现在,我们已经可以整合基本的剪贴板功能,但还是有一些限制:
大部分浏览器支持剪贴板功能,Mac和iOS上的Safari除外。
不同浏览器的支持程度不尽相同,一些功能并不完整或存在缺陷。
用户必须通过点击鼠标或按键的方式来主动触发,脚本并不能随时操纵剪贴板。
document.execCommand() 方法
document.execCommand() 是需要调用的关键方法,它可以传入的参数包括 ‘cut’, ‘copy’ 和 ‘paste’ 。这里重点介绍最实用的 document.execCommand(‘copy’) 方法。
在调用之前,可以使用 document.queryCommandSupported(‘copy’); 或 document.queryCommandEnabled(‘copy’); 方法(这两个方法功能相同)来检测浏览器是否支持复制命令。需要注意的是,Chrome 虽然支持复制命令的,但在 Chorme 中这两个方法都会返回 false 值。检测 document.execCommand 方法是否存在也是一个判断方法,但更好的做法是将 document.execCommand(‘copy’) 调用放在 try-catch 块内。
接下来就得考虑用户能复制什么内容了,脚本需要能够选中文本,好在所有的浏览器都允许使用 select() 方法选择文本输入和文本区域的内容,并且在 Firefox 和 Chrome/Opera 浏览器中,还能使用 document.createRange 方法来从任何元素中选择文本。
// select text in #myelement node
// 选择 #myelement 标签中的文本
var
myelement = document.getElementById('#myelement'),
range = document.createRange();
range.selectNode(myelement);
window.getSelection().addRange(range);
然而,IE/Edge 并不支持这一方法。
使用clipboard.js
如果你已经放弃打造一个高鲁棒性的跨浏览器剪贴板方案,那么 clipboard.js 会是一个不错的选择。它提供了多种配置方法,例如通过添加 HTML5 数据属性来指定触发器和复制对象。
<input id="copyme" value="text in this field will be copied" />
<button data-clipboard-target="#copyme">copy</button>
自己来实现
虽然 clipboard.js 只有 2kb,但我们只用20行代码就能实现,前提是你能接受以下条件:
-
只有对应的表单区域能够被复制
-
在一些浏览器中无效(没错,就是Safari),但可以在选中文本后提示用户使用快捷键 Ctrl/Cmd + C。
像 clipboard.js 一样,我们会使用一个按钮作为触发器,添加数据属性(data-copytarget)来指定拷贝内容的目标(#website):
<input type="text" id="website" value="http://www.sitepoint.com/" />
<button data-copytarget="#website">copy</button>
下面的自执行函数会给所有带有 data-copytarget 属性的元素添加一个点击事件处理方法,去选中区域里的文本并执行 document.execCommand(‘copy’) 。如果这一操作失败了,文本将保持选中状态同时弹出提示。
(function() {
'use strict';
// click events
// 添加点击事件
document.body.addEventListener('click', copy, true);
// event handler
// 添加时间处理方法
function copy(e) {
// find target element
// 搜索目标元素
var
t = e.target,
c = t.dataset.copytarget,
inp = (c ? document.querySelector(c) : null);
// is element selectable?
// 判断元素是否能被选中
if (inp &amp;&amp; inp.select) {
// select text
// 选择文本
inp.select();
try {
// copy text
// 复制文本
document.execCommand('copy');
inp.blur();
}
catch (err) {
alert('please press Ctrl/Cmd+C to copy');
}
}
}
})();
其他用途
你还可以设计出更棒的剪贴板功能特性。例如,在 Trello.com 网站中,当你把鼠标指针放在任何卡片上方时,使用快捷键 Ctrl/Cmd+C 就能将卡片的url复制到剪贴板。实际上,程序创建了一个包含 URL 地址的隐藏表单然后进行了选中和复制。虽然我怀疑很少有用户会知道这一功能,但这的确是实用又聪明的方法!
推荐阅读
-
35 岁实现财务*,腾讯程序员手握2300万提前退休?-1000万房产、1000万腾讯股票、加上300万的现金,一共2300万的财产。有网友算了一笔账,假设1000万的房产用于自住,剩下1300万资产按照平均税后20-50万不等进行计算,大约花上26-60年左右的时间才能赚到这笔钱。也就是说,普通人可能奋斗一辈子,才能赚到这笔钱。在很多人还在为中年危机而惶惶不可终日的时候,有的人的35岁,就已经安全着陆,试问哪个打工人不羡慕?但问题是有这样财富积累必然有像样的实力做靠山。没有人可以不劳而获。 看到这里,肯定有人说,那么对于普通人来说,卷可能真就成了唯一的出路。但是卷也有轻松的卷,“偷懒”的卷法,对于程序员而言,刨除掉一时无法改掉的开会传统占用的大部分时间,如何把有限的时间和精力放在真正重要的架构设计、需求设计上,而不是重复的造*,编码、改bug、手动测试。因此在科技改变生活的今天,学会使用AI工具成为程序员们的必备技能。 以全栈式全自动的软件开发工具飞算SoFlu软件机器人为例,作为全球首款面向微服务架构设计和最佳实践的软件机器人,SoFlu软件机器人改变了原来手工编码的作业模式,通过可视化拖拽方式以及参数配置就能实现等同于编写复杂代码的业务逻辑,在设计业务逻辑时就完成了微服务应用开发,做到“业务即图,图即代码”,实现“软件开发,十倍提效”。 而作为飞算SoFlu软件机器人的一个重要组成部分,FuncGPT(慧函数)支持所有类型函数创建。通过自然语言描述Java函数需求,实时生成高质量、高可读性的Java函数代码。生成代码可直接复制到IDEA,或一键导入Java全自动开发工具函数库。 FuncGPT(慧函数)具有五大核心能力: ● 自然语言:通过自然语言即可生成函数,降低软件开发门槛。 ● 秒级函数开发:全自动秒级开发函数,秒级完成,效率千倍提升。 ● 一站式函数开发应用:函数生成即可直接应用,效率、安全有保障。 ● 质量可靠:生成的函数代码符合业界规范、具备良好的可读性,符合最优解。 ● 灵活生成:可以根据开发人员的具体需求生成并支持调整和修改。 以“将文件流转换为File对象”这个需求为例,以下是FuncGPT(慧函数)秒级生成的代码: / 类名:FileConverter // 函数名:convertStreamToFile // 函数功能:将文件流转换为File对象 // POM依赖包:无 import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; public class FileConverter { /** * 将文件流转换为File对象 * @param inputStream 文件流 * @param filePath 文件路径 * @param fileName 文件名 * @return 转换后的File对象 * @throws IOException 如果发生I/O异常 */ public static File convertStreamToFile(InputStream inputStream, String filePath, String fileName) throws IOException { File file = new File(filePath + File.separator + fileName); // 创建File对象 try (FileOutputStream outputStream = new FileOutputStream(file)) { // 创建文件输出流 byte buffer = new byte[1024]; int bytesRead; while ((bytesRead = inputStream.read(buffer)) != -1) { // 从文件流读取数据并写入文件 outputStream.write(buffer, 0, bytesRead); } } return file; // 返回转换后的File对象 } } // 函数示例 // 将文件流转换为File对象示例 // 入参:inputStream,文件流 // 入参:filePath,文件路径 // 入参:fileName,文件名 // 出参:file,转换后的File对象 // 调用示例: // InputStream inputStream = new FileInputStream("example.txt"); // String filePath = "C:\\Users\\User\\Documents"; // String fileName = "example.txt"; // File file = FileConverter.convertStreamToFile(inputStream, filePath, fileName); // System.out.println(file.getAbsolutePath); // 输出结果:例如,将文件流转换为File对象后,文件的绝对路径为:C:\Users\User\Documents\example.txt // 则输出结果为:C:\Users\User\Documents\example.txt 通过分析,不难发现以上代码:
-
只需 20 行 JavaScript 代码,轻松实现文本复制到剪贴板的功能