Clipboard: writeText() メソッド
Baseline
広く利用可能
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2020年3月以降、すべてのブラウザーで利用可能です。
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
writeText() は Clipboard インターフェイスのメソッドで、指定されたテキスト文字列をシステムのクリップボードに書き込み、システムのクリップボードが更新されたら解決する Promise を返します。
構文
js
writeText(newClipText)
引数
newClipText-
クリップボードに書き込む文字列。
返値
クリップボードの内容が更新されると解決されるプロミス (Promise) です。
例外
NotAllowedErrorDOMException-
クリップボードへ書き込みをすることができない場合に発生します。
セキュリティの注意事項
クリップボードからの読み取りは、保護されたコンテキストでのみ行うことができます。
その他のセキュリティ要件は、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 and events # dom-clipboard-writetext |