Documentation

npm install @rexymayderio/html-pdf-forge
# or
bun add @rexymayderio/html-pdf-forge

# For <pdf-qr> elements (lazy-loaded when first used)
npm install qrcode

# For <pdf-barcode> elements (lazy-loaded when first used)
npm install bwip-js

import { htmlToPdf } from '@rexymayderio/html-pdf-forge';

const pdf = await htmlToPdf('<h1>Q4 Report</h1>', {
  page: {
    size: 'A4',
    orientation: 'portrait',
    margins: { top: 40, right: 40, bottom: 40, left: 40 },
  },
  metadata: { title: 'Q4 Report', author: 'Mira Halvorsen' },
  header: '<div style="text-align:right">Q4 Report</div>',
  pageNumber: { placement: 'footer', format: 'Page {current} of {total}' },
});

await pdf.saveToFile('./q4-report.pdf');

await result.toBuffer();    // Node.js Buffer
result.toStream();          // ReadableStream (for piping)
await result.toBase64();    // base64 string
await result.toBlob();      // Blob (browser / Node 18+)
await result.saveToFile(path);

import { htmlToPdf } from '@rexymayderio/html-pdf-forge';           // Core PDF generation
import { mergePdfs } from '@rexymayderio/html-pdf-forge/merge';     // PDF merging
import { splitPdf } from '@rexymayderio/html-pdf-forge/split';      // PDF splitting
import { inlineQrCodes } from '@rexymayderio/html-pdf-forge/qr';    // QR preprocessing
import { inlineBarcodes } from '@rexymayderio/html-pdf-forge/barcode'; // Barcode preprocessing

import { HtmlPdfForge } from '@rexymayderio/html-pdf-forge';

const forge = new HtmlPdfForge({
  page: { size: 'A4' },
  metadata: { author: 'Reporting Service' },
  fonts: {
    Inter: {
      normal: './fonts/Inter-Regular.ttf',
      bold: './fonts/Inter-Bold.ttf',
    },
  },
  defaultFont: 'Inter',
});

const a = await forge.generate('<h1>Doc 1</h1>');
const b = await forge.generate('<h1>Doc 2</h1>', {
  metadata: { title: 'Custom Title' },
});

await htmlToPdf(html, {
  header: '<div style="text-align:right">Static header</div>',
  footer: (currentPage, pageCount) =>
    `<div>Page ${currentPage} of ${pageCount}</div>`,
});

await htmlToPdf(html, {
  pageNumber: {
    placement: 'footer',
    format: '{current} / {total}',
    style: { fontSize: 9, alignment: 'center', color: '#666' },
  },
});

// Simple
await htmlToPdf(html, { watermark: 'CONFIDENTIAL' });

// Full options
await htmlToPdf(html, {
  watermark: { text: 'DRAFT', color: 'red', opacity: 0.15, angle: -30 },
});

// Option 1: Use built-in web fonts (lazy-loaded from CDN, cached in memory)
await htmlToPdf(html, { defaultFont: 'Helvetica' });
// Available: 'Helvetica' (Arimo), 'Inter'

// Option 2: Custom font files
await htmlToPdf(html, {
  fonts: {
    Inter: {
      normal: './fonts/Inter-Regular.ttf',
      bold: './fonts/Inter-Bold.ttf',
    },
  },
  defaultFont: 'Inter',
});

await htmlToPdf(html, {
  metadata: {
    title: 'Q4 Report',
    author: 'Mira Halvorsen',
    subject: 'Quarterly numbers',
    keywords: ['finance', 'Q4'],
    creator: 'Reporting Service',
  },
});

await htmlToPdf(html, {
  protect: {
    userPassword: 'open123',
    ownerPassword: 'admin456',
    permissions: {
      printing: 'highResolution',
      copying: false,
      modifying: false,
    },
  },
});

import { createTemplate } from '@rexymayderio/html-pdf-forge';

const invoice = createTemplate(`
  <h1>Invoice #{{number}}</h1>
  <p>Bill to: <strong>{{customer}}</strong></p>
  <table>
    {{#items}}
    <tr><td>{{description}}</td><td>{{amount}}</td></tr>
    {{/items}}
  </table>
`);

const pdf = await invoice.render({
  number: 'INV-0042',
  customer: 'Halberd & Folk',
  items: [
    { description: 'Consulting', amount: '$500' },
    { description: 'Design', amount: '$300' },
  ],
});

<pdf-qr value="https://example.com/abc-123" size="120" margin="1" ec="M" />

<pdf-barcode type="code128" value="ABC-12345" width="220" height="70" />

import { mergePdfs } from '@rexymayderio/html-pdf-forge/merge';

const merged = await mergePdfs(
  [pdf1, await pdf2.toBuffer(), './third.pdf'],
  { metadata: { title: 'Combined Bundle' } },
);
await merged.saveToFile('./bundle.pdf');

import { splitPdf } from '@rexymayderio/html-pdf-forge/split';

const parts = await splitPdf(buffer, [
  [1, 3],
  [4, 6],
]);
await parts[0].saveToFile('./first.pdf');

<!-- Control column widths (number = fixed pt, "*" = fill, "auto" = content) -->
<table data-pdfmake='{"widths": [100, "*", "auto"]}'>
  <tr>
    <td>100pt fixed</td>
    <td>Fill remaining</td>
    <td>Auto width</td>
  </tr>
</table>

<!-- Percentage-based widths -->
<table data-pdfmake='{"widths": ["30%", "70%"]}'>
  <tr>
    <td>30% column</td>
    <td>70% column</td>
  </tr>
</table>

<!-- Fixed row heights -->
<table data-pdfmake='{"widths": ["*", "*"], "heights": 40}'>
  <tr>
    <td>All rows 40pt tall</td>
    <td>Same height</td>
  </tr>
</table>

<!-- Repeat header rows across pages -->
<table data-pdfmake='{"widths": ["*", "*"], "headerRows": 1}'>
  <tr>
    <td style="font-weight:bold; background-color:#f1f5f9;">Name</td>
    <td style="font-weight:bold; background-color:#f1f5f9;">Amount</td>
  </tr>
  <tr><td>Item 1</td><td>$100</td></tr>
</table>

<!-- Prevent row splitting across pages -->
<table data-pdfmake='{"widths": ["*"], "dontBreakRows": true}'>
  <tr><td>This row won't be split across pages</td></tr>
</table>

<!-- Page break before an element -->
<h2 data-pdfmake='{"pageBreak": "before"}'>New Page Section</h2>

<!-- Page break after an element -->
<p data-pdfmake='{"pageBreak": "after"}'>Content before the break</p>

<!-- Custom HR styling -->
<hr data-pdfmake='{"color": "red", "thickness": 2}'>

<!-- Absolute positioning (use with caution) -->
<p data-pdfmake='{"absolutePosition": {"x": 400, "y": 50}}'>
  Positioned text
</p>

<!-- Center a table using pdfmake columns -->
<div data-pdfmake-type="columns">
  <div data-pdfmake='{"width": "*"}'></div>
  <div style="width:auto">
    <table>
      <tr><th>Centered Table</th></tr>
      <tr><td>This table is centered on the page</td></tr>
    </table>
  </div>
  <div data-pdfmake='{"width": "*"}'></div>
</div>

<!-- ❌ Does NOT work — renders black borders -->
<table style="border:none;">
  <tr>
    <td style="border:none;">Content</td>
  </tr>
</table>

<!-- ✅ Workaround — white border on white background = invisible -->
<table>
  <tr>
    <td style="border:0.5px solid #ffffff; padding:4px 8px;">Content</td>
  </tr>
</table>

<!-- Side-by-side layout (e.g. signature block) -->
<table>
  <tr>
    <td style="width:50%; text-align:center; border:0.5px solid #ffffff;">
      <strong>Left Column</strong>
    </td>
    <td style="width:50%; text-align:center; border:0.5px solid #ffffff;">
      <strong>Right Column</strong>
    </td>
  </tr>
</table>

<!-- Remote URL (fetched automatically) -->
<img src="https://example.com/photo.png" width="120" height="120" />

<!-- Base64 data URI (for bundled assets) -->
<img src="data:image/png;base64,iVBORw0KGgo..." width="120" />

<!-- In Node.js, encode local files at runtime -->
import fs from 'fs';
const logo = fs.readFileSync('./logo.png').toString('base64');
const html = `<img src="data:image/png;base64,${logo}" width="120" />`;