Clipboard:writeText() 方法

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2020.

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

Clipboard 接口的 writeText() 方法用于将指定文本写入系统剪贴板,并返回一个在剪贴板内容更新后兑现的 Promise

语法

js
writeText(newClipText)

参数

newClipText

要写入剪贴板的字符串。

返回值

一个在剪贴板内容更新后兑现的 Promise

异常

NotAllowedError DOMException

如果不允许写入剪贴板,则抛出此异常。

安全考虑

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

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

示例

本示例将剪贴板内容设置为字符串“<空剪切板>”。

js
button.addEventListener("click", () => writeClipboardText("<空剪切板>"));

async function writeClipboardText(text) {
  try {
    await navigator.clipboard.writeText(text);
  } catch (error) {
    console.error(error.message);
  }
}

规范

Specification
Clipboard API and events
# dom-clipboard-writetext

浏览器兼容性

参见