剪贴板:writeText() 方法

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

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

语法

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);
  }
}

规范

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

浏览器兼容性

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

另请参阅