概述
裂变营销海报 是一个小程序内生成海报的插件,通过灵活简单的配置就可以生成精美的分享海报,适用于小程序裂变等场景。
可以绘制文字、图片、线条、色块到海报画布,支持设置宽高、透明度、层级甚至圆角等属性。
生成效果
快速预览
点击 导入代码片段 即可在微信开发者工具中运行和预览。需注意,由于引用插件,需要先申请接入权限,快速预览可填写 AppID:wx39b27487b6a29fcf
,确认适合自己后再发起插件接入申请。
接入指引
1、插件申请接入:
在微信公众平台中, “微信小程序官方后台-设置-第三方服务-插件管理” 里点击 “添加插件”,搜索 “裂变营销” ,申请通过后,小程序开发者可在小程序内使用该插件。
2、引入插件包:
1 | // app.json |
3、使用插件:
1 | <poster id="poster" config="{{posterConfig}}" bind:success="onPosterSuccess" bind:fail="onPosterFail"> |
使用注意事项
图片的域名务必添加到downloadFile合法域名中(开发设置-服务器域名-downloadFile合法域名)
组件参数解释
config字段
字段 | 类型 | 必填 | 描述 |
---|---|---|---|
width | Number(单位:rpx) | 是 | 画布宽度 |
height | Number(单位:rpx) | 是 | 画布高度 |
backgroundColor | String | 否 | 画布颜色 |
debug | Boolean | 否 | false隐藏canvas,true显示canvas,默认false |
pixelRatio | Number | 否 | 1为一般,值越大越清晰 |
preload | Boolean | 否 | true:图片资源预下载 默认false |
hide-loading | Boolean | 否 | true:隐藏loading 默认false |
blocks | Object Array(对象数组) | 否 | 看下文 |
texts | Object Array(对象数组) | 否 | 看下文 |
images | Object Array(对象数组) | 否 | 看下文 |
lines | Object Array(对象数组) | 否 | 看下文 |
blocks字段
字段名 | 类型 | 必填 | 描述 |
---|---|---|---|
x | Number(单位:rpx) | 是 | 块的坐标 |
y | Number(单位:rpx) | 是 | 块的坐标 |
width | Number(单位:rpx) | 否 | 如果内部有文字,由文字宽度和内边距决定 |
height | Number(单位:rpx) | 是 | |
paddingLeft | Number(单位:rpx) | 否 | 内左边距 |
paddingRight | Number(单位:rpx) | 否 | 内右边距 |
borderWidth | Number(单位:rpx) | 否 | 边框宽度 |
borderColor | String | 否 | 边框颜色 |
backgroundColor | String | 否 | 背景颜色 |
borderRadius | Number(单位:rpx) | 否 | 圆角 |
text | Object | 否 | 块里面可以填充文字,参考texts字段解释 |
zIndex | Int | 否 | 层级,越大越高 |
texts字段
字段名 | 类型 | 必填 | 描述 |
---|---|---|---|
x | Number(单位:rpx) | 是 | 坐标 |
y | Number(单位:rpx) | 是 | 坐标 |
text | String|Object | 是 | 当Object类型时,参数为text字段的参数,marginLeft、marginRight这两个字段可用(示例请看下文) |
fontSize | Number(单位:rpx) | 是 | 文字大小 |
color | String | 否 | 颜色 |
opacity | Int | 否 | 1为不透明,0为透明 |
lineHeight | Number(单位:rpx) | 否 | 行高 |
lineNum | Int | 否 | 根据宽度换行,最多的行数 |
width | Number(单位:rpx) | 否 | 没有指定为画布宽度 |
marginLeft | Number(单位:rpx) | 否 | 当text字段为Object可以使用,用来控制多行文字间距 |
marginRight | Number(单位:rpx) | 否 | 当text字段为Object可以使用,用来控制多行文字间距 |
textDecoration | String | 否 | 目前只支持 line-through(贯穿线),默认为none |
baseLine | String | 否 | top| middle|bottom基线对齐方式 |
textAlign | String | 否 | left|center|right对齐方式 |
zIndex | Int | 否 | 层级,越大越高 |
fontFamily | String | 否 | 小程序默认字体为’sans-serif’, 请输入小程序支持的字体,例如:’STSong’ |
fontWeight | String | 否 | ‘bold’加粗字体,目前小程序不支持 100 - 900 加粗 |
fontStyle | String | 否 | ‘italic’倾斜字体 |
images字段
字段 | 类型 | 必填 | 描述 |
---|---|---|---|
x | Number(单位:rpx) | 是 | 右上角的坐标 |
y | Number(单位:rpx) | 是 | 右上角的坐标 |
url | String | 是 | 图片url(需要添加到下载白名单域名中)也支持本地图片 |
width | Number(单位:rpx) | 是 | 宽度(会根据图片的尺寸同比例缩放) |
height | Number(单位:rpx) | 是 | 高度(会根据图片的尺寸同比例缩放) |
borderRadius | Number(单位:rpx) | 否 | 圆角,跟css一样 |
borderWidth | Number(单位:rpx) | 否 | 边框宽度 |
borderColor | String | 否 | 边框颜色 |
zIndex | Int | 否 | 层级,越大越高 |
lines字段
字段 | 类型 | 必填 | 描述 |
---|---|---|---|
startX | Number(单位:rpx) | 是 | 起始坐标 |
startY | Number(单位:rpx) | 是 | 起始坐标 |
endX | Number(单位:rpx) | 是 | 终结坐标 |
endY | Number(单位:rpx) | 是 | 终结坐标 |
width | Number(单位:rpx) | 是 | 线的宽度 |
color | String | 否 | 线的颜色 |
zIndex | Int | 否 | 层级,越大越高 |
事件
success
返回生成海报图片的本地url,一般做法是使用wx.previewImage
预览海报,如下
1 | onPosterSuccess(e) { |
fail
返回错误信息
异步生成海报 (从基础库版本 2.2.3 开始提供支持)
有些场景可能需要发起ajax请求后才能获取生成海报的数据,这里提供了异步生成海报的方式。
只需要对组件的onCreate
方法,如下调用就行了
1 | Page({ |
问题反馈
有什么问题可以添加微信 wesiri
,发消息“小程序”进讨论群。
为避免文档更新不同步问题,统一更新到地址:https://t.kainy.cn/pqhb/ 。