Clipboard: readText() メソッド
Baseline
2024
最近利用可能
April 2024以降、この機能は最新のバージョンの端末およびブラウザーで動作します。古い端末やブラウザーでは動作しないことがあります。
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
readText() は Clipboard インターフェイスのメソッドで、システムクリップボードのテキストの内容のコピーに解決されるプロミス (Promise) を返します。
メモ:
クリップボードからテキスト以外のコンテンツを読み取る場合は、代わりに read() メソッドを使用してください。
writeText() をすると、クリップボードにテキストを書き込むことができます。
構文
js
readText()
引数
なし。
返値
クリップボードのテキストの内容を持つ文字列に解決される、プロミス (Promise) です。
クリップボードが空の場合、テキストが含まれていない場合、またはクリップボードの内容を表すオブジェクトの中にテキスト表現が含まれていない場合は、空文字列を返します。
例外
NotAllowedErrorDOMException-
クリップボードからの読み取りをすることができない場合に発生します。
NotFoundErrorDOMException-
クリップボードがテキストとして表すことができるデータが含まれていることを示しているにもかかわらず、テキスト形式での表現を提供できない場合に発生します。
セキュリティの注意事項
クリップボードからの読み取りは、保護されたコンテキストでのみ行うことができます。
その他のセキュリティ要件は、API の概要トピックにあるセキュリティの注意事項の節で網羅されています。
例
この使用例は、クリップボードからテキストの内容を取得し、ある要素の内容にその取得されたテキストを設定します。
js
const destination = document.getElementById("outbox");
destinationImage.addEventListener("click", () => {
navigator.clipboard
.readText()
.then((clipText) => (destination.innerText = clipText));
});
仕様書
| 仕様書 |
|---|
| Clipboard API and events # dom-clipboard-readtext |