@opencorestack/opengridx 3.1.0 → 3.2.0

package/CHANGELOG.md

@@ -5,6 +5,16 @@
 
 ---
 
+## [3.2.0] — 2026-09-29
+
+### Added
+
+- **Non-blocking `exportToPdf`** — the export now works in ~30 ms slices and yields to the event loop between them, both while formatting rows (including grouped rows and WinAnsi conversion) and while drawing the table: the body is drawn by a series of `jspdf-autotable` calls that continue on the same page with fixed column widths, the header repeated on every new page and the footer only at the end. Pages, row positions, shading and page breaks are unchanged (verified against a single call in Chromium, Firefox and WebKit). Measured with 50,000 grouped rows in Chromium: longest main-thread block 6.3 s → ~0.4–0.6 s (jsPDF's final save, which cannot be split), total time about the same (~6–7 s), file size unchanged.
+- **`PdfExportOptions.onProgress`** — `({ phase: 'prepare' | 'render' | 'save', done, total }) => void`; new exported type `PdfExportProgress`.
+- **`PdfExportOptions.signal`** — an `AbortSignal`; aborting rejects the promise with a `DOMException` named `'AbortError'` and saves no file.
+- **`PdfExportOptions.maxRows`** (default 20,000) — above it a development-mode `console.warn` recommends `exportToCsv` / `exportToExcelAdvanced`. The export still runs; nothing is thrown.
+- Demo: the PDF export page has a row-count selector, a progress bar and a Cancel button.
+
 ## [3.1.0] — 2026-09-29
 
 ### Added

package/README.md

@@ -437,7 +437,7 @@ printGrid(rows, columns, 'Report Title');
 
 > **Optional peer dependencies:** `exportToExcelAdvanced` requires ExcelJS (`npm install exceljs`); `exportToPdf` requires `npm install jspdf jspdf-autotable`.
 
-> **Large exports:** PDF generation runs on the main thread and grows fast (about 120 MB and 10–16 s for 50,000 grouped rows, with the page blocked meanwhile). For more than a few thousand rows export CSV or `.xlsx`. PDF's built-in font only covers Latin-1: pass the `font` option (a Unicode `.ttf`) for characters such as `₹`, otherwise they print as `?`. See [PDF Export](docs/features/pdf-export.md).
+> **Large exports:** PDF size and time grow fast (75–120 MB and several seconds for 50,000 grouped rows). Since v3.2 `exportToPdf` yields between slices so the page stays responsive, reports `onProgress` and accepts an abort `signal`; above `maxRows` (default 20,000) it warns in development. For more than a few thousand rows export CSV or `.xlsx`. PDF's built-in font only covers Latin-1: pass the `font` option (a Unicode `.ttf`) for characters such as `₹`, otherwise they print as `?`. See [PDF Export](docs/features/pdf-export.md).
 
 CSV and HTML-Excel exports neutralise spreadsheet formulas (text starting with `=`, `+`, `-`, `@`, a tab or a carriage return gets a leading `'`; opt out with `escapeFormulas: false`), and CSV starts with a UTF-8 BOM (`bom: false` omits it). `exportToExcel` writes an HTML table, so a `.xlsx` file name is saved as `.xls`. To export what the grid shows, pass `apiRef.current.getAllFilteredRows()` and `apiRef.current.getVisibleColumns()`; with a custom `getRowId`, also pass `getRowId` in the options so `selectedRows` match. See the [Export Guide](docs/features/export-guide.md).
 

package/dist/index.d.ts

@@ -1767,6 +1767,34 @@ export declare interface PdfExportOptions<R extends GridValidRowModel = GridRowM
      * Has no effect when the grid has no active `rowGroupingModel`, or when `selectedRows` is non-empty.
      */
     groupedRows?: GridGroupedExportRow[];
+    /**
+     * Called as the export advances: `prepare` (formatting rows; `total` = source rows or grouped
+     * entries), `render` (drawing table rows; `total` = table body rows) and `save` (`0/1` before the
+     * file is written, `1/1` after). `done` never decreases within a phase and ends at `total`.
+     * @since v3.2
+     */
+    onProgress?: (progress: PdfExportProgress) => void;
+    /**
+     * Cancels the export. When aborted, the returned promise rejects with a `DOMException` named
+     * `'AbortError'` and no file is saved. Checked between slices of work, so cancellation takes
+     * effect within one slice; the final save step cannot be interrupted once started.
+     * @since v3.2
+     */
+    signal?: AbortSignal;
+    /**
+     * Table-row count above which a development-mode warning recommends `exportToCsv` or
+     * `exportToExcelAdvanced`. The export still runs (nothing is thrown). Pass `Infinity` to silence it.
+     * Default: 20000
+     * @since v3.2
+     */
+    maxRows?: number;
+}
+
+/** Progress reported by `PdfExportOptions.onProgress`. @since v3.2 */
+export declare interface PdfExportProgress {
+    phase: 'prepare' | 'render' | 'save';
+    done: number;
+    total: number;
 }
 
 declare interface PivotResult {