0.0.1 • Published 2 years ago

bu-watermark v0.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

前端页面生成水印

特点:

  • 对于用户:防止用户通过开发者工具删除和修改水印
  • 对于开发者:可配置性强,使用方便
  • 体积小,未压缩时,只有 4kb 大小

使用方法

引用

yarn

yarn add bu-watermark

npm

npm install bu-watermark

直接引入

<script src="dist/bu-watermark.js"></script>

使用方式

普通使用

new BuWatermark({
  target: document.getElementById('app'),
  text: 'bu-watemark'
})

多行水印

new BuWatermark({
  target: document.getElementById('app'),
  text: ['bu-watemark', 'bu-watemark2']
})

提供的方法

为了使用方便,只提供了一个方法 remove

var watermark = new BuWatermark({
  target: document.getElementById('app'),
  text: 'bu-watemark'
})

// 3s以后移除水印
setTimeout(function() {
  watermark.remove()
}, 3000)

参数

对外暴露接口

interface BuWatermarkMoreOptions extends Object {
  angle: number
  fontColor: string
  opacity: number | string
  zIndex: number
  fontSize: string
  fontFamily: string
}

interface BuWatermarkOptions extends Object {
  target: string
  text: string | number | Array<string>
  options: BuWatermarkMoreOptions
}

配置含义

字段含义类型默认值
target指定渲染的目标区域HTMLElementdocument.body
text水印文本stringarray
options更多配置Object-

options:

字段含义类型默认值
angle水印角度number25
fontColor水印颜色string#000
opacity透明度number | string0.2
zIndex显示层级number10000
fontSize水印文字大小string16px
fontFamily字体stringArial