跳到主要内容

Signature

容器属性

所有组件配置的第一层均支持容器属性

组件属性 componentsProps

NameTypeDefault是否支持 Variable PatternDescription
classNamestring✔️组件的 className
styleobject组件的 style
penColorstring'black'笔触颜色
minWidthnumber0.5笔触最小宽度
maxWidthnumber2.5笔触最大宽度
backgroundColorstring'rgba(0,0,0,0)'画布背景色
outputType'image/png' | 'image/jpeg' | 'image/svg+xml''image/png'签名输出的图片格式
canvasWidthnumber画布宽度,默认跟随容器宽度
canvasHeightnumber200画布高度
hideToolbarboolfalse是否隐藏底部工具栏(包含提示文字和清除按钮)

所有其余 componentsProps 将会被传给组件画布容器元素(div)。

JS API

通过 formApi.getFieldApi() 获取的接口如下。其中 signaturePad 为底层 signature_pad 实例,可参考其官方 API 文档进行更多操作。

NameTypeDescription
nodeHTML Element组件的根 DOM 元素
signaturePadSignaturePad底层 SignaturePad 实例
clear() => void清除画布上的签名