Skip to content

@neosjs/watermark ​

通用的 JS 水印生成类,基于 Canvas 绘制,可以给页面的某个区域加上文字或图片水印。支持旋转角度、透明度、层级、水印间距与偏移等配置。

安装 ​

sh
pnpm add @neosjs/watermark
sh
npm i @neosjs/watermark
sh
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 的默认值为自身的宽度number120
height水印的高度,content 的默认值为自身的高度number64
rotate水印绘制时旋转的角度,单位 °number-22
zIndex追加的水印元素的 z-indexnumber9
opacity水印透明度 0-1number0.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字体大小number16
weight字体粗细'normal' | 'light' | 'weight' | numbernormal
family字体类型stringsans-serif
style字体样式'none' | 'normal' | 'italic' | 'oblique'normal
align指定文本对齐方向CanvasTextAlign—