The Clipboard
method write()
writes arbitrary data, such as images, to the clipboard. This can be used to implement cut and copy functionality.
The "clipboard-write"
permission of the Permissions API, is granted automatically to pages when they are in the active tab.
Note: Browser support for the asynchronous clipboard APIs is still in the process of being implemented. Be sure to check the compatibility table as well as Clipboard availability in Clipboard for more information.
Syntax
var promise = navigator.clipboard.write(data)
Parameters
data
- An array of
ClipboardItem
objects containing data to be written to the clipboard.
Return value
A Promise
which is resolved when the data has been written to the clipboard. The promise is rejected if the clipboard is unable to complete the clipboard access.
Example
This example function replaces the current contents of the clipboard with a specified string.
function setClipboard(text) { let data = [new ClipboardItem({ "text/plain": text })]; navigator.clipboard.write(data).then(function() { /* success */ }, function() { /* failure */ }); }
The code begins by creating a new ClipboardItem
object into which the text will be placed for sending to the clipboard. The key of the object passed to the ClipboardItem
constructor indicates the content type, the value indicates the content. The content could be a text or even a Blob (e.g. for copying images to the clipboard). Then write()
is called, specifying both a fulfilment function and an error function.
Example of copying canvas contents to the clipboard
function copyCanvasContentsToClipboard(canvas, onDone, onError) { canvas.toBlob(function (blob) { let data = [new ClipboardItem({ [blob.type]: blob })]; navigator.clipboard.write(data).then(function () { onDone(); }, function (err) { onError(err); }) }); }
Note: You can only pass in one clipboard item at a time.
Specifications
Specification | Status | Comment |
---|---|---|
Clipboard API and events The definition of 'write()' in that specification. |
Working Draft | Initial definition. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
write | Chrome
Full support
66
| Edge Full support 79 | Firefox
Full support
63
| IE No support No | Opera Full support 63 | Safari Full support 13.1 | WebView Android
Full support
66
| Chrome Android
Full support
66
| Firefox Android
Full support
63
| Opera Android Full support 54 | Safari iOS Full support 13.4 | Samsung Internet Android Full support 12.0 |
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.
- See implementation notes.
- User must explicitly enable this feature.
- User must explicitly enable this feature.