electron/docs/api/clipboard.md

110 lines
2.4 KiB
Markdown
Raw Normal View History

2013-09-09 07:35:57 +00:00
# clipboard
2013-08-14 22:43:35 +00:00
2015-08-24 21:35:43 +00:00
The `clipboard` object provides methods to perform copy and paste operations. The following example shows how to write a string to the clipboard:
2013-08-14 22:43:35 +00:00
```javascript
var clipboard = require('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:
```javascript
var clipboard = require('clipboard');
clipboard.writeText('Example String', 'selection');
console.log(clipboard.readText('selection'));
```
2015-08-24 21:35:43 +00:00
## Methods
2015-08-24 21:35:43 +00:00
The `clipboard` object has the following methods:
### `clipboard.readText([type])`
* `type` String (optional)
2013-08-14 22:43:35 +00:00
Returns the content in the clipboard as plain text.
2013-08-14 22:43:35 +00:00
2015-08-24 21:35:43 +00:00
### `clipboard.writeText(text[, type])`
2013-08-14 22:43:35 +00:00
* `text` String
2015-08-24 21:35:43 +00:00
* `type` String (optional)
2013-08-14 22:43:35 +00:00
Writes the `text` into the clipboard as plain text.
2013-08-14 22:43:35 +00:00
2015-08-24 21:35:43 +00:00
### `clipboard.readHtml([type])`
2015-08-24 21:35:43 +00:00
* `type` String (optional)
Returns the content in the clipboard as markup.
2015-08-24 21:35:43 +00:00
### `clipboard.writeHtml(markup[, type])`
* `markup` String
2015-08-24 21:35:43 +00:00
* `type` String (optional)
2015-08-24 21:35:43 +00:00
Writes `markup` to the clipboard.
2015-08-24 21:35:43 +00:00
### `clipboard.readImage([type])`
2015-03-26 04:53:48 +00:00
2015-08-24 21:35:43 +00:00
* `type` String (optional)
2015-03-26 04:53:48 +00:00
Returns the content in the clipboard as a [NativeImage](native-image.md).
2015-03-26 04:53:48 +00:00
2015-08-24 21:35:43 +00:00
### `clipboard.writeImage(image[, type])`
2015-03-26 04:53:48 +00:00
* `image` [NativeImage](native-image.md)
2015-08-24 21:35:43 +00:00
* `type` String (optional)
Writes `image` to the clipboard.
2015-03-26 04:53:48 +00:00
2015-08-24 21:35:43 +00:00
### `clipboard.clear([type])`
2015-03-26 04:53:48 +00:00
2015-08-24 21:35:43 +00:00
* `type` String (optional)
2015-08-24 21:35:43 +00:00
Clears the clipboard content.
2013-08-14 22:43:35 +00:00
2015-08-24 21:35:43 +00:00
### `clipboard.availableFormats([type])`
2013-08-14 22:43:35 +00:00
2015-08-24 21:35:43 +00:00
* `type` String (optional)
2013-08-14 22:43:35 +00:00
2015-08-24 21:35:43 +00:00
Returns an array of supported formats for the clipboard `type`.
2013-08-14 22:43:35 +00:00
2015-08-24 21:35:43 +00:00
### `clipboard.has(data[, type])` _Experimental_
2013-08-14 22:43:35 +00:00
2015-05-27 08:05:51 +00:00
* `data` String
2015-08-24 21:35:43 +00:00
* `type` String (optional)
2013-08-14 22:43:35 +00:00
Returns whether the clipboard supports the format of specified `data`.
2015-05-27 08:05:51 +00:00
```javascript
var clipboard = require('clipboard');
console.log(clipboard.has('<p>selection</p>'));
```
**Note:** This API is experimental and could be removed in future.
2015-08-24 21:35:43 +00:00
### `clipboard.read(data[, type])` _Experimental_
2015-05-27 08:05:51 +00:00
* `data` String
2015-08-24 21:35:43 +00:00
* `type` String (optional)
2015-05-27 08:05:51 +00:00
Reads `data` from the clipboard.
2013-08-14 22:43:35 +00:00
**Note:** This API is experimental and could be removed in future.
2015-08-24 21:35:43 +00:00
### `clipboard.write(data[, type])`
* `data` Object
* `text` String
* `html` String
* `image` [NativeImage](native-image.md)
2015-08-24 21:35:43 +00:00
* `type` String (optional)
```javascript
var clipboard = require('clipboard');
clipboard.write({text: 'test', html: "<b>test</b>"});
```
2015-08-24 21:35:43 +00:00
Writes `data` to the clipboard.