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, imageType)

Parameters

imageData
An ArrayBuffer containing the encoded image data to copy to the clipboard.
imageType
A DOMString indicating the type of image contained in imageData: "png" or "jpeg".

Return value

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).

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome No support NoEdge No support NoFirefox Full support 57Opera No support NoFirefox Android Full support 57

Legend

Full support  
Full support
No support  
No support

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: Sheppy, wbamberg
Last updated by: Sheppy,