Clipboard：readText() 方法

Baseline 2024
Newly available

Since April 2024, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

安全上下文: 此项功能仅在一些支持的浏览器的安全上下文（HTTPS）中可用。

Clipboard 接口的 readText() 方法返回一个兑现为系统剪贴板中的文本内容的 Promise。

备注： 如需读取非文本内容，请使用 read() 方法。如需写入文本到剪贴板，请使用 writeText() 方法。

语法

js
readText()

参数

无。

返回值

一个兑现为包含剪贴板文本内容的字符串 Promise。

如果剪贴板为空、不包含文本，或在表示剪贴板内容的对象不存在文本表示形式，则返回空字符串。

异常

NotAllowedError DOMException

如果不允许读取剪贴板，则抛出此异常。

NotFoundError DOMException

如果剪贴板声明包含可表示为文本的数据，但无法提供文本表示时抛出。

安全考虑

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

其他安全要求在 API 概述主题的安全考虑一节中进行了介绍。

示例

本示例获取剪贴板中的文本内容，并将返回的文本插入到选定元素中。

js
async function pasteTextToElement(element) {
  try {
    const text = await navigator.clipboard.readText();
    element.textContent = text;
  } catch (error) {
    console.error(error.message);
  }
}

规范

Specification
Clipboard API and events
# dom-clipboard-readtext

浏览器兼容性

参见