@uni/clipboard
v1.0.9
Published
[](https://www.npmjs.com/package/@uni/clipboard)
Readme
getClipboard
Install
$ npm install @uni/clipboard --saveor
$ npm install @uni/apis --saveUsage
import { getClipboard } from '@uni/clipboard';
getClipboard({
success (res){
console.log(res.text);
}
});
// promise
getClipboard().then(res => {
console.log(res.text);
});
Methods
getClipboard()
Gets the content on the system clipboard.
Supported
Arguments
| Property | Type | Description | required | Default |
| --- | --- | --- | --- | --- |
| options | object | | ✔️ | - |
| options.success | Function | The callback function for a successful API call | ✘ | - |
| options.fail | Function | The callback function for a failed API call | ✘ | - |
| options.complete | Function | The callback function used when the API call completed (always executed whether the call succeeds or fails) | ✘ | - |
Return
| Property | Type | Description |
| --- | --- | --- |
| res | object | |
| res.text | string | The clipboard content |
setClipboard
Sets the content on the system clipboard.
Supported
Usage
import { setClipboard } from '@uni/clipboard';
setClipboard({
text: 'text',
success (res){
console.log(res);
}
});
// promise
setClipboard({
text: 'text'
}).then(res => {
console.log(res);
});
Arguments
| Property | Type | Description | required | Default |
| --- | --- | --- | --- | --- |
| options | object | | ✔️ | - |
| options.text | string | The clipboard content | ✔️ | - |
| options.success | Function | The callback function for a successful API call | ✘ | - |
| options.fail | Function | The callback function for a failed API call | ✘ | - |
| options.complete | Function | The callback function used when the API call completed (always executed whether the call succeeds or fails) | ✘ | - |
