mini-smooth-signature 小程序带笔锋手写签名
-
smooth-signature H5带笔锋手写签名,支持PC/移动端使用
-
mini-stores 小程序多状态管理库,支持多平台小程序使用
前言
受疫情的影响,无纸化流程和电子合同开始普及,电子签名需求也不断增加,签名体验也在逐渐改善,从一开始简单的canvas画线,到追求线条丝滑圆润,再到要求和纸上写字一样的笔锋效果等等。网上不少现成开源的签名库,其中signature_pad笔锋效果实现比较好,但具体使用还是会发现有明显的锯齿感,于是利用工作之余,根据自身理解换了另一种方案实现了一套,同时也为小程序开发了一版,一起分享给有需要的同学。
安装
npm install mini-smooth-signature
# 或
yarn add mini-smooth-signature
使用
支持微信/支付宝/钉钉/QQ小程序。以下展示为钉钉平台测试代码,各平台样例代码请查看Examples,其他平台小程序可参考现有样例自行验证使用。
<view>
<canvas
id="signature"
width="{{width * scale}}"
height="{{height * scale}}"
style="width:{{width}}px;height:{{height}}px;"
disable-scroll="{{true}}"
onTouchStart="handleTouchStart"
onTouchMove="handleTouchMove"
onTouchCancel="handleTouchEnd"
onTouchEnd="handleTouchEnd"
/>
</view>
import Signature from 'mini-smooth-signature';
Page({
data: {
width: 320,
height: 200,
scale: 2,
},
onReady() {
this.initSignature()
},
// 初始化
initSignature() {
const ctx = dd.createCanvasContext('signature');
this.signature = new Signature(ctx, {
width: this.data.width,
height: this.data.height,
scale: this.data.scale,
getImagePath: () => {
return new Promise((resolve) => {
ctx.toTempFilePath({
success: res => resolve(res.filePath),
})
})
}
});
},
// 绑定touchstart事件
handleTouchStart(e) {
const pos = e.touches[0];
this.signature.onDrawStart(pos.x, pos.y);
},
// 绑定touchmove事件
handleTouchMove(e) {
const pos = e.touches[0];
this.signature.onDrawMove(pos.x, pos.y);
},
// 绑定touchend/touchcancel事件
handleTouchEnd() {
this.signature.onDrawEnd();
},
});
配置[options]
所有配置项均是可选的
const signature = new Signature(ctx, {
width: 300,
height: 600,
scale: 2,
minWidth: 4,
maxWidth: 10,
color: '#1890ff',
bgColor: '#efefef',
});
options.width
画布在页面实际渲染的宽度(px)
- Type:
number
- Default:300
options.height
画布在页面实际渲染的高度(px)
- Type:
number
- Default:150
options.scale
画布缩放
- Type:
number
- Default:1
options.color
画笔颜色
- Type:
string
- Default:black
options.bgColor
画布背景颜色
- Type:
string
- Default:
options.getImagePath
生成临时图片的Promise函数,用于保存历史记录,如该项未配置,则撤销功能不可用
- Type:
promise
options.toDataURL
生成base64图片函数
- Type:
function
options.requestAnimationFrame
在下次进行重绘时执行。用于提高绘画性能,减少卡顿不流畅
- Type:
function
options.openSmooth
是否开启笔锋效果,默认开启
- Type:
boolean
- Default:true
options.minWidth
画笔最小宽度(px),开启笔锋时画笔最小宽度
- Type:
number
- Default:2
options.maxWidth
画笔最大宽度(px),开启笔锋时画笔最大宽度,或未开启笔锋时画笔正常宽度
- Type:
number
- Default:6
options.minSpeed
画笔达到最小宽度所需最小速度(px/ms),取值范围1.0-10.0,值越小,画笔越容易变细,笔锋效果会比较明显,可以自行调整查看效果,选出自己满意的值。
- Type:
number
- Default:1.5
options.maxWidthDiffRate
相邻两线宽度增(减)量最大百分比,取值范围1-100,为了达到笔锋效果,画笔宽度会随画笔速度而改变,如果相邻两线宽度差太大,过渡效果就会很突兀,使用maxWidthDiffRate限制宽度差,让过渡效果更自然。可以自行调整查看效果,选出自己满意的值。
- Type:
number
- Default:20
options.maxHistoryLength
限制历史记录数,即最大可撤销数,传入0则关闭历史记录功能
- Type:
number
- Default:20
实例属性/方法
// 画布上下文context
signature.ctx
// 清屏
signature.clear()
// 撤销,如果未配置getImagePath,则不可用
signature.undo()
// 获取base64图片,若未配置toDataURL,则不可用
signature.toDataURL()
// 是否为空
signature.isEmpty()
实现原理
我们平时纸上写字,细看会发现笔画的粗细是不均匀的,这是写字过程中,笔的按压力度和移动速度不同而形成的。而在电脑手机浏览器上,虽然我们无法获取到触摸的压力,但可以通过画笔移动的速度来实现不均匀的笔画效果,让字体看起来和纸上写字一样有“笔锋”。,下面介绍具体实现过程(以下展示代码只为方便理解,非最终实现代码)。
1、采集画笔经过的点坐标和时间
通过监听画布move事件采集移动经过的点坐标,并记录当前时间,然后保存到points数组中。
function onTouchMove(x, y) {
const point = { x, y, t: Date.now() }
points.push(point);
};
2、计算两点之间移动速度
通过两点坐标计算出两点距离,再除以时间差,即可得到移动速度。
const distance = Math.sqrt(Math.pow(end.x - start.x, 2) + Math.pow(end.y - start.y, 2));
const speed = distance / (end.t - start.t);
3、计算两点之间线的宽度
得到两点间移动速度,接下来通过简单算法计算出线的宽度,其中maxWidth、minWidth、minSpeed为配置项
const addWidth = (maxWidth - minWidth) * speed / minSpeed;
const lineWidth = Math.min(Math.max(maxWidth - addWidth, minWidth), maxWidth);
另外,为了防止相邻两条线宽度差太大,而出现突兀的过渡效果,需要做下限制,其中maxWidthDiffRate为配置项,preLineWidth为上一条线的宽度
const rate = (lineWidth - preLineWidth) / preLineWidth;
const maxRate = maxWidthDiffRate / 100;
if (Math.abs(rate) > maxRate) {
const per = rate > 0 ? maxRate : -maxRate;
lineWidth = preLineWidth * (1 + per);
}
4、画曲线/直线
现在已经知道每两点间线的宽度,接下来就是画线了。为了让线条看起来圆润以及线粗细过渡更自然,我把两点之间的线平均成三段,其中:
- 第一段(x0,y0 - x1,y1)线宽设置为当前线宽和上一条线宽的平均值lineWidth1 = (preLineWidth + lineWidth) / 2
- 第二段(x1,y1 - x2,y2)
- 第三段(x2,y2 - next_x0,next_y0)线宽设置为当前线宽和下一条线宽的平均值lineWidth3 = (nextLineWidth + lineWidth) / 2
开始画线,先来看第一段线,因为第一段线和上一条线相交,为了保证两条线过渡比较圆润,采用二次贝塞尔曲线,起点为上一条线的第三段起点(pre_x2, pre_y2)
ctx.lineWidth = lineWidth1
ctx.beginPath();
ctx.moveTo(pre_x2, pre_y2);
ctx.quadraticCurveTo(x0, y0, x1, y1);
ctx.stroke();
第二段线为承接第一段和第三段的过渡线,由于第一段和第三段线宽有差异,所以第二段线使用梯形填充,让过渡效果更自然。
ctx.beginPath();
ctx.moveTo(point1.x, point1.y);
ctx.lineTo(point2.x, point2.y);
ctx.lineTo(point3.x, point3.y);
ctx.lineTo(point4.x, point4.y);
ctx.fill();
第三段等画下一条线时重复上述操作即可。