Add-ons

clipboard

The clipboard API enables an extension to copy items to the system clipboard. Currently the API only supports copying images, but it's intended to support copying text and HTML in the future.

This WebExtension API exists primarily because the standard web clipboard API doesn't support writing images to the clipboard. If and when this capability is added to the standard web API, this API may be deprecated.

Reading from the clipboard is not supported by this API, because the clipboard can already be read using the standard web platform APIs. See Interacting with the clipboard.

This API is based on Chrome's clipboard API, but that API is only available for Chrome apps, not extensions.

To use this API you need to have the "clipboardWrite" permission.

Functions

clipboard.setImageData()
Copy an image to the clipboard.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
setImageData No No5757 No

Acknowledgements

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

Document Tags and Contributors

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