Copies an image to the clipboard. The image is re-encoded before it is written to the clipboard. If the image is invalid, the clipboard is not modified.
The image is provided as an ArrayBuffer
containing the encoded image. JPEG and PNG formats are supported.
Although this API is based on Chrome's clipboard.setImageData()
API, there are some differences:
"clipboardWrite"
permission, while the Chrome version also requires the "clipboard"
permission.additionalItems
parameter.This is an asynchronous function that returns a Promise
.
browser.clipboard.setImageData(imageData, imageType)
imageData
ArrayBuffer
containing the encoded image data to copy to the clipboard.imageType
DOMString
indicating the type of image contained in imageData
: "png"
or "jpeg"
.A Promise
that will be resolved with no arguments if the operation succeeded, or rejected if there was an error (for example, because the data did not represent a valid image).
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
setImageData |
No |
No |
57 |
? |
No |
No |
? |
? |
57 |
? |
? |
? |
Copy a remote image:
// requires: // * the host permission for "https://cdn.mdn.mozilla.net/*" // * the API permission "clipboardWrite" fetch('https://cdn.mdn.mozilla.net/static/img/favicon144.png') .then(response => response.arrayBuffer()) .then(buffer => browser.clipboard.setImageData(buffer, 'png'));
Copy an image that was bundled with the extension:
// requires the API permission "clipboardWrite" fetch(browser.runtime.getURL('image.png')) .then(response => response.arrayBuffer()) .then(buffer => browser.clipboard.setImageData(buffer, 'png'));
Note: This API is based on Chromium's chrome.clipboard
API.
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/clipboard/setImageData