@cqsjjb/jjb-pdf-utils

支持按需加载的HTML和图片转PDF工具库。

安装

npm install @cqsjjb/jjb-pdf-utils

使用方法

1. 完整导入（包含所有功能）

import pdfUtils from '@cqsjjb/jjb-pdf-utils';

// 使用 htmlToPDF
await pdfUtils.htmlToPDF('<div>Hello World</div>', {
  fileName: 'output.pdf'
});

// 使用 imageToPDF
await pdfUtils.imageToPDF('image.jpg', {
  fileName: 'image.pdf'
});

2. 按需导入（推荐）

只导入 HTML 转 PDF 功能

import htmlToPDF from '@cqsjjb/jjb-pdf-utils/htmlToPDF';

await htmlToPDF('<div>Hello World</div>', {
  fileName: 'output.pdf',
  singlePage: true
});

只导入图片转 PDF 功能

import imageToPDF from '@cqsjjb/jjb-pdf-utils/imageToPDF';

await imageToPDF('image.jpg', {
  fileName: 'image.pdf',
  fitToPage: true
});

按需导入多个功能

import { htmlToPDF, imageToPDF } from '@cqsjjb/jjb-pdf-utils';

// 使用 htmlToPDF
await htmlToPDF('<div>Hello World</div>');

// 使用 imageToPDF
await imageToPDF('image.jpg');

API 文档

htmlToPDF

将 HTML 内容转换为 PDF。

htmlToPDF(html, options)

参数：

• html (string | HTMLElement): HTML 字符串或 DOM 元素
• options (HtmlToPDFOptions): 配置选项

HtmlToPDFOptions：

• fileName (string): 导出的PDF文件名，默认: "output.pdf"
• leftMargin (number): 左边距（mm），默认: 10
• topMargin (number): 上边距（mm），默认: 10
• pdf (object): PDF相关配置
  • format ('p' | 'l'): PDF格式，默认: 'p'
  • unit ('mm' | 'pt' | 'in' | 'cm'): PDF单位，默认: 'mm'
  • size (string): PDF尺寸，默认: 'a4'
• canvas (object): html2canvas配置
  • scale (number): 清晰度缩放比例，默认: 2
  • useCORS (boolean): 是否使用CORS，默认: true
  • options (object): html2canvas的额外选项
• singlePage (boolean): 是否单页模式，默认: false

imageToPDF

将图片转换为 PDF。

imageToPDF(image, options)

参数：

• image (string | HTMLImageElement | File): 图片URL、HTMLImageElement或File对象
• options (ImageToPDFOptions): 配置选项

ImageToPDFOptions：

• fileName (string): 导出的PDF文件名，默认: "output.pdf"
• leftMargin (number): 左边距（mm），默认: 10
• topMargin (number): 上边距（mm），默认: 10
• pdf (object): PDF相关配置
  • format ('p' | 'l'): PDF格式，默认: 'p'
  • unit ('mm' | 'pt' | 'in' | 'cm'): PDF单位，默认: 'mm'
  • size (string): PDF尺寸，默认: 'a4'
• fitToPage (boolean): 是否适应页面大小，默认: true
• scale (number): 图片缩放比例，默认: 1

按需加载的优势

1. 减少包体积：只导入需要的功能，减少最终打包体积
2. 提高加载速度：按需加载可以显著提高应用启动速度
3. 更好的 Tree Shaking：现代打包工具可以更好地进行代码优化

示例

HTML 转 PDF 示例

import htmlToPDF from '@cqsjjb/jjb-pdf-utils/htmlToPDF';

// 基本使用
await htmlToPDF('<h1>Hello World</h1>');

// 高级配置
await htmlToPDF(document.getElementById('content'), {
  fileName: 'report.pdf',
  singlePage: true,
  leftMargin: 20,
  topMargin: 20,
  pdf: {
    format: 'l', // 横向
    size: 'a3'
  },
  canvas: {
    scale: 3, // 更高清晰度
    useCORS: true
  }
});

图片转 PDF 示例

import imageToPDF from '@cqsjjb/jjb-pdf-utils/imageToPDF';

// 基本使用
await imageToPDF('image.jpg');

// 高级配置
await imageToPDF(fileInput.files[0], {
  fileName: 'photo.pdf',
  fitToPage: true,
  scale: 0.8,
  pdf: {
    format: 'p', // 纵向
    size: 'a4'
  }
});

许可证

MIT