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

Improve grammar and punctuation of clipboard.md

Browse source 
Improve the grammar, sentence structure, punctuation and formatting of
`clipboard.md`.
This commit is contained in:
Jeffrey Morgan 2015-07-23 18:01:00 +01:00
parent adab769700
commit 32b84bd3f9
1 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/api/clipboard.md
View file

@ -1,14 +1,14 @@
# clipboard # clipboard
The `clipboard` provides methods to do copy/paste operations. An example of The `clipboard` provides methods to perform copy and paste operations. The following example
writing a string to clipboard: shows how to write a string to the clipboard:
```javascript ```javascript
var clipboard = require('clipboard'); var clipboard = require('clipboard');
clipboard.writeText('Example String'); clipboard.writeText('Example String');
``` ```
On X Window systems, there is also a selection clipboard, to manipulate in it On X Window systems, there is also a selection clipboard. To manipulate it
you need to pass `selection` to each method: you need to pass `selection` to each method:
```javascript ```javascript
@ -21,46 +21,46 @@ console.log(clipboard.readText('selection'));
* `type` String * `type` String
Returns the content in clipboard as plain text. Returns the content in the clipboard as plain text.
## clipboard.writeText(text[, type]) ## clipboard.writeText(text[, type])
* `text` String * `text` String
* `type` String * `type` String
Writes the `text` into clipboard as plain text. Writes the `text` into the clipboard as plain text.
## clipboard.readHtml([type]) ## clipboard.readHtml([type])
* `type` String * `type` String
Returns the content in clipboard as markup. Returns the content in the clipboard as markup.
## clipboard.writeHtml(markup[, type]) ## clipboard.writeHtml(markup[, type])
* `markup` String * `markup` String
* `type` String * `type` String
Writes the `markup` into clipboard. Writes `markup` into the clipboard.
## clipboard.readImage([type]) ## clipboard.readImage([type])
* `type` String * `type` String
Returns the content in clipboard as [NativeImage](native-image.md). 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) * `image` [NativeImage](native-image.md)
* `type` String * `type` String
Writes the `image` into clipboard. Writes `image` into the clipboard.
## clipboard.clear([type]) ## clipboard.clear([type])
* `type` String * `type` String
Clears everything in clipboard. Clears the clipboard.
## clipboard.availableFormats([type]) ## clipboard.availableFormats([type])
@ -71,7 +71,7 @@ Returns an array of supported `format` for the clipboard `type`.
* `data` String * `data` String
* `type` String * `type` String
Returns whether clipboard supports the format of specified `data`. Returns whether the clipboard supports the format of specified `data`.
```javascript ```javascript
var clipboard = require('clipboard'); var clipboard = require('clipboard');
@ -85,7 +85,7 @@ console.log(clipboard.has('<p>selection</p>'));
* `data` String * `data` String
* `type` String * `type` String
Reads the `data` in clipboard. Reads `data` from the clipboard.
**Note:** This API is experimental and could be removed in future. **Note:** This API is experimental and could be removed in future.
@ -101,4 +101,4 @@ Reads the `data` in clipboard.
var clipboard = require('clipboard'); var clipboard = require('clipboard');
clipboard.write({text: 'test', html: "<b>test</b>"}); clipboard.write({text: 'test', html: "<b>test</b>"});
``` ```
Writes the `data` iinto clipboard. Writes `data` into clipboard.