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

瀏覽器相容性

另見