Clipboard.readText()

Baseline 2024

Newly available

Since June 2024, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

Clipboard インターフェイスの readText() メソッドは、システムクリップボードのテキストの内容のコピーに解決されるプロミス (Promise) を返します。

クリップボードからデータを読み込むには、権限 API の "clipboard-read" 権限を得る必要があります。

構文

js
readText();

引数

なし。

返値

クリップボードのテキストの内容を持つ文字列に解決される、プロミス (Promise) オブジェクト。クリップボードが空であったり、テキストがないか、クリップボードの内容を表す DataTransfer オブジェクトがテキストの表現を持たない場合は、空文字列を返します。

テキストでない内容をクリップボードから読むためには、代わりに read() メソッドを使ってください。クリップボードへのテキストの書き込みには、writeText() を使ってください。

例

この使用例は、クリップボードからテキストの内容を取得し、ある要素の内容にその取得されたテキストを設定します。

js
navigator.clipboard
  .readText()
  .then((clipText) => (document.getElementById("outbox").innerText = clipText));

仕様書

Specification
Clipboard API and events
# dom-clipboard-readtext

ブラウザーの互換性

BCD tables only load in the browser

関連情報