fes.js/docs/reference/plugin/plugins/watermark.md
ocean_gao ae84ba3bae
feat: watermark默认样式优化 (#116)
* feat: watermark默认样式优化

* feat: watermark默认样式优化

* feat: watermark默认样式优化
2022-04-20 11:13:17 +08:00

71 lines
1.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# @fesjs/plugin-watermark
## 介绍
给页面添加水印效果
## 启用方式
`package.json` 中引入依赖:
```json
{
"dependencies": {
"@fesjs/fes": "^2.0.0",
"@fesjs/plugin-watermark": "^2.0.0"
}
}
```
## 编译时配置
```js
export default {
watermark: {
disabled: false
},
}
```
### disabled
是否禁用水印,默认是`false`。
可以在开发环境关闭水印:
```js
export default {
watermark: {
disabled: true
},
}
```
## API
### createWatermark
创建水印功能,通过 `@fesjs/fes` 导入 API
```js
import { createWatermark } from '@fesjs/fes'
createWatermark({ content: '我是水印' });
```
默认参数是:
```js
{
container = document.body,
width = 300,
height = 300,
textAlign = 'center',
textBaseline = 'middle',
fontSize = '14px',
fontFamily = 'Microsoft Yahei',
fillStyle = 'rgba(184, 184, 184, 0.3)',
content = '请勿外传',
rotate = 25,
zIndex = 99999,
timestamp = 'YYYY-MM-DD HH:mm'
}
```
如果不需要时间戳,则可以设置`timestamp`为`false`。