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. This API may be deprecated once the Clipboard API's support for non-text clipboard contents has entered general use.

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 the "clipboardWrite" extension permission.

Functions

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

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
setImageDataChrome 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

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,