Clipboard.write()

The Clipboard method write() writes arbitrary data, such as images, to the clipboard. This can be used to implement cut and copy functionality.

Before you can write to the clipboard, you need to use the Permissions API to get the "clipboard-write" permission.

Syntax

var promise = navigator.clipboard.write(dataTransfer)

Parameters

dataTransfer

A DataTransfer object containing data to be written to the clipboard.

Return value

A Promise which is resolved when the data has been written to the clipboard. The promise is rejected if the clipboard is unable to complete the clipboard access.

Example

This example function replaces the current contents of the clipboard with a specified string.

function setClipboard(text) {
  let data = new DataTransfer();

  data.items.add("text/plain", text);
  navigator.clipboard.write(data).then(function() {
    /* success */
  }, function() {
    /* failure */
  });
}

The code begins by creating a new DataTransfer object into which the text will be placed for sending to the clipboard. DataTransferItemList.add() is called to add the text to the DataTransfer, then write() is called, specifying both a fulfillment function and an error function.

Specifications

Browser compatibility