Clipboard:readText() 方法

Baseline 2024
新推出

自 ⁨2024 年 4 月⁩ 起,此功能可在最新的裝置和瀏覽器版本中執行。此功能可能不適用於較舊的裝置或瀏覽器。

安全上下文: 此功能僅在安全上下文(HTTPS)中可用,且支援此功能的瀏覽器數量有限。

Clipboard 介面的 readText() 方法返回一個 Promise,該 Promise 會以系統剪貼簿的文字內容副本的形式 fulfilled。

注意: 要從剪貼簿讀取非文字內容,請改用 read() 方法。您可以使用 writeText() 將文字寫入剪貼簿。

語法

js
readText()

引數

無。

返回值

一個 Promise,它會以包含剪貼簿文字內容的字串形式解析。

如果剪貼簿為空、不包含文字,或者不包含代表剪貼簿內容的物件的文字表示形式,則返回一個空字串。

異常

NotAllowedError DOMException

如果不允許讀取剪貼簿的訪問許可權,則丟擲該異常。

NotFoundError DOMException

如果剪貼簿指示它包含可表示為文字但無法提供文字表示的資料,則丟擲該異常。

安全注意事項

只能在 安全上下文 中進行剪貼簿讀取。

其他安全要求已在 API 概述主題的 安全注意事項 部分介紹。

示例

此示例檢索剪貼簿的文字內容,並將返回的文字插入到選定元素的 content 中。

js
const destination = document.getElementById("outbox");
destinationImage.addEventListener("click", () => {
  navigator.clipboard
    .readText()
    .then((clipText) => (destination.innerText = clipText));
});

規範

規範
Clipboard API 和事件
# dom-clipboard-readtext

瀏覽器相容性

另見