Clipboard interface implements the Clipboard API, providing—if the user grants permission—both read and write access to the contents of the system clipboard. The Clipboard API can be used to implement cut, copy, and paste features within a web application.
The system clipboard is exposed through the global
Calls to the methods of the
Clipboard object will not succeed if the user hasn't granted the needed permissions using the Permissions API and the
"clipboard-write" permission as appropriate.
Note: In reality, at this time browser requirements for access to the clipboard vary significantly. Please see the section Clipboard availability for details.
All of the Clipboard API methods operate asynchronously; they return a
Promise which is resolved once the clipboard access has been completed. The promise is rejected if clipboard access is denied.
Clipboard is based on the
EventTarget interface, and includes its methods.
- Requests arbitrary data (such as images) from the clipboard, returning a
Promise. When the data has been retrieved, the promise is resolved with a
DataTransferobject that provides the data.
- Requests text from the system clipboard; returns a
Promisewhich is resolved with a
DOMStringcontaining the clipboard's text once it's available.
- Writes arbitrary data to the system clipboard. This asynchronous operation signals that it's finished by resolving the returned
- Writes text to the system clipboard, returning a
Promisewhich is resolved once the text is fully copied into the clipboard.
The asynchronous clipboard API is a relatively recent addition, and the process of implementing it in browsers is not yet complete. Due to both potential security concerns and technical complexities, the process of integrating this API is happening gradually in most browsers.
For example, Firefox does not yet support the
"clipboard-write" permissions, so access to the methods that access and change the contents of the clipboard are restricted in other ways. In addition,
write() are disabled by default and require changing a preference to enable them. Check the compatibility tables for each method before using it.
|Clipboard API and events
The definition of 'Clipboard' in that specification.
|Working Draft||Initial definition.|
|Feature||Android webview||Chrome for Android||Edge mobile||Firefox for Android||Opera Android||iOS Safari||Samsung Internet|
1. Currently works just like
readText(); non-text content is not currently supported.
2. From version 63: this feature is behind the
dom.events.asyncClipboard.dataTransfer preference (needs to be set to
true). To change preferences in Firefox, visit about:config.
3. Firefox only supports reading the clipboard in browser extensions, using the
"clipboardRead" extension permission.
4. Currently works exactly like
writeText(), including the availability limitations currently imposed by Firefox.
5. Writing to the clipboard is available without permission in secure contexts and browser extensions, but only from user-initiated event callbacks. Browser extensions with the
"clipboardWrite" permission can write to the clipboard at any time.