mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Standardize clipboard

Browse source
This commit is contained in:
Jessica Lord 2015-08-24 14:35:43 -07:00
parent d7cf460918
commit 90392e9231
1 changed files with 33 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
docs/api/clipboard.md
View file

@ -1,7 +1,6 @@
# clipboard
The `clipboard` provides methods to perform copy and paste operations. The following example
shows how to write a string to the clipboard:
The `clipboard` object provides methods to perform copy and paste operations. The following example shows how to write a string to the clipboard:
```javascript
var clipboard = require('clipboard');
@ -17,59 +16,65 @@ clipboard.writeText('Example String', 'selection');
console.log(clipboard.readText('selection'));
```
## clipboard.readText([type])
## Methods
* `type` String
The `clipboard` object has the following methods:
### `clipboard.readText([type])`
* `type` String (optional)
Returns the content in the clipboard as plain text.
## clipboard.writeText(text[, type])
### `clipboard.writeText(text[, type])`
* `text` String
* `type` String
* `type` String (optional)
Writes the `text` into the clipboard as plain text.
## clipboard.readHtml([type])
### `clipboard.readHtml([type])`
* `type` String
* `type` String (optional)
Returns the content in the clipboard as markup.
## clipboard.writeHtml(markup[, type])
### `clipboard.writeHtml(markup[, type])`
* `markup` String
* `type` String
* `type` String (optional)
Writes `markup` into the clipboard.
Writes `markup` to the clipboard.
## clipboard.readImage([type])
### `clipboard.readImage([type])`
* `type` String
* `type` String (optional)
Returns the content in the clipboard as a [NativeImage](native-image.md).
## clipboard.writeImage(image[, type])
### `clipboard.writeImage(image[, type])`
* `image` [NativeImage](native-image.md)
* `type` String
* `type` String (optional)
Writes `image` into the clipboard.
Writes `image` to the clipboard.
## clipboard.clear([type])
### `clipboard.clear([type])`
* `type` String
* `type` String (optional)
Clears the clipboard.
Clears the clipboard content.
## clipboard.availableFormats([type])
### `clipboard.availableFormats([type])`
Returns an array of supported `format` for the clipboard `type`.
* `type` String (optional)
## clipboard.has(data[, type])
Returns an array of supported formats for the clipboard `type`.
### `clipboard.has(data[, type])` _Experimental_
* `data` String
* `type` String
* `type` String (optional)
Returns whether the clipboard supports the format of specified `data`.
@ -80,25 +85,25 @@ console.log(clipboard.has('<p>selection</p>'));
**Note:** This API is experimental and could be removed in future.
## clipboard.read(data[, type])
### `clipboard.read(data[, type])` _Experimental_
* `data` String
* `type` String
* `type` String (optional)
Reads `data` from the clipboard.
**Note:** This API is experimental and could be removed in future.
## clipboard.write(data[, type])
### `clipboard.write(data[, type])`
* `data` Object
* `text` String
* `html` String
* `image` [NativeImage](native-image.md)
* `type` String
* `type` String (optional)
```javascript
var clipboard = require('clipboard');
clipboard.write({text: 'test', html: "<b>test</b>"});
```
Writes `data` into clipboard.
Writes `data` to the clipboard.