Clipboard:readText() 方法

Baseline 2024
新推出

自 ⁨2024 年 4 月⁩ 起,此功能可在最新的设备和浏览器版本中运行。此功能可能不适用于较旧的设备或浏览器。

安全上下文: 此功能仅在安全上下文(HTTPS)中可用,且支持此功能的浏览器数量有限。

Clipboard 接口的 readText() 方法返回一个 Promise,该 Promise 会以系统剪贴板的文本内容副本的形式 fulfilled。

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

语法

js
readText()

参数

无。

返回值

一个 Promise,它会以包含剪贴板文本内容的字符串形式解析。

如果剪贴板为空、不包含文本,或者不包含代表剪贴板内容的对象的文本表示形式,则返回一个空字符串。

异常

NotAllowedError DOMException

如果不允许读取剪贴板的访问权限,则抛出该异常。

NotFoundError DOMException

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

安全注意事项

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

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

示例

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

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

规范

规范
Clipboard API 和事件
# dom-clipboard-readtext

浏览器兼容性

另见