Add-ons

clipboard.setImageData()

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:

  • The Chrome API is only for apps, not extensions.
  • This API requires only the "clipboardWrite" permission, while the Chrome version also requires the "clipboard" permission.
  • Chrome's API uses callbacks, and this API only supports promises.
  • This API does not support the additionalItems parameter.

This is an asynchronous function that returns a Promise.

Syntax

browser.clipboard.setImageData(
  imageData,           // ArrayBuffer
  imageType           // String
)

Parameters

imageData
ArrayBuffer. The encoded image data.
imageType
String. The type of image: either "png" or "jpeg".

Return value

A Promise that will be fulfilled 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).

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic support No No5757 No

Examples

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'));

Acknowledgements

This API is based on Chromium's chrome.clipboard API.

Document Tags and Contributors

 Contributors to this page: wbamberg
 Last updated by: wbamberg,