剪贴板:readText() 方法

基线 2024

新可用

2024 年 6 月起,此功能在最新设备和浏览器版本中均可使用。此功能可能无法在较旧的设备或浏览器中使用。

安全上下文:此功能仅在安全上下文(HTTPS)中,在部分或所有支持的浏览器中可用。

readText() 方法是Clipboard 接口的方法,它返回一个Promise,该 promise fulfilled 时会返回系统剪贴板中文本内容的副本。

注意:要从剪贴板读取非文本内容,请使用read() 方法。可以使用writeText() 将文本写入剪贴板。

语法

js
readText()

参数

无。

返回值

一个Promise,解析为包含剪贴板文本内容的字符串。

如果剪贴板为空,不包含文本,或在代表剪贴板内容的对象中不包含文本表示,则返回空字符串。

异常

NotAllowedError DOMException

如果无法读取剪贴板,则抛出该异常。

NotFoundError DOMException

如果剪贴板表明它包含可以表示为文本的数据,但无法提供文本表示,则抛出该异常。

安全注意事项

只能在安全上下文中读取剪贴板。

其他安全要求在 API 概述主题的安全注意事项部分中进行了介绍。

示例

此示例检索剪贴板的文本内容,并将返回的文本插入到选定元素的内容中。

js
const destination = document.getElementById("outbox");
destinationImage.addEventListener("click", () => {
  navigator.clipboard
    .readText()
    .then((clipText) => (destination.innerText = clipText));
});

规范

规范
剪贴板 API 和事件
# dom-clipboard-readtext

浏览器兼容性

BCD 表格仅在启用了 JavaScript 的浏览器中加载。

另请参阅