The clipboard
module provides methods to perform copy and paste operations.
The following example shows how to write a string to the clipboard:
const clipboard = require('electron').clipboard;
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'));
The clipboard
module has the following methods:
Note: Experimental APIs are marked as such and could be removed in future.
type
String (optional)
Returns the content in the clipboard as plain text.
text
Stringtype
String (optional)
Writes the text
into the clipboard as plain text.
type
String (optional)
Returns the content in the clipboard as markup.
markup
Stringtype
String (optional)
Writes markup
to the clipboard.
type
String (optional)
Returns the content in the clipboard as a NativeImage.
image
NativeImagetype
String (optional)
Writes image
to the clipboard.
type
String (optional)
Clears the clipboard content.
type
String (optional)
Returns an array of supported formats for the clipboard type
.
data
Stringtype
String (optional)
Returns whether the clipboard supports the format of specified data
.
console.log(clipboard.has('<p>selection</p>'));
data
Stringtype
String (optional)
Reads data
from the clipboard.
data
Objecttext
Stringhtml
Stringimage
NativeImage
type
String (optional)
clipboard.write({text: 'test', html: "<b>test</b>"});
Writes data
to the clipboard.