https://github.com/acejs/js-clipboard
Control system clipboard via javascript
https://github.com/acejs/js-clipboard
Last synced: 11 months ago
JSON representation
Control system clipboard via javascript
- Host: GitHub
- URL: https://github.com/acejs/js-clipboard
- Owner: acejs
- Created: 2020-07-16T03:25:28.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-13T07:36:12.000Z (over 3 years ago)
- Last Synced: 2025-09-06T07:54:44.892Z (11 months ago)
- Language: TypeScript
- Size: 2.25 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## js-clipboard
**Control system clipboard via javascript**
### Installing
```bash
npm install @cdjs/js-clipboard
// or
yarn add @cdjs/js-clipboard
```
### Usage
```javascript
import jsClipboard from '@cdjs/js-clipboard'
```
### Documentation
| Method | Desc | Args | Type | Return | Support Browser |
| ------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ----------------------------------------- | ----------------------------------- | --------------------------------------------- |
| get | 获取当前剪贴板内容 | - | - | Promise
Promise | C: promot
F: denied
S: denied |
| copy | 复制 | target: 目标元素/文本/元素 id | HTMLElement/string | Promise
Promise | C: granted
F: granted
S: granted |
| cut | 剪切 | target: 目标元素/元素 id | HTMLElement/string | Promise
Promise | C: granted
F: granted
S: granted |
| paste | 粘贴 | target: 目标元素/元素 id | HTMLElement/string | Promise
Promise | C: promot
F: denied
S: denied
|
| deny | 禁止复制或粘贴，如果是作用于具体的元素，需要等元素渲染出来后再调用该方法 | target: 页面元素/ id/ class, 默认'document'
action: 操作行为, 默认 'copy' | HTMLElement/string
'copy' \| 'paste' | void | C: granted
F: granted
S: granted |
| add | 复制时自动加上文字，类似掘进的效果 | text: 目标文字
target: 页面元素/ id/ class, 默认'document' | string
HTMLElement/string | void | C: granted
F: granted
S: granted |
> #### Browser
>
> - C: Chrome
> - F: Firefox
> - S: Safari
>
> #### Error 类型
>
> - **denied**: 系统不支持或权限不足
> - **failed**: web api 调用失败，具体原因未知
> - **usage**: api 调用异常
###How to use
#####获取剪贴板内容
```javascript
jsClipboard
.get()
.then(str => {})
.catch(err => {})
```
##### 复制、剪切、粘贴
```javascript
// paste cut 类似 注意传参
// copy 方法可以传入文字 paste / cut 只能传目标元素 或 元素id
jsClipboard
.copy(target)
.then(str => {})
.catch(err => {})
```
##### 禁止复制、粘贴
```javascript
// 当 target 为具体的元素时，需要等元素渲染后在调用该方法
jsClipboard.deny(target)
```
##### 追加文字
```javascript
// 当 target 为具体的元素时，需要等元素渲染后在调用该方法
jsClipboard.add(
'\n作者: XuKang\nGitHub: https://github.com/BlueBlueBlueSky/js-clipboard',
target
)
```