@neosjs/h5-graffiti
基于 Canvas 的 H5 涂鸦板。支持画笔大小与颜色设置、橡皮擦、撤销/恢复、背景色或背景图、LOGO 水印、生成图片(base64 与 Blob)等功能,同时适配鼠标与触摸事件。
安装
sh
pnpm add @neosjs/h5-graffitish
npm i @neosjs/h5-graffitish
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 | 涂鸦板容器元素 id | String | - |
width | 画布宽度 | Number | 1024 |
height | 画布高度 | Number | 768 |
lineSize | 画笔宽度 | Number | 2 |
lineColor | 画笔颜色 | String | #000 |
background | 背景颜色或背景图片地址 | String | - |
waterMark | LOGO 水印配置 | Object | - |
waterMark.url | 水印图片地址 | String | - |
waterMark.postion | 水印位置:top-left / top-right / bottom-left / bottom-right / center | String | - |
quality | 导出图片质量(0 ~ 1) | Number | 0.75 |
ext | 导出图片格式:jpg / png / bmp / gif | String | jpg |
TIP
createImage() 会将画布内容、背景图与水印合成为一张图片后返回,base64 可直接用于预览,blob 可直接用于上传。