@neosjs/watermark
通用的 JS 水印生成类,基于 Canvas 绘制,可以给页面的某个区域加上文字或图片水印。支持旋转角度、透明度、层级、水印间距与偏移等配置。
安装
sh
pnpm add @neosjs/watermarksh
npm i @neosjs/watermarksh
yarn add @neosjs/watermark快速上手
实例化时通过 container 指定要添加水印的容器,通过 content 指定水印文字:
ts
import Watermark from '@neosjs/watermark'
const DemoWatermark = new Watermark({
container: document.body,
content: ['NeosJS'],
width: 120,
height: 64,
rotate: -22,
zIndex: 9,
opacity: 0.15,
// image: '', // 图片源,设置后以图片作为水印(优先级高于 content)
font: {
color: '#333',
size: 16,
weight: 'normal',
family: 'sans-serif',
style: 'normal',
align: 'center'
},
gap: [100, 100],
offset: [0, 0]
})参数
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
container | 水印挂载的容器 | HTMLElement | — |
width | 水印的宽度,content 的默认值为自身的宽度 | number | 120 |
height | 水印的高度,content 的默认值为自身的高度 | number | 64 |
rotate | 水印绘制时旋转的角度,单位 ° | number | -22 |
zIndex | 追加的水印元素的 z-index | number | 9 |
opacity | 水印透明度 0-1 | number | 0.15 |
image | 图片源,建议导出 2 倍或 3 倍图,优先级高(支持 base64 格式) | string | — |
content | 水印文字内容 | string | string[] | 'NeosJS' |
font | 文字样式 | Font | 见下方 |
gap | 水印之间的间距 | [number, number] | [100, 100] |
offset | 水印距离容器左上角的偏移量 | [number, number] | [0, 0] |
TIP
container、content 等参数均可选,具体以传入配置为准;上表未标注默认值的参数(如 container、image)无默认值。
API
| 方法 | 说明 |
|---|---|
update | 更新水印,传参可选,为水印参数(同构造参数) |
destroy | 销毁水印 |
Font
| 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
color | 字体颜色 | CanvasFillStrokeStyles.fillStyle | #333 |
size | 字体大小 | number | 16 |
weight | 字体粗细 | 'normal' | 'light' | 'weight' | number | normal |
family | 字体类型 | string | sans-serif |
style | 字体样式 | 'none' | 'normal' | 'italic' | 'oblique' | normal |
align | 指定文本对齐方向 | CanvasTextAlign | — |