electron/docs/api/clipboard.md

clipboard

Perform copy and paste operations on the system clipboard.

The following example shows how to write a string to the clipboard:

const { clipboard } = require('electron');
clipboard.writeText('Example String');

On X Window systems, there is also a selection clipboard. To manipulate it you need to pass selection to each method:

clipboard.writeText('Example String', 'selection');
console.log(clipboard.readText('selection'));

Methods

The clipboard module has the following methods:

Note: Experimental APIs are marked as such and could be removed in future.

clipboard.readText([type])

• type String (optional)

Returns the content in the clipboard as plain text.

clipboard.writeText(text[, type])

• text String
• type String (optional)

Writes the text into the clipboard as plain text.

clipboard.readHtml([type])

• type String (optional)

Returns the content in the clipboard as markup.

clipboard.writeHtml(markup[, type])

• markup String
• type String (optional)

Writes markup to the clipboard.

clipboard.readImage([type])

• type String (optional)

Returns the content in the clipboard as a NativeImage.

clipboard.writeImage(image[, type])

• image NativeImage
• type String (optional)

Writes image to the clipboard.

clipboard.readRtf([type])

• type String (optional)

Returns the content in the clipboard as RTF.

clipboard.writeRtf(text[, type])

• text String
• type String (optional)

Writes the text into the clipboard in RTF.

clipboard.clear([type])

• type String (optional)

Clears the clipboard content.

clipboard.availableFormats([type])

• type String (optional)

Returns an array of supported formats for the clipboard type.

clipboard.has(data[, type]) Experimental

• data String
• type String (optional)

Returns whether the clipboard supports the format of specified data.

console.log(clipboard.has('<p>selection</p>'));

clipboard.read(data[, type]) Experimental

• data String
• type String (optional)

Reads data from the clipboard.

clipboard.write(data[, type])

• data Object
  • text String
  • html String
  • image NativeImage
• type String (optional)

clipboard.write({text: 'test', html: "<b>test</b>"});

Writes data to the clipboard.