|
|
@@ -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` to the clipboard.
|
|
|
|
|
|
-Writes `image` into the clipboard.
|
|
|
+### `clipboard.clear([type])`
|
|
|
|
|
|
-## clipboard.clear([type])
|
|
|
+* `type` String (optional)
|
|
|
|
|
|
-* `type` String
|
|
|
+Clears the clipboard content.
|
|
|
|
|
|
-Clears the clipboard.
|
|
|
+### `clipboard.availableFormats([type])`
|
|
|
|
|
|
-## clipboard.availableFormats([type])
|
|
|
+* `type` String (optional)
|
|
|
|
|
|
-Returns an array of supported `format` for the clipboard `type`.
|
|
|
+Returns an array of supported formats for the clipboard `type`.
|
|
|
|
|
|
-## clipboard.has(data[, 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.
|
Jessica Lord