# water-printe

> 一个基于 canvas 实现的简单文本水印工具

Latest version **2.0.1** (published 2020-04-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install water-printe
pnpm add water-printe
yarn add water-printe
bun add water-printe
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2020-04-13 |
| First published | 2020-04-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | _mt |
| Keywords | water-printe |

## Links

- npm: https://www.npmjs.com/package/water-printe
- Repository: https://github.com/txs1992/water-printe
- Homepage: https://github.com/txs1992/water-printe#readme
- Issues: https://github.com/txs1992/water-printe/issues
- npm.io page: https://npm.io/package/water-printe

## Recent versions

- 2.0.1 (latest) — 2020-04-13
- 2.0.0 — 2020-04-13
- 1.3.0 — 2020-04-12
- 1.2.0 — 2020-04-10
- 1.1.3 — 2020-04-09
- 1.1.2 — 2020-04-09
- 1.1.1 — 2020-04-09
- 1.1.0 — 2020-04-09

## README

<h1 align="center">
	WaterPrinte
</h1>

> 一个基于 canvas 实现的简单文本水印工具

## npm 使用示例

```js
import waterPrinte from 'water-printe'

const clearWaterPrinte = waterPrinte('哀木涕 Y009527');

setTimeout(() => {
  clearWaterPrinte();
}, 10000)
```

## CDN 使用示例

```html
<!-- 记得修改最新的版本号 -->
<script src="https://unpkg.com/water-printe@1.1.2/lib/water-printe.min.js"></script>
<script>
  window.WaterPrinte('哀木涕 Y009527')
</script>
```

> 下图是工具效果

![demo](http://chuantu.xyz/t6/727/1586409738x1031866013.png)


## WaterPrinte 配置

| 参数 | 说明 | 类型 | 可选值 | 默认值 |
| ---- | ---- | ---- | ---- | ---- |
| `text` | 显示在水印中的文本 | string | - | `药研社` |
| `el` | 水印需要插入的位置,可以传入 DOM 或者 CSS 选择器 | string/HTMLDOM | - | `body` |
| `options` | 水印工具的一些设置项，用于修改样式文字大小密度等 | Object | - | - |
| `clear` | 水印返回的清理函数，用于清除水印 | Function | - | - |

## options 选项


| 参数 | 说明 | 类型 | 可选值 | 默认值 |
| ---- | ---- | ---- | ---- | ---- |
| `zIndex` | 水印的层级 | number | - | `999999` |
| `rotate` | 水印文字旋转角度 | number | - | `-20` |
| `width` | 每个文字的区块的宽度，（注意文字是居中的） | number | - | 200 |
| `height` | 每个文字的区块的高度，（注意文字是居中的） | number | - | 200 |
| `font` | 水印文字的字体样式 | string | - | `14px Microsoft JhengHei` |
| `color` | 水印文字的颜色 | string | - | `rgba(0 , 0, 0, 0.15)` |

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