Clipboard: writeText() 方法

Baseline 已广泛支持

此功能已经成熟,并可在许多设备和浏览器版本上使用。自 ⁨2020 年 3 月⁩起,它已在各浏览器中推出。

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

writeText() 方法是 Clipboard 接口的一部分,它将指定的文本写入系统剪贴板。该方法返回一个 Promise,当系统剪贴板更新完成后,Promise 会被解决(resolve)。

语法

js
writeText(newClipText)

参数

newClipText

要写入剪贴板的字符串。

返回值

当剪贴板内容更新完成后被解决的 Promise

异常

NotAllowedError DOMException

如果禁止写入剪贴板,则会抛出此错误。

安全注意事项

写入剪贴板只能在 安全上下文 中进行。

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

示例

此示例将剪贴板内容设置为字符串 "<empty clipboard>"。

js
button.addEventListener("click", () => writeClipboardText("<empty clipboard>"));

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

规范

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

浏览器兼容性

另见