Add custom pages builder to PdfPreview widget

 # Changelog
 # Changelog
 
 
-## 5.9.4
+## 5.10.0
 
 
 - Remove deprecated Android embedding
 - Remove deprecated Android embedding
+- Add custom pages builder to PdfPreview widget [Milad akarie]
 
 
 ## 5.9.3
 ## 5.9.3
 
 

@@ -22,7 +22,12 @@ import 'package:pdf/pdf.dart';
 import '../callback.dart';
 import '../callback.dart';
 import '../printing.dart';
 import '../printing.dart';
 import '../printing_info.dart';
 import '../printing_info.dart';
+import 'page.dart';
 import 'raster.dart';
 import 'raster.dart';
+/// Custom widget builder that's used for custom
+/// rasterized pdf pages rendering
+typedef CustomPdfPagesBuilder = Widget Function(
+    BuildContext context, List<PdfPreviewPageData> pages);
 
 
 /// Flutter widget that uses the rasterized pdf pages to display a document.
 /// Flutter widget that uses the rasterized pdf pages to display a document.
 class PdfPreviewCustom extends StatefulWidget {
 class PdfPreviewCustom extends StatefulWidget {
@@ -43,6 +48,7 @@ class PdfPreviewCustom extends StatefulWidget {
     this.dpi,
     this.dpi,
     this.scrollPhysics,
     this.scrollPhysics,
     this.shrinkWrap = false,
     this.shrinkWrap = false,
+    this.pagesBuilder,
   }) : super(key: key);
   }) : super(key: key);
 
 
   /// Pdf paper page format
   /// Pdf paper page format
@@ -91,6 +97,10 @@ class PdfPreviewCustom extends StatefulWidget {
   /// If not provided, this value is calculated.
   /// If not provided, this value is calculated.
   final double? dpi;
   final double? dpi;
 
 
+  /// clients can pass this builder to render
+  /// their own pages.
+  final CustomPdfPagesBuilder? pagesBuilder;
+
   @override
   @override
   PdfPreviewCustomState createState() => PdfPreviewCustomState();
   PdfPreviewCustomState createState() => PdfPreviewCustomState();
 }
 }
@@ -183,6 +193,9 @@ class PdfPreviewCustomState extends State<PdfPreviewCustom>
           );
           );
     }
     }
 
 
+    if (widget.pagesBuilder != null) {
+      return widget.pagesBuilder!(context, pages);
+    }
     return ListView.builder(
     return ListView.builder(
       controller: scrollController,
       controller: scrollController,
       shrinkWrap: widget.shrinkWrap,
       shrinkWrap: widget.shrinkWrap,
@@ -197,7 +210,11 @@ class PdfPreviewCustomState extends State<PdfPreviewCustom>
             transformationController.value.setIdentity();
             transformationController.value.setIdentity();
           });
           });
         },
         },
-        child: pages[index],
+        child: PdfPreviewPage(
+          pageData: pages[index],
+          pdfPreviewPageDecoration: widget.pdfPreviewPageDecoration,
+          pageMargin: widget.previewPageMargin,
+        ),
       ),
       ),
     );
     );
   }
   }
@@ -212,7 +229,13 @@ class PdfPreviewCustomState extends State<PdfPreviewCustom>
       child: InteractiveViewer(
       child: InteractiveViewer(
         transformationController: transformationController,
         transformationController: transformationController,
         maxScale: 5,
         maxScale: 5,
-        child: Center(child: pages[preview!]),
+        child: Center(
+          child: PdfPreviewPage(
+            pageData: pages[preview!],
+            pdfPreviewPageDecoration: widget.pdfPreviewPageDecoration,
+            pageMargin: widget.previewPageMargin,
+          ),
+        ),
       ),
       ),
     );
     );
   }
   }

@@ -15,25 +15,61 @@
  */
  */
 
 
 import 'package:flutter/material.dart';
 import 'package:flutter/material.dart';
+/// A class that holds rasterized pdf data
+class PdfPreviewPageData {
+  /// Default constructor
+  const PdfPreviewPageData({
+    required this.image,
+    required this.width,
+    required this.height,
+  });
+
+  /// rasterized pdf image provider
+  final ImageProvider image;
+  /// rasterized image width
+  final int width;
+  /// rasterized image height
+  final int height;
+
+   /// returns with to height aspect ratio
+  double get aspectRatio {
+    if (height != 0.0) {
+      return width / height;
+    }
+    if (width > 0.0) {
+      return double.infinity;
+    }
+    if (width < 0.0) {
+      return double.negativeInfinity;
+    }
+    return 0.0;
+  }
+
+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) ||
+      other is PdfPreviewPageData &&
+          runtimeType == other.runtimeType &&
+          image == other.image &&
+          width == other.width &&
+          height == other.height;
+
+  @override
+  int get hashCode => image.hashCode ^ width.hashCode ^ height.hashCode;
+}
 
 
 /// Represents one PDF page
 /// Represents one PDF page
 class PdfPreviewPage extends StatelessWidget {
 class PdfPreviewPage extends StatelessWidget {
   /// Create a PDF page widget
   /// Create a PDF page widget
   const PdfPreviewPage({
   const PdfPreviewPage({
     Key? key,
     Key? key,
-    required this.image,
-    required this.width,
-    required this.height,
+    required this.pageData,
     this.pdfPreviewPageDecoration,
     this.pdfPreviewPageDecoration,
     this.pageMargin,
     this.pageMargin,
   }) : super(key: key);
   }) : super(key: key);
 
 
   /// Image representing the content of the page
   /// Image representing the content of the page
-  final ImageProvider image;
-
-  final int width;
-
-  final int height;
+  final PdfPreviewPageData pageData;
 
 
   /// Decoration around the page
   /// Decoration around the page
   final Decoration? pdfPreviewPageDecoration;
   final Decoration? pdfPreviewPageDecoration;
@@ -69,9 +105,9 @@ class PdfPreviewPage extends StatelessWidget {
             ],
             ],
           ),
           ),
       child: AspectRatio(
       child: AspectRatio(
-        aspectRatio: width / height,
+        aspectRatio: pageData.aspectRatio,
         child: Image(
         child: Image(
-          image: image,
+          image: pageData.image,
           fit: BoxFit.cover,
           fit: BoxFit.cover,
         ),
         ),
       ),
       ),

@@ -26,6 +26,7 @@ import 'controller.dart';
 import 'custom.dart';
 import 'custom.dart';
 
 
 export 'custom.dart';
 export 'custom.dart';
+export 'page.dart' show PdfPreviewPageData;
 
 
 /// Flutter widget that uses the rasterized pdf pages to display a document.
 /// Flutter widget that uses the rasterized pdf pages to display a document.
 class PdfPreview extends StatefulWidget {
 class PdfPreview extends StatefulWidget {
@@ -61,7 +62,66 @@ class PdfPreview extends StatefulWidget {
     this.loadingWidget,
     this.loadingWidget,
     this.onPageFormatChanged,
     this.onPageFormatChanged,
     this.dpi,
     this.dpi,
-  }) : super(key: key);
+  })  : _pagesBuilder = null,
+        super(key: key);
+
+  /// Build a custom layout.
+  ///
+  /// ```dart
+  /// PdfPreview.builder(
+  ///   build: (format) => _generatePdf(format, title),
+  ///   pagesBuilder: (context, pages) => SingleChildScrollView(
+  ///     child: Wrap(
+  ///       spacing: 8,
+  ///       runSpacing: 8,
+  ///       children: [
+  ///         for (final page in pages)
+  ///           Container(
+  ///             color: Colors.white,
+  ///             child: Image(
+  ///               image: page.image,
+  ///               width: 300,
+  ///             ),
+  ///           )
+  ///       ],
+  ///     ),
+  ///   ),
+  /// )
+  /// ```
+  const PdfPreview.builder({
+    Key? key,
+    required this.build,
+    this.initialPageFormat,
+    this.allowPrinting = true,
+    this.allowSharing = true,
+    this.maxPageWidth,
+    this.canChangePageFormat = true,
+    this.canChangeOrientation = true,
+    this.canDebug = true,
+    this.actions,
+    this.pageFormats = _defaultPageFormats,
+    this.onError,
+    this.onPrinted,
+    this.onPrintError,
+    this.onShared,
+    this.scrollViewDecoration,
+    this.pdfPreviewPageDecoration,
+    this.pdfFileName,
+    this.useActions = true,
+    this.pages,
+    this.dynamicLayout = true,
+    this.shareActionExtraBody,
+    this.shareActionExtraSubject,
+    this.shareActionExtraEmails,
+    this.previewPageMargin,
+    this.padding,
+    this.shouldRepaint = false,
+    this.loadingWidget,
+    this.onPageFormatChanged,
+    this.dpi,
+    required CustomPdfPagesBuilder pagesBuilder,
+  })  : _pagesBuilder = pagesBuilder,
+        super(key: key);
 
 
   static const _defaultPageFormats = <String, PdfPageFormat>{
   static const _defaultPageFormats = <String, PdfPageFormat>{
     'A4': PdfPageFormat.a4,
     'A4': PdfPageFormat.a4,
@@ -163,6 +223,10 @@ class PdfPreview extends StatefulWidget {
   /// If not provided, this value is calculated.
   /// If not provided, this value is calculated.
   final double? dpi;
   final double? dpi;
 
 
+  /// clients can pass this builder to render
+  /// their own pages.
+  final CustomPdfPagesBuilder? _pagesBuilder;
+
   @override
   @override
   _PdfPreviewState createState() => _PdfPreviewState();
   _PdfPreviewState createState() => _PdfPreviewState();
 }
 }
@@ -331,6 +395,7 @@ class _PdfPreviewState extends State<PdfPreview> {
                 previewPageMargin: widget.previewPageMargin,
                 previewPageMargin: widget.previewPageMargin,
                 scrollViewDecoration: widget.scrollViewDecoration,
                 scrollViewDecoration: widget.scrollViewDecoration,
                 shouldRepaint: widget.shouldRepaint,
                 shouldRepaint: widget.shouldRepaint,
+                pagesBuilder: widget._pagesBuilder,
                 dpi: widget.dpi,
                 dpi: widget.dpi,
               );
               );
             }),
             }),

@@ -38,7 +38,7 @@ mixin PdfPreviewRaster on State<PdfPreviewCustom> {
   PdfPageFormat get pageFormat => widget.pageFormat;
   PdfPageFormat get pageFormat => widget.pageFormat;
 
 
   /// Resulting pages
   /// Resulting pages
-  final pages = <PdfPreviewPage>[];
+  final pages = <PdfPreviewPageData>[];
 
 
   /// Printing subsystem information
   /// Printing subsystem information
   PrintingInfo? info;
   PrintingInfo? info;
@@ -167,23 +167,18 @@ mixin PdfPreviewRaster on State<PdfPreviewCustom> {
           _rastering = false;
           _rastering = false;
           return;
           return;
         }
         }
-
         if (pages.length <= pageNum) {
         if (pages.length <= pageNum) {
-          pages.add(PdfPreviewPage(
+          pages.add(PdfPreviewPageData(
             image: MemoryImage(await page.toPng()),
             image: MemoryImage(await page.toPng()),
             width: page.width,
             width: page.width,
             height: page.height,
             height: page.height,
-            pdfPreviewPageDecoration: widget.pdfPreviewPageDecoration,
-            pageMargin: widget.previewPageMargin,
           ));
           ));
         } else {
         } else {
           pages[pageNum].image.evict();
           pages[pageNum].image.evict();
-          pages[pageNum] = PdfPreviewPage(
+          pages[pageNum] = PdfPreviewPageData(
             image: MemoryImage(await page.toPng()),
             image: MemoryImage(await page.toPng()),
             width: page.width,
             width: page.width,
             height: page.height,
             height: page.height,
-            pdfPreviewPageDecoration: widget.pdfPreviewPageDecoration,
-            pageMargin: widget.previewPageMargin,
           );
           );
         }
         }
 
 

@@ -6,7 +6,7 @@ description: >
 homepage: https://github.com/DavBfr/dart_pdf/tree/master/printing
 homepage: https://github.com/DavBfr/dart_pdf/tree/master/printing
 repository: https://github.com/DavBfr/dart_pdf
 repository: https://github.com/DavBfr/dart_pdf
 issue_tracker: https://github.com/DavBfr/dart_pdf/issues
 issue_tracker: https://github.com/DavBfr/dart_pdf/issues
-version: 5.9.4
+version: 5.10.0
 
 
 environment:
 environment:
   sdk: ">=2.12.0 <3.0.0"
   sdk: ">=2.12.0 <3.0.0"