Clipboard.readText()
The Clipboard
interface's
readText()
method returns a Promise
which
resolves with a copy of the textual contents of the system clipboard.
The
"clipboard-read"
permission of the Permissions API must be granted before
you can read data from the clipboard.
Syntax
var promise = navigator.clipboard.readText()
Parameters
None.
Return value
A Promise
that resolves with a DOMString
containing the
textual contents of the clipboard. Returns an empty string if the clipboard is empty,
does not contain text, or does not include a textual representation among the
DataTransfer
objects representing the clipboard's contents.
To read non-text contents from the clipboard, use the read()
method instead. You can write text to the clipboard using
writeText()
.
Example
This example retrieves the textual contents of the clipboard and inserts the returned text into an element's contents.
navigator.clipboard.readText().then(
clipText => document.getElementById("outbox").innerText = clipText);
Specifications
Specification |
---|
Clipboard API and events # dom-clipboard-readtext |
Browser compatibility
BCD tables only load in the browser