ContextQMD
Back to Content

Clipboard: writeText() method

files/en-us/web/api/clipboard/writetext/index.md

latest1.6 KB
Original Source

{{APIRef("Clipboard API")}} {{securecontext_header}}

The writeText() method of the {{domxref("Clipboard")}} interface writes the specified text to the system clipboard, returning a {{jsxref("Promise")}} that is resolved once the system clipboard has been updated.

Syntax

js-nolint
writeText(newClipText)

Parameters

  • newClipText
    • : The string to be written to the clipboard.

Return value

A {{jsxref("Promise")}} that is resolved once the clipboard's contents have been updated.

Exceptions

  • NotAllowedError {{domxref("DOMException")}}
    • : 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>".

js
button.addEventListener("click", () => writeClipboardText("<empty clipboard>"));

async function writeClipboardText(text) {
  try {
    await navigator.clipboard.writeText(text);
  } catch (error) {
    console.error(error.message);
  }
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also