
Pluggable canvas adapter for Happy DOM using node-canvas.
Installation
npm install canvas @happy-dom/node-canvas-adapter
Documentation
You will find the documentation in the Happy DOM Wiki under Node Canvas Adapter.
Usage
import { Window } from 'happy-dom';
import { CanvasAdapter } from '@happy-dom/node-canvas-adapter';
const window = new Window({
settings: {
canvasAdapter: new CanvasAdapter(),
// Optionally, enable image file loading (e.g. for <img> elements)
enableImageFileLoading: true
}
});
const canvas = window.document.createElement('canvas');
const context = canvas.getContext('2d');
canvas.width = 200;
canvas.height = 200;
// Now you can use canvas context
context.fillStyle = 'red';
context.fillRect(0, 0, 100, 100);
// Get data URL
const dataUrl = canvas.toDataURL();
// Output the data URL
console.log(dataUrl);
Happy DOM
Documentation | Getting Started | Setup as Test Environment | GitHub
关于 @happy-dom/node-canvas-adapter 的常见问题
@happy-dom/node-canvas-adapter 是什么?
Pluggable canvas adapter for happy-dom using node-canvas.
如何安装 @happy-dom/node-canvas-adapter?
在项目目录运行 npm install @happy-dom/node-canvas-adapter,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:canvas(^3.2.3)、happy-dom(>=20.9.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。
@happy-dom/node-canvas-adapter 支持 TypeScript 吗?
支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@happy-dom/node-canvas-adapter 支持 ESM 还是 CommonJS?
以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。
@happy-dom/node-canvas-adapter 需要什么版本的 Node.js?
package.json 的 engines 字段要求 Node.js >=20.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。
@happy-dom/node-canvas-adapter 可以商用吗?
@happy-dom/node-canvas-adapter 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。
@happy-dom/node-canvas-adapter 的下载量有多少?
根据 npm 官方下载统计,@happy-dom/node-canvas-adapter 在 2026/10/17 – 2026/11/15 这 30 天内被下载 9,343 次,日均约 311 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@happy-dom/node-canvas-adapter 还在维护吗?
最新版本 21.0.4 发布于 2026/10/21(27 天前);至今共发布 41 个版本,其中过去 12 个月发布了 41 个;首次发布于 2026/06/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。