# clipboarder

> 用于获取浏览器页面的剪贴板内容

Latest version **2.0.5** (published 2020-12-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install clipboarder
pnpm add clipboarder
yarn add clipboarder
bun add clipboarder
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.5 |
| Published | 2020-12-23 |
| First published | 2020-12-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | vimin |
| Keywords | js, clipboard |

## Links

- npm: https://www.npmjs.com/package/clipboarder
- npm.io page: https://npm.io/package/clipboarder

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 2.0.5 (latest) — 2020-12-23
- 2.0.4 — 2020-12-22
- 2.0.3 — 2020-12-22
- 2.0.2 — 2020-12-22
- 2.0.1 — 2020-12-22
- 2.0.0 — 2020-12-22
- 1.0.2 — 2020-12-22
- 1.0.1 — 2020-12-22
- 1.0.0 — 2020-12-22

## README

## clipboarder
用于获取浏览器页面的剪贴板内容

## 使用
### 下载
```
npm install clipboarder 
```

### 引入
```javascript
import clipboarder from 'clipboarder'
```

### API
#### readBlob
获取剪贴板内的blob对象

**语法**
```javascript
clipboarder.readBlob((blob) => {
  // 回调函数
  // blob 获取的blob对象
})
```

#### getContent
获取剪贴板内的blob解析后的文本或者图片数据

**语法**
```javascript
clipboarder.getContent((type, data) => {
  // 回调函数
  // type 获取的数据的类型
  // data 解析后的blob数据
  // 结果在 data.target.result 字段内
})
```

#### getText
仅获取剪贴板内的文本数据，没有文本则不会调用回调函数

**语法**
```javascript
clipboarder.getText((text) => {
  // 回调函数
  // text 获取的文本数据
})
```

#### getImage
仅获取剪贴板内的图片类型数据，没有文本则不会调用回调函数

**语法**
```javascript
clipboarder.getImage((base64) => {
  // 回调函数
  // base64 获取的图片的base64图片
})
```

#### writeBlob
将文件写入剪贴板内，部分文件类型可能无法写入

**语法**
```javascript
// 传入 blob 类型数据
clipboarder.writeBlob(blob, () => {
  // 写入成功时的回调
}, (err) => {
  // 写入失败时执行的回调
  // err 为错误信息
})
```

#### writeText
向剪贴板内写入文本信息

**语法**
```javascript
// 传入 blob 类型数据
clipboarder.writeText('需要写入的文本内容', () => {
  // 写入成功时的回调
}, (err) => {
  // 写入失败时执行的回调
  // err 为错误信息
})
```

#### writeDataURL
向剪贴板内写入base64，该api主要用于复制base64图片到剪贴板，并且可以粘贴出去

**语法**
```javascript
clipboarder.writeDataURL('需要复制的图片的base64', () => {
  // 写入成功时的回调
}, (err) => {
  // 写入失败时执行的回调
  // err 为错误信息
})
```

#### writeWebImg
向剪贴板写入网络图片，该api主要用于复制网络图片到剪贴板，该图片必须没有跨域限制的，并且在有网络环境下才能复制成功

**语法**
```javascript
clipboarder.writeWebImg('需要复制的图片的url', () => {
  // 写入成功时的回调
}, (err) => {
  // 写入失败时执行的回调
  // err 为错误信息
})
```

## 版本标注
- 2.0.4 修复粘贴板为空时获取数据报错的问题
- 2.0.5 更新阅读文档

---
_Source: https://npm.io/package/clipboarder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._