评论

wxml2canvas-2d:简单易用的小程序海报、战绩等分享图片生成方案

基于微信小程序 2D Canvas 的画布组件,根据给定 WXML 结构以及 CSS 样式快速转换成 Canvas 元素,以用于生成海报图片分享等操作。所见即所得(bushi

Github 地址:https://github.com/ChrisChan13/wxml2canvas-2d

介绍

当前,众多小程序的多处场景都需要能够生成分享图便于用户进行二次传播,从而提升小程序的传播率以及加强品牌效应。
比较简单的分享图,如寥寥几行文字和一张小程序码,可以通过微信的 Canvas API 绘制。旧版 Canvas API 绘制过程繁琐,且每次绘制都需要调用 draw 方法,一不小心代码就写了上百行。
新版 Canvas API 基本与 Web Canvas 对齐,使得开发效率提高、性能得到优化。虽然免去了很多繁琐操作,但面对拥有元素众多、结构复杂的分享图片,依然解决不了代码冗长的问题。
目前开源的一些小程序图片生成方案,有的年久失修、有的依然使用旧版 Canvas API、有的使用方式不够简便,于是便有了开发 wxml2canvas-2d 的想法。
wxml2canvas-2d 的图片生成方式简单直观:首先在 wxml 页面上编写元素结构,其次在 wxss 中编写元素样式,最后调用 wxml2canvas-2d 的相关方法即可生成所需的分享图片。
wxml2canvas-2d 会通过 class 类名查询元素节点的 computedStyle 和节点属性,从而将元素节点绘制到画布上。这样做的好处是在编写 wxml 结构以及样式时,可以直观的看见样式的变化,方便调整。当然也有坏处,这个用来生成图片的“wxml 模板”,必须存在于页面上。若需要隐藏这个“模板”,只可用定位将其移至屏幕外,不可以使用 wx:if 或 hidden 隐藏。
wxml2canvas-2d 已经支持大部分常用的 CSS 属性,等你来测~

示例

克隆此 Github 仓库,运行 npm i & npm run dev,将 miniprogram_dev 文件夹导入微信开发者工具

效果预览

小程序内容:

生成的图片:

安装

npm

使用 npm 构建前,请先阅读微信官方的 npm 支持

# 通过 npm 安装
npm i wxml2canvas-2d -S --production

构建 npm 包

打开微信开发者工具,点击 工具 -> 构建 npm,并勾选 使用 npm 模块 选项,构建完成后,即可引入组件。

使用

  1. 在页面配置中引入 wxml2canvas-2d ;
{
  "usingComponents": {
    "wxml2canvas": "wxml2canvas-2d"
  }
}
  1. 在页面中编写 wxml 结构,将要生成画布内容的根节点用名为 wxml2canvas-container 的样式类名称标记,将该根节点内部需要生成画布内容的节点用名为 wxml2canvas-item 的样式类名称标记(文字类节点需在对应节点声明 data-text 属性,并传入文字内容)。上述两个样式类名称可以自定义,只需将对应名称传入 wxml2canvas 组件的对应属性参数即可;
<!-- pages/index/index.wxml -->
<view class="wxml2canvas-container box">
  <view class="wxml2canvas-item title" data-text="测试标题">测试标题</view>
  <image class="wxml2canvas-item image" src="/your-image-path.png" />
  <view class="wxml2canvas-item content" data-text="测试内容,长文本。。">测试内容,长文本。。</view>
</view>
<button catchtap="generateSharingCard">生成画布内容</button>
<wxml2canvas id="wxml2canvas" />
  1. 补充各个节点样式;
/* pages/index/index.wxss */
.box { /* 根节点(容器)的样式 */ }
.title { /* 标题的样式 */ }
.image { /* 图片的样式 */ }
.content { /* 内容的样式 */ }
  1. 依据 wxml 结构以及 css 样式,生成画布内容,并将生成结果导出。
// pages/index/index.js
Page({
  async generateSharingCard() {
    const canvas = this.selectComponent('#wxml2canvas');
    await canvas.draw();
    const filePath = await canvas.toTempFilePath();
    wx.previewImage({
      urls: [filePath],
    });
  },
});

更多内容及文档 点击此处 前往查看!如果有好的建议或者想法,也欢迎提交 Issue 或 PR~

最后一次编辑于  2024-11-21  
点赞 3
收藏
评论

12 个评论

  • 所有闹钟已关.
    所有闹钟已关.
    04-23

    最近就碰到一个这样的需求 需要把一个页面上的内容导出成图片 研究好久都没做好 主要是页面元素太多了 canvas根本就不好画 用了wxml2canvas插件也是各种报错 直到找到作者这个 使用简单 效果也很棒 真的帮大忙了 为作者点赞!

    04-23
    赞同 1
    回复 7
    • 杰
      04-24
      感谢支持!这是做这个组件的初衷,免去繁琐的 canvas 操作。但组件依然还不够完善,许多样式亟待支持。使用过程中若发现什么问题或需求,欢迎提出探讨~
      04-24
      1
      回复
    • 所有闹钟已关.
      所有闹钟已关.
      04-25回复
      有的样式是不是还不支持呀 比如删除线样式 还有伪类元素
      04-25
      回复
    • 所有闹钟已关.
      所有闹钟已关.
      04-25回复
      还有是不是有的系统也不支持呀 我们老板用的鸿蒙系统 导出来的图片会样式错乱或者直接部分内容消失 不过问题不大安卓跟iOS都没问题
      04-25
      回复
    • 杰
      04-26回复所有闹钟已关.
      非常抱歉,删除线确实没有考虑到,后续会支持的!而伪类元素没办法通过 API 获取对应的节点信息,需要实现的话我能想到的只有通过传 dataset 属性声明该伪类的样式等信息。但这有悖于设计这个组件的初衷,就是:不需要使用额外的大量配置内容,只需要编写节点,就能将其转换为 Canvas 元素。所以目前只好避免使用伪类元素,转而使用真实的节点元素来替代伪类元素。至于鸿蒙系统,先前也有反馈部分鸿蒙的版本会有类似的问题。由于我也没有对应的鸿蒙设备,而且是部分鸿蒙版本会出现的问题,加大了我测试兼容的难度。鸿蒙系统对于部分 API 的兼容程度有限,其系统自身也还在迭代兼容过程,所以再次抱歉目前无法兼容覆盖到一部分鸿蒙版本的设备!
      04-26
      1
      回复
    • 杰
      04-26
      你也可以提供一下能复现绘制出错的代码片段,方便我之后测试兼容!
      04-26
      1
      回复
    查看更多(2)
  • 只为今҈天҈
    只为今҈天҈
    04-17

    模拟器能生成图片但是调试手机的时候无法生成 是需要改什么配置嘛WAServiceMainContext.js:1 MiniProgramError

    Cannot convert undefined or null to object

    TypeError: Cannot convert undefined or null to object

        at t.assign (<anonymous>)

    at (appservice.app.js:64:5525)

        at Array.map (<anonymous>)

    at ComponentCaller.<anonymous> (appservice.app.js:64:5492)

    at (WASubContext.js:1:155925)

    at (WASubContext.js:1:152101)

    at (WASubContext.js:1:155909)

    at (WASubContext.js:1:155717)

    at Function.<anonymous> (WASubContext.js:1:152141)

        at <setTimeout callback function>

    04-17
    赞同
    回复 19
    • 杰
      04-17
      请问可以提供一下代码片段吗?这个报错看不清楚具体位置
      04-17
      回复
    • 只为今҈天҈
      只为今҈天҈
      04-17回复
      就是ni demo的代码贴进去后 真机调试的时候就报错了
      04-17
      回复
    • 只为今҈天҈
      只为今҈天҈
      04-17
      04-17
      回复
    • 只为今҈天҈
      只为今҈天҈
      04-17
      04-17
      回复
    • 只为今҈天҈
      只为今҈天҈
      04-17
      发现俩canvas的打印不一样 模拟器
      Canvas component: li {__data__: {…}, __wxWebviewId__: 4, __wxExparserNodeId__: "8f756b55"}




      真机
      Canvas component: ComponentCaller {}data: (...)dataset: (...)exitState: (...)id: (...)is: (...)pageRouter: (...)properties: (...)renderer: (...)router: (...)[[Prototype]]: ComponentCaller
      04-17
      回复
    查看更多(14)
  • ᓚᘏᗢ 可
    ᓚᘏᗢ 可
    03-17

    经常出现后面的文本没了~~如以下文本:

    高血压(hypertensive disease)是一种以动脉血压持续升高为主要表现的慢性疾病,常引起心、脑、肾等重要器官的病变并出现相应的后果。起病及经过缓慢,最终死亡原因为心衰、肾衰及脑血管意外。本病为最常见的心血管疾病,WHO公布成人高血压患病率高达15%。国内本病患病率约7-10%。随年龄增长,发病有明显上升趋势。黑人、肥胖、吸烟、脑力劳动者等人群发病率较高。长期、系统、正规的抗高血压治疗有助于减慢病情发展、防止靶器官损害及提高生活质室。

    03-17
    赞同
    回复 1
    • 杰
      03-18
      感谢你所指出的问题,该问题已在最新版本中修复!
      03-18
      回复
  • wj
    wj
    03-12

    您好,我的小程序项目是用的vue+uniapp。请问如何正确引用

    03-12
    赞同
    回复 1
  • 夏味
    夏味
    02-21

    你好,想请教下,canvas 画布大小有限制,无法生成超长图片。这个问题有什么解决方案吗?有没有可能不用 canvas,直接使用 JS 生成图片?

    02-21
    赞同
    回复 5
    • 杰
      02-21
      微信新版 Canvas API 的画布大小有限制,这个没办法突破。在小程序内生成图片基本绕不开 Canvas,个人觉得有以下方案可参考,希望可以帮到你:
      1. 将内容分成片段,不超过大小限制,按顺序逐一绘制到 Canvas 上并导出,最后拼成一张完整图片;

      2. 使用官方 Skyline 渲染引擎,使用 snapshot 组件,https://developers.weixin.qq.com/miniprogram/dev/component/snapshot.html
      3. 由后端提供图片生成、使用无头浏览器渲染并截图等。
      02-21
      1
      回复
    • 夏味
      夏味
      02-24回复
      好的,非常感谢
      02-24
      回复
    • 杰
      02-24回复夏味
      不客气!若有其他方案希望也可以分享分享
      02-24
      回复
    • 夏味
      夏味
      02-24回复
      我试了下拼接图片的方案1,可行,但是速度太慢,不含 canvas 绘制事件,也需要 3 秒以上了。三方依赖库,大约 70 KB

      canvas 绘制出文字 + 图片(图1)

      1. ctx.getImageData 获取到每个像素的颜色数据 Uint8ClampedArray
      2. 拼接图片,将两份数据合并
      3. JS 库生成图片数据,高度 * 2
      UPNG.encode([bitmapData2.buffer], width, height * 2, 0)

      图3 是原始图片尺寸,和每个步骤的结束时间
      02-24
      回复
    • 杰
      02-25回复夏味
      确实,大图片的像素数据合并起来太费时间,在各种老旧设备的用户手中只会更慢,不过可能还有优化空间,比如:
      - 第三方库的合并方法可能有优化空间,删除非必要逻辑
      - 运用小程序的多线程 Worker 进行合并,减少主线程阻塞
      - 涉及画布的内容使用 OffscreenCanvas,减少主线程阻塞


      但做这些优化和测试,有点费时费力
      02-25
      1
      回复
  • 🍀111
    🍀111
    02-17

    您好,我在Taro框架上使用,文字渲染不出来是什么原因?代码就是示例代码,图片也可以展示,但是文字渲染不出来

    02-17
    赞同
    回复 9
    • 杰
      02-17
      看了一下 Taro 的文档,里面关于 dataset 的描述:https://docs.taro.zone/docs/vue-overall/#dataset。由于 wxml2canvas-2d 组件渲染文字用的是 data-text 属性来传入文字内容,但 Taro 不会真正注入 data-text,所以导致文字内容丢失。可以试试 Taro 文档中提到的 taro-plugin-inject 插件,将 data-text 属性配置注入到 Text 和 View 组件上。
      02-17
      回复
    • 🍀111
      🍀111
      02-17回复
      感谢,我试一试!
      02-17
      回复
    • 🍀111
      🍀111
      02-18
      注入了data-text,但是显示的就是配置后的固定值,页面是否引入该属性或者修改属性的值,都没反应。
      02-18
      回复
    • 杰
      02-18回复🍀111
      我没有使用过 taro-plugin-inject 插件,但藉由文档,我理解的配置意思应该是:
      02-18
      回复
    • 杰
      02-18回复🍀111
      或者配置中去掉单引号、配置的值赋为空字符串等,都可以尝试一下
      02-18
      回复
    查看更多(4)
  • Kaho💪
    Kaho💪
    02-08

    在mac设备上生成时会有大部分内容缺失 这是什么原因导致的呢

    02-08
    赞同
    回复 3
    • 杰
      02-09
      请问可以提供一下代码片段和相关 bug 表现的截图吗?由于没有 mac 设备,不是很好调试
      02-09
      回复
    • Kaho💪
      Kaho💪
      02-10回复
      是这样的 下面分享的第一个是从mac设备生成的 第二个是从手机设备生成的 手机设备生成出来的内容正常 但是mac设备生成出来的图里面文字全都消失了 这是什么原因导致的呢
      02-10
      回复
    • 杰
      02-10回复Kaho💪
      看不出头绪,mac 生成的分享卡片上蓝色的色块是背景图是吗?出现了错位并且被置于顶层了,因为有“保存名片”四个字是正确绘制了的,会不会是文字被盖住了?有没有办法提供一份能复现问题的代码片段呢?要不实在有些难以排查。
      https://developers.weixin.qq.com/miniprogram/dev/devtools/minicode.html
      02-10
      回复
  • CityHunter蕐
    CityHunter蕐
    01-22

    请问Uniapp上如何使用?

    01-22
    赞同
    回复 1
  • Mr.磊
    Mr.磊
    01-14

    01-14
    赞同
    回复 19
    • 杰
      01-14
      请检查 wxml 中是否包含 “wxml2canvas-container” 样式类名称的元素,或者为组件传入了 containerClass 属性,但与 wxml 中不一致,导致绘制时找不到容器元素
      01-14
      回复
    • Mr.磊
      Mr.磊
      01-14
      我的是在组件内部写的
      01-14
      回复
    • 杰
      01-14
      经测试发现在组件内部的确会出现该报错内容,已经找问题所在,问题将在下版本进行修复!感谢!
      01-14
      回复
    • Mr.磊
      Mr.磊
      01-14
      可以自定义背景吗?
      怎么做
      01-14
      回复
    • 杰
      01-14
      支持 background-color 和 background-image,只要写在对应 wxml 节点的样式中即可
      01-14
      回复
    查看更多(14)
  • bigGang
    bigGang
    01-09

    依据 wxml 结构以及 css 样式,生成画布内容,并将生成结果导出。

    文字加粗的问题css中的加粗会丢失,该如何解决

    01-09
    赞同
    回复 1
    • 杰
      01-10
      请问可以提供一下代码片段吗?
      01-10
      回复

正在加载...

登录 后发表内容