概述
有三个主要的浏览器 API 可用于复制到剪贴板:
异步剪贴板 API [navigator.clipboard.writeText]
document.execCommand('copy')
(已弃用)👎
- 截至 2015 年 4 月,大多数浏览器都支持此功能(请参阅下面的浏览器支持)。
- 访问是同步的,即停止页面中的 JavaScript,直到完成包括显示和用户与任何安全提示交互。
- 文本从 DOM 中读取并放置在剪贴板上。
- 在 2015 年 4 月的测试期间,只有 Internet Explorer 被记录为在写入剪贴板时显示权限提示。
覆盖复制事件
- 请参阅关于覆盖复制事件的剪贴板 API 文档。
- 允许您从任何复制事件修改剪贴板上显示的内容,可以包括纯文本以外的其他格式的数据。
- 此处未涵盖,因为它不直接回答问题。
一般开发说明
在控制台中测试代码时,不要指望剪贴板相关的命令可以工作。通常,页面需要处于活动状态(异步剪贴板 API)或需要用户交互(例如用户单击)以允许 ( document.execCommand('copy')
) 访问剪贴板,请参见下文了解更多详细信息。
重要事项(此处注明 2020/02/20)
请注意,由于这篇文章最初是针对跨源IFRAME和其他IFRAME“沙箱”中的权限编写的,因此阻止了嵌入式演示的“运行代码片段”按钮和“codepen.io 示例”在某些浏览器(包括 Chrome 和 Microsoft Edge)中工作)。
要开发创建您自己的网页,请通过 HTTPS 连接提供该页面以进行测试和开发。
这是一个演示代码工作的测试/演示页面:https :
//deanmarktaylor.github.io/clipboard-test/
异步 + 回退
由于浏览器对新的 Async Clipboard API 的支持级别,您可能希望回退到该document.execCommand('copy')
方法以获得良好的浏览器覆盖率。
这是一个简单的示例(可能无法嵌入本站点,请阅读上面的“重要”注释):
function fallbackCopyTextToClipboard(text) {
var textArea = document.createElement("textarea");
textArea.value = text;
// Avoid scrolling to bottom
textArea.style.top = "0";
textArea.style.left = "0";
textArea.style.position = "fixed";
document.body.appendChild(textArea);
textArea.focus();
textArea.select();
try {
var successful = document.execCommand('copy');
var msg = successful ? 'successful' : 'unsuccessful';
console.log('Fallback: Copying text command was ' + msg);
} catch (err) {
console.error('Fallback: Oops, unable to copy', err);
}
document.body.removeChild(textArea);
}
function copyTextToClipboard(text) {
if (!navigator.clipboard) {
fallbackCopyTextToClipboard(text);
return;
}
navigator.clipboard.writeText(text).then(function() {
console.log('Async: Copying to clipboard was successful!');
}, function(err) {
console.error('Async: Could not copy text: ', err);
});
}
var copyBobBtn = document.querySelector('.js-copy-bob-btn'),
copyJaneBtn = document.querySelector('.js-copy-jane-btn');
copyBobBtn.addEventListener('click', function(event) {
copyTextToClipboard('Bob');
});
copyJaneBtn.addEventListener('click', function(event) {
copyTextToClipboard('Jane');
});
<div style="display:inline-block; vertical-align:top;">
<button class="js-copy-bob-btn">Set clipboard to BOB</button><br /><br />
<button class="js-copy-jane-btn">Set clipboard to JANE</button>
</div>
<div style="display:inline-block;">
<textarea class="js-test-textarea" cols="35" rows="4">Try pasting into here to see what you have on your clipboard:
</textarea>
</div>
(codepen.io 示例可能不起作用,请阅读上面的“重要”注释)请注意,此代码段在 Stack Overflow 的嵌入式预览中效果不佳,您可以在此处尝试:https ://codepen.io/DeanMarkTaylor/pen/RMRaJX?editors =1011
异步剪贴板 API
请注意,可以通过 Chrome 66 中的权限 API 来“请求权限”并测试对剪贴板的访问权限。
var text = "Example text to appear on clipboard";
navigator.clipboard.writeText(text).then(function() {
console.log('Async: Copying to clipboard was successful!');
}, function(err) {
console.error('Async: Could not copy text: ', err);
});
document.execCommand('复制')
这篇文章的其余部分将介绍document.execCommand('copy')
API的细微差别和细节。
浏览器支持
JavaScriptdocument.execCommand('copy')
支持有所增加,请参阅以下浏览器更新链接: (已弃用)👎
简单示例
(可能无法嵌入本网站,请阅读上面的“重要”说明)
var copyTextareaBtn = document.querySelector('.js-textareacopybtn');
copyTextareaBtn.addEventListener('click', function(event) {
var copyTextarea = document.querySelector('.js-copytextarea');
copyTextarea.focus();
copyTextarea.select();
try {
var successful = document.execCommand('copy');
var msg = successful ? 'successful' : 'unsuccessful';
console.log('Copying text command was ' + msg);
} catch (err) {
console.log('Oops, unable to copy');
}
});
<p>
<button class="js-textareacopybtn" style="vertical-align:top;">Copy Textarea</button>
<textarea class="js-copytextarea">Hello I'm some text</textarea>
</p>
复杂示例:复制到剪贴板而不显示输入
如果屏幕上有一个textarea
orinput
元素可见,上面的简单示例效果很好。
在某些情况下,您可能希望将文本复制到剪贴板而不显示input
/textarea
元素。这是解决此问题的方法的一个示例(基本上是插入一个元素,复制到剪贴板,删除元素):
使用 Google Chrome 44、Firefox 42.0a1 和 Internet Explorer 11.0.8600.17814 进行测试。
(可能无法嵌入本网站,请阅读上面的“重要”说明)
function copyTextToClipboard(text) {
var textArea = document.createElement("textarea");
//
// *** This styling is an extra step which is likely not required. ***
//
// Why is it here? To ensure:
// 1. the element is able to have focus and selection.
// 2. if the element was to flash render it has minimal visual impact.
// 3. less flakyness with selection and copying which **might** occur if
// the textarea element is not visible.
//
// The likelihood is the element won't even render, not even a
// flash, so some of these are just precautions. However in
// Internet Explorer the element is visible whilst the popup
// box asking the user for permission for the web page to
// copy to the clipboard.
//
// Place in the top-left corner of screen regardless of scroll position.
textArea.style.position = 'fixed';
textArea.style.top = 0;
textArea.style.left = 0;
// Ensure it has a small width and height. Setting to 1px / 1em
// doesn't work as this gives a negative w/h on some browsers.
textArea.style.width = '2em';
textArea.style.height = '2em';
// We don't need padding, reducing the size if it does flash render.
textArea.style.padding = 0;
// Clean up any borders.
textArea.style.border = 'none';
textArea.style.outline = 'none';
textArea.style.boxShadow = 'none';
// Avoid flash of the white box if rendered for any reason.
textArea.style.background = 'transparent';
textArea.value = text;
document.body.appendChild(textArea);
textArea.focus();
textArea.select();
try {
var successful = document.execCommand('copy');
var msg = successful ? 'successful' : 'unsuccessful';
console.log('Copying text command was ' + msg);
} catch (err) {
console.log('Oops, unable to copy');
}
document.body.removeChild(textArea);
}
var copyBobBtn = document.querySelector('.js-copy-bob-btn'),
copyJaneBtn = document.querySelector('.js-copy-jane-btn');
copyBobBtn.addEventListener('click', function(event) {
copyTextToClipboard('Bob');
});
copyJaneBtn.addEventListener('click', function(event) {
copyTextToClipboard('Jane');
});
<div style="display:inline-block; vertical-align:top;">
<button class="js-copy-bob-btn">Set clipboard to BOB</button><br /><br />
<button class="js-copy-jane-btn">Set clipboard to JANE</button>
</div>
<div style="display:inline-block;">
<textarea class="js-test-textarea" cols="35" rows="4">Try pasting into here to see what you have on your clipboard:
</textarea>
</div>
补充说明
仅当用户采取行动时才有效
所有document.execCommand('copy')
调用都必须作为用户操作的直接结果发生,例如单击事件处理程序。这是一种防止在用户不期望的情况下弄乱剪贴板的措施。
有关详细信息,请参阅此处的Google Developers 帖子。
剪贴板 API
请注意,可以在此处找到完整的剪贴板 API 草案规范:https :
//w3c.github.io/clipboard-apis/
是否支持?
document.queryCommandSupported('copy')
true
如果命令“受浏览器支持”,则应返回。
- 并
document.queryCommandEnabled('copy')
返回true
如果document.execCommand('copy')
会成功,如果现在叫。检查以确保从用户启动的线程调用命令并满足其他要求。
然而,作为浏览器兼容性问题的一个例子,从 2015 年 4 月到 10 月的 Google Chrome 浏览器只有在true
从document.queryCommandSupported('copy')
用户启动的线程调用命令时才返回。
请注意下面的兼容性详细信息。
浏览器兼容性详情
虽然对document.execCommand('copy')
包装在try
/catch
块中的简单调用作为用户单击的结果调用将使您获得最大的兼容性,但以下有一些限制条件:
对document.execCommand
, document.queryCommandSupported
or 的任何调用document.queryCommandEnabled
都应包含在try
/catch
块中。
不同的浏览器实现和浏览器版本在调用而不是返回时会抛出不同类型的异常false
。
不同的浏览器实现仍在不断变化,剪贴板 API仍在草案中,所以请记住进行测试。