Clipboard
Baseline
Widely available
*
This feature is well established and works across many devices and browser versions. It’s been available across browsers since 2020年3月.
* Some parts of this feature may have varying levels of support.
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
Clipboard はクリップボード API のインターフェイスで、システムクリップボードの内容に対する読み取りと書き込みのアクセス提供します。
これによって、ウェブアプリケーションに切り取り(カット)、コピー(複写)、貼り付け(ペースト)の機能を実装することができます。
システムクリップボードは、グローバルの Navigator.clipboard プロパティにより公開されています。
クリップボード API のすべてのメソッドは非同期で動作します。これらは Promise を返しますが、これはクリップボードへのアクセスが完了すると解決されます。
クリップボードへのアクセスが拒否された場合、このプロミスは拒否されます。
すべてのメソッドで、保護されたコンテキストが要求されます。 API を使用する際のその他の要件については、API の概要トピックにあるセキュリティの注意事項の節で説明されています。
インスタンスメソッド
Clipboard は、EventTarget インターフェイスに基づいており、そのメソッドを含みます。
read()-
クリップボードから任意のデータ (画像など) を要求し、プロミス (
Promise) を返します。データが取得されたとき、このプロミスはクリップボードの内容を保持するClipboardItemオブジェクトの配列に解決されます。 readText()-
システムクリップボードにテキストを要求します。利用可能になるとクリップボードのテキストを含む文字列により履行される
Promiseを返します。 write()-
システムのクリップボードに任意のデータを書き込み、操作が完了した時点で解決する
Promiseを返します。 writeText()-
システムクリップボードにテキストを書き込み、そのテキストがクリップボードに完全にコピーされたときに解決する
Promiseを返します。
イベント
clipboardchange-
システムのクリップボードのコンテンツが何らかの方法で変更された際に発生します。例えば、システムのコピーコマンドや、
Clipboard.writeText()のような API メソッドによる変更などが該当します。
仕様書
| Specification |
|---|
| Clipboard API and events> # clipboard-interface> |