Clipboard: writeText() method

The Clipboard interface's writeText() property writes the specified text string to the system clipboard. Text may be read back using either read() or readText().

Syntax

js

writeText(newClipText)

Parameters

newClipText

The string to be written to the clipboard.

Return value

A Promise which is resolved once the clipboard's contents have been updated. The promise is rejected if the caller does not have permission to write to the clipboard.

Security

Transient user activation is required. The user has to interact with the page or a UI element in order for this feature to work.

The "clipboard-write" permission of the Permissions API is granted automatically to pages when they are in the active tab.

Examples

This example sets the clipboard's contents to the string "<empty clipboard>".

js

navigator.clipboard.writeText("<empty clipboard>").then(
  () => {
    /* clipboard successfully set */
  },
  () => {
    /* clipboard write failed */
  }
);

Specifications

Specification
Clipboard API and events
# dom-clipboard-writetext

Browser compatibility

BCD tables only load in the browser

See also