web api instance method
Clipboard: writeText() method
Secure context
The writeText() method of the Clipboard interface writes the specified text to the system clipboard, returning a Promise that is resolved once the system clipboard has been updated.
Syntax
writeText(newClipText)
Parameters
newClipText- : The string to be written to the clipboard.
Return value
A Promise that is resolved once the clipboard’s contents have been updated.
Exceptions
NotAllowedErrorDOMException- : Thrown if writing to the clipboard is not allowed.
Security considerations
Writing to the clipboard can only be done in a secure context.
Additional security requirements are covered in the Security consideration section of the API overview topic.
Examples
This example sets the clipboard’s contents to the string “<empty clipboard>”.
button.addEventListener("click", () => writeClipboardText("<empty clipboard>"));
async function writeClipboardText(text) {
try {
await navigator.clipboard.writeText(text);
} catch (error) {
console.error(error.message);
}
}
Specifications
SpecificationsStandards references are available on the canonical MDN page.
Browser compatibility
Browser compatibilityCompatibility data is available on the canonical MDN page.