Clipboard

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The Clipboard interface of the Clipboard API provides read and write access to the contents of the system clipboard. This allows a web application to implement cut, copy, and paste features.

The system clipboard is exposed through the global Navigator.clipboard property.

All of the Clipboard API methods operate asynchronously; they return a Promise which is resolved once the clipboard access has been completed. The promise is rejected if clipboard access is denied.

All the methods require a secure context. Additional requirements for using the API are discussed in the Security consideration section of the API overview topic.

Instance methods

Clipboard is based on the EventTarget interface, and includes its methods.

read(): Requests arbitrary data (such as images) from the clipboard, returning a Promise that resolves with an array of ClipboardItem objects containing the clipboard's contents.
readText(): Requests text from the system clipboard, returning a Promise that is fulfilled with a string containing the clipboard's text once it's available.
write(): Writes arbitrary data to the system clipboard, returning a Promise that resolves when the operation completes.
writeText(): Writes text to the system clipboard, returning a Promise that is resolved once the text is fully copied into the clipboard.

Specifications

Specification
Clipboard API and events # clipboard-interface

Browser compatibility

	Desktop						Mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet	WebView Android
`Clipboard`	66	79	63	53	13.1	66	63	47	13.4	9.0	66
`read`	66 The user must grant the `clipboard-read` permission.	79 The user must grant the `clipboard-read` permission.	127 ["This method must be called within user gesture event handlers.", "Web extensions require the `clipboardRead` permission in manifest to read data. With this permission, the extension does not require a user interaction and does not display a paste prompt.", "A paste prompt is displayed when the clipboard is read. If the clipboard contains same-origin content, the prompt is suppressed."]	53 The user must grant the `clipboard-read` permission.	13.1	66 The user must grant the `clipboard-read` permission.	127 ["This method must be called within user gesture event handlers.", "Web extensions require the `clipboardRead` permission in manifest to read data. With this permission, the extension does not require a user interaction and does not display a paste prompt.", "A paste prompt is displayed when the clipboard is read. If the clipboard contains same-origin content, the prompt is suppressed."]	47 The user must grant the `clipboard-read` permission.	13.4	9.0 The user must grant the `clipboard-read` permission.	66 The user must grant the `clipboard-read` permission.
`readText`	66 The user must grant the `clipboard-read` permission.	79 The user must grant the `clipboard-read` permission.	125 ["This method must be called within user gesture event handlers.", "Web extensions require the `clipboardRead` permission in manifest to read data. With this permission, the extension does not require a user interaction and does not display a paste prompt.", "A paste prompt is displayed when the clipboard is read. If the clipboard contains same-origin content, the prompt is suppressed."]	53 The user must grant the `clipboard-read` permission.	13.1	66 The user must grant the `clipboard-read` permission.	125 ["This method must be called within user gesture event handlers.", "Web extensions require the `clipboardRead` permission in manifest to read data. With this permission, the extension does not require a user interaction and does not display a paste prompt.", "A paste prompt is displayed when the clipboard is read. If the clipboard contains same-origin content, the prompt is suppressed."]	47 The user must grant the `clipboard-read` permission.	13.4	9.0 The user must grant the `clipboard-read` permission.	66 The user must grant the `clipboard-read` permission.
`type_image-png`	76	79	127	63	13.1	76	127	54	13.4	12.0	76
`type_text-html`	86	86	127	72	13.1	86	127	61	13.4	14.0	86
`type_text-plain`	66	79	127	53	13.1	66	127	47	13.4	9.0	66
`write`	66 ["From version 107, this method must be called within user gesture event handlers, or the user must grant the `clipboard-write` permission.", "Before version 107, the user must grant the `clipboard-write` permission."]	79	127 ["This method must be called within user gesture event handlers.", "Web extensions require the `clipboardWrite` permission in manifest to read data. With this permission, the extension does not require a user interaction and does not display a paste prompt.", "A paste prompt is displayed when the clipboard is read. If the clipboard contains same-origin content, the prompt is suppressed."]	53 ["From version 93, this method must be called within user gesture event handlers, or the user must grant the `clipboard-write` permission.", "Before version 93, the user must grant the `clipboard-write` permission."]	13.1	66 ["From version 107, this method must be called within user gesture event handlers, or the user must grant the `clipboard-write` permission.", "Before version 107, the user must grant the `clipboard-write` permission."]	127 ["This method must be called within user gesture event handlers.", "Web extensions require the `clipboardWrite` permission in manifest to read data. With this permission, the extension does not require a user interaction and does not display a paste prompt.", "A paste prompt is displayed when the clipboard is read. If the clipboard contains same-origin content, the prompt is suppressed."]	47 ["From version 73, this method must be called within user gesture event handlers, or the user must grant the `clipboard-write` permission.", "Before version 73, the user must grant the `clipboard-write` permission."]	13.4	9.0 ["From version 21.0, this method must be called within user gesture event handlers, or the user must grant the `clipboard-write` permission.", "Before version 21.0, the user must grant the `clipboard-write` permission."]	66 ["From version 107, this method must be called within user gesture event handlers, or the user must grant the `clipboard-write` permission.", "Before version 107, the user must grant the `clipboard-write` permission."]
`writeText`	66 ["From version 107, this method must be called within user gesture event handlers, or the user must grant the `clipboard-write` permission.", "Before version 107, the user must grant the `clipboard-write` permission."]	79 ["From version 107, this method must be called within user gesture event handlers, or the user must grant the `clipboard-write` permission.", "Before version 107, the user must grant the `clipboard-write` permission."]	63 ["This method must be called within user gesture event handlers.", "Web extensions require the `clipboardRead` permission in manifest to read data. With this permission, the extension does not require a user interaction and does not display a paste prompt.", "A paste prompt is displayed when the clipboard is read. If the clipboard contains same-origin content, the prompt is suppressed."]	53 ["From version 93, this method must be called within user gesture event handlers, or the user must grant the `clipboard-write` permission.", "Before version 93, the user must grant the `clipboard-write` permission."]	13.1 This method must be called within user gesture event handlers.	66 ["From version 107, this method must be called within user gesture event handlers, or the user must grant the `clipboard-write` permission.", "Before version 107, the user must grant the `clipboard-write` permission."]	63 ["This method must be called within user gesture event handlers.", "Web extensions require the `clipboardRead` permission in manifest to read data. With this permission, the extension does not require a user interaction and does not display a paste prompt.", "A paste prompt is displayed when the clipboard is read. If the clipboard contains same-origin content, the prompt is suppressed."]	47 ["From version 73, this method must be called within user gesture event handlers, or the user must grant the `clipboard-write` permission.", "Before version 73, the user must grant the `clipboard-write` permission."]	13.4 This method must be called within user gesture event handlers.	9.0 ["From version 21.0, this method must be called within user gesture event handlers, or the user must grant the `clipboard-write` permission.", "Before version 21.0, the user must grant the `clipboard-write` permission."]	66 ["From version 107, this method must be called within user gesture event handlers, or the user must grant the `clipboard-write` permission.", "Before version 107, the user must grant the `clipboard-write` permission."]

Instance methods

Specifications

Browser compatibility

See also