Fix extra blank page when using headerRows + dontBreakRows + cell pageBreak (#2929)

* Fix extra blank page when using headerRows + dontBreakRows + cell pageBreak (fixes #2730)

* ci - build examples

* close initial dontBreakRows unbreakable block to avoid NaN page height

* revert pdfs

* Update CHANGELOG.md

---------

Co-authored-by: Nadeem Shadan <nadeem.s@iinerds.com>
Co-authored-by: Libor M. <liborm85@gmail.com>

Author: 3 people

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+- Fixed extra blank page when using headerRows, dontBreakRows and cell pageBreak together
+
 ## 0.3.7 - 2026-03-17
 
 - Updated pdfkit to 0.18.0

src/TableProcessor.js

@@ -1,9 +1,20 @@
 import ColumnCalculator from './columnCalculator';
 import { isNumber, isPositiveInteger } from './helpers/variableType';
 
+const PAGE_BREAK_VALUES = new Set(['before', 'beforeOdd', 'beforeEven', 'after', 'afterOdd', 'afterEven']);
+
+const hasExplicitPageBreak = cell => {
+	if (!cell || typeof cell !== 'object') {
+		return false;
+	}
+
+	return PAGE_BREAK_VALUES.has(cell.pageBreak);
+};
+
 class TableProcessor {
 	constructor(tableNode) {
 		this.tableNode = tableNode;
+		this._isCurrentRowUnbreakable = false;
 	}
 
 	beginTable(writer) {
@@ -163,7 +174,11 @@ class TableProcessor {
 
 		this.rowTopPageY = writer.context().y + this.rowPaddingTop;
 
-		if (this.dontBreakRows && rowIndex > 0) {
+		const rowCells = this.tableNode.table.body[rowIndex] || [];
+		const rowHasPageBreak = rowCells.some(hasExplicitPageBreak);
+		this._isCurrentRowUnbreakable = this.dontBreakRows && rowIndex > 0 && !rowHasPageBreak;
+
+		if (this._isCurrentRowUnbreakable) {
 			writer.beginUnbreakableBlock();
 		}
 		this.rowTopY = writer.context().y;
@@ -589,7 +604,9 @@ class TableProcessor {
 			this.headerRepeatable = writer.currentBlockToRepeatable();
 		}
 
-		if (this.dontBreakRows) {
+		const shouldCommitCurrentRowUnbreakable = this.dontBreakRows && (rowIndex === 0 || this._isCurrentRowUnbreakable);
+
+		if (shouldCommitCurrentRowUnbreakable) {
 			const pageChangedCallback = () => {
 				if (rowIndex > 0 && !this.headerRows && this.layout.hLineWhenBroken !== false) {
 					// Draw the top border of the row after a page break
@@ -604,6 +621,8 @@ class TableProcessor {
 			writer.removeListener('pageChanged', pageChangedCallback);
 		}
 
+		this._isCurrentRowUnbreakable = false;
+
 		if (this.headerRepeatable && (rowIndex === (this.rowsWithoutPageBreak - 1) || rowIndex === this.tableNode.table.body.length - 1)) {
 			writer.commitUnbreakableBlock();
 			writer.pushToRepeatables(this.headerRepeatable);

tests/integration/tables.spec.js

@@ -288,4 +288,54 @@ describe('Integration test: tables', function () {
 		assert.deepEqual(getColumnText(lines, { cell: 1 }), 'Row 2');
 	});
 
+	it('does not insert an extra page when combining headerRows, dontBreakRows and cell pageBreak', function () {
+		var dd = {
+			content: {
+				table: {
+					dontBreakRows: true,
+					headerRows: 1,
+					body: [
+						['row Header', 'column B'],
+						['row 1', 'column B'],
+						['row 2', 'column B'],
+						['row 3', 'column B'],
+						[{ text: '', pageBreak: 'after' }, ''],
+						['row 4', 'column B'],
+						['row 5', 'column B']
+					]
+				}
+			}
+		};
+
+		var pages = testHelper.renderPages('A6', dd);
+		var page1Texts = getCells(pages, { pageNumber: 0 }).map(node => node.item.inlines.map(inline => inline.text).join(''));
+		var page2Texts = getCells(pages, { pageNumber: 1 }).map(node => node.item.inlines.map(inline => inline.text).join(''));
+
+		assert.equal(pages.length, 2);
+		assert.deepEqual(page1Texts, ['row Header', 'column B', 'row 1', 'column B', 'row 2', 'column B', 'row 3', 'column B', '', '']);
+		assert.deepEqual(page2Texts, ['row Header', 'column B', 'row 4', 'column B', 'row 5', 'column B']);
+	});
+
+	it('keeps finite page dimensions with dontBreakRows tables without headers', function () {
+		var dd = {
+			content: {
+				table: {
+					dontBreakRows: true,
+					body: [
+						['row 1', 'column B'],
+						['row 2', 'column B'],
+						['row 3', 'column B']
+					]
+				}
+			}
+		};
+
+		var pages = testHelper.renderPages('A6', dd);
+
+		pages.forEach(page => {
+			assert.equal(Number.isFinite(page.pageSize.width), true);
+			assert.equal(Number.isFinite(page.pageSize.height), true);
+		});
+	});
+
 });