Skip to content

@neosjs/h5-graffiti ​

基于 Canvas 的 H5 涂鸦板。支持画笔大小与颜色设置、橡皮擦、撤销/恢复、背景色或背景图、LOGO 水印、生成图片(base64 与 Blob)等功能,同时适配鼠标与触摸事件。

安装 ​

sh
pnpm add @neosjs/h5-graffiti
sh
npm i @neosjs/h5-graffiti
sh
yarn add @neosjs/h5-graffiti

快速上手 ​

包默认导出 graffiti 单例。先在页面准备一个容器,调用 init 初始化,再调用各接口进行绘制与导出:

html
<div id="graffiti-container"></div>
js
import graffiti from '@neosjs/h5-graffiti'

// 初始化涂鸦板
await graffiti.init({
  dom: 'graffiti-container', // 容器元素 id
  width: 1024, // 画布宽度
  height: 768, // 画布高度
  lineSize: 2, // 画笔宽度
  lineColor: '#000', // 画笔颜色
  background: '#ffffff', // 背景色,也可以传图片地址
  waterMark: { // LOGO 水印(可选)
    url: 'https://example.com/logo.png',
    postion: 'top-right'
  },
  quality: 0.75, // 导出图片质量
  ext: 'jpg' // 导出图片格式
})

// 设置画笔
graffiti.lineColor('#ff0000')
graffiti.lineSize(5)

// 切换橡皮擦(可同时设置大小)
graffiti.eraser(20)

// 撤销 / 恢复 / 清空
graffiti.prev()
graffiti.next()
graffiti.clear()

// 生成图片
const res = await graffiti.createImage()
if (res.errCode === 0) {
  console.log(res.data.base64) // base64 图片数据
  console.log(res.data.blob) // Blob 文件
}

// 销毁涂鸦板
graffiti.destroy()

API ​

接口参数说明
init(options)options: Object初始化涂鸦板,详见下方参数
lineColor(color)color: String设置画笔颜色
lineSize(size)size: Number设置画笔大小
eraserSize(size)size: Number设置橡皮擦大小
eraser(size?)size: Number切换到橡皮擦,可同时设置大小
prev()-撤销上一步
next()-恢复被撤销的操作
clear()-清空画布
destroy()-销毁涂鸦板
createImage()-生成图片,返回 { errCode, errMsg, data: { base64, blob } }

WARNING

saveImage(fileName) 接口已废弃,请使用 createImage() 代替。

init 参数 ​

参数说明类型默认值
dom涂鸦板容器元素 idString-
width画布宽度Number1024
height画布高度Number768
lineSize画笔宽度Number2
lineColor画笔颜色String#000
background背景颜色或背景图片地址String-
waterMarkLOGO 水印配置Object-
waterMark.url水印图片地址String-
waterMark.postion水印位置:top-left / top-right / bottom-left / bottom-right / centerString-
quality导出图片质量(0 ~ 1)Number0.75
ext导出图片格式:jpg / png / bmp / gifStringjpg

TIP

createImage() 会将画布内容、背景图与水印合成为一张图片后返回,base64 可直接用于预览,blob 可直接用于上传。