Skip to content

@neosjs/merge-images ​

将多张图片合并为一张图片的 Canvas 工具库。支持为每张图片指定绘制位置与透明度、自定义输出尺寸、格式与质量,返回 base64 结果;同时支持注入自定义 Canvas / Image 构造器,可在 Node 环境配合 node-canvas 使用。

安装 ​

sh
pnpm add @neosjs/merge-images
sh
npm i @neosjs/merge-images
sh
yarn add @neosjs/merge-images

快速上手 ​

传入图片地址数组,得到合并后的 base64:

ts
import mergeImages from '@neosjs/merge-images'

const images = [
  'https://example.com/image1.png',
  'https://example.com/image2.png',
  'https://example.com/image3.png'
]

mergeImages(images, {
  width: 800,
  height: 600,
  format: 'image/png',
  quality: 1,
  crossOrigin: 'anonymous'
}).then((base64: string) => {
  console.log(base64)
})

图片元素支持对象形式,通过 x / y 指定在画布上的绘制位置,opacity 控制透明度:

ts
mergeImages([
  { src: 'https://example.com/bg.png', x: 0, y: 0 },
  {
    src: 'https://example.com/logo.png',
    x: 100,
    y: 200,
    opacity: 0.8
  }
])

TIP

未指定 width / height 时,画布尺寸默认取所有图片中的最大宽度与最大高度。

API ​

mergeImages(sources, options) ​

参数说明类型默认值
sources图像列表,元素为图片地址或 Source 对象Array<Source | string>[]
options.width合并后的图像宽度number取图片最大宽度
options.height合并后的图像高度number取图片最大高度
options.format输出图像格式'image/png' | 'image/jpeg' | 'image/webp''image/jpeg'
options.quality输出图像质量number(0 ~ 1)0.75
options.crossOrigin图片跨域属性'anonymous' | 'use-credentials''anonymous'
options.Canvas自定义 Canvas 构造器(Node 场景)any-
options.Image自定义 Image 构造器(Node 场景)any-

返回 Promise<string>,内容为合并后图片的 base64 数据;图片列表为空时返回 Promise.reject。

类型定义 ​

ts
export interface Options {
  format?: string
  quality?: number
  width?: number | undefined
  height?: number | undefined
  Canvas?: any
  crossOrigin?: string
  Image?: any
  [key: string]: any
}

export interface Source {
  src?: string
  x?: number
  y?: number
  opacity?: number
}