@opencorestack/opengridx 1.1.0 → 1.2.0

package/CHANGELOG.md

@@ -5,6 +5,18 @@
 
 ---
 
+## [1.2.0] — 2026-09-03
+
+### Added
+- `exportToPdf(rows, columns, options?)` — generate a styled PDF report from grid data.
+  Optional peer deps required: `npm install jspdf jspdf-autotable`.
+  Features: optional branded header (logo, title, filter summary, row count), multi-page
+  data table with repeating column headers, alternating row shading, aggregation footer row.
+  See `docs/features/pdf-export.md`.
+- New exported type: `PdfExportOptions`
+
+---
+
 ## [1.1.0] — 2026-09-02
 
 ### Added

package/dist/index.d.ts

@@ -368,6 +368,8 @@ export declare function exportToExcelAdvanced<R extends GridRowModel>(rows: R[],
  */
 export declare function exportToJson<R extends GridRowModel>(rows: R[], columns: GridColDef<R>[], options?: JsonExportOptions): void;
 
+export declare function exportToPdf<R extends GridRowModel>(rows: R[], columns: GridColDef<R>[], options?: PdfExportOptions): Promise<void>;
+
 export declare const FilterPanel: default_2.FC<FilterPanelProps>;
 
 declare interface FilterPanelProps {
@@ -1172,6 +1174,64 @@ export declare interface JsonExportOptions {
     aggregationModel?: GridAggregationModel | null;
 }
 
+/**
+ * Configuration options for exporting the DataGrid to PDF format.
+ * Requires jspdf and jspdf-autotable peer dependencies.
+ */
+export declare interface PdfExportOptions {
+    /**
+     * Output filename without extension. Default: 'export'
+     */
+    fileName?: string;
+    /**
+     * Title text displayed in the document header.
+     * When omitted, no header block is rendered.
+     */
+    title?: string;
+    /**
+     * URL or data URI of a logo image rendered left of the title.
+     * Only used when `title` is also set. Default: none
+     */
+    logoUrl?: string;
+    /**
+     * Page orientation. Default: 'landscape'
+     */
+    orientation?: 'portrait' | 'landscape';
+    /**
+     * If provided, only rows whose id is in this array are exported.
+     */
+    selectedRows?: (string | number)[];
+    /**
+     * Aggregation result from apiRef.current.getAggregationResult().
+     * When provided alongside aggregationModel, appends a footer row.
+     */
+    aggregationResult?: Record<string, unknown> | null;
+    /**
+     * Aggregation model from apiRef.current.getAggregationModel().
+     */
+    aggregationModel?: GridAggregationModel | null;
+    /**
+     * Active filter model. When provided, a filter summary is shown in the header.
+     */
+    filterModel?: GridFilterModel | null;
+    /**
+     * Whether to apply alternating row shading. Default: true
+     */
+    alternateRowColor?: boolean;
+    /**
+     * Column header background color (hex). Default: '#4f46e5'
+     */
+    headerBackgroundColor?: string;
+    /**
+     * Column header text color (hex). Default: '#ffffff'
+     */
+    headerTextColor?: string;
+    /**
+     * Base font size in points for table body. Default: 9
+     */
+    fontSize?: number;
+}
+
 /**
  * Open print dialog with formatted table
  */