feat(Html2Pdf): add PdfOptions parameter (#632)

* refactor: 消除警告信息

* feat: 增加 PdfOptions 支持

* chore: bump version 9.0.6-beta01

Author: ArgoZhang

src/components/BootstrapBlazor.Html2Pdf/BootstrapBlazor.Html2Pdf.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk.Razor">
 
   <PropertyGroup>
-    <Version>9.0.4</Version>
+    <Version>9.0.6-beta01</Version>
   </PropertyGroup>
 
   <PropertyGroup>
@@ -10,7 +10,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="BootstrapBlazor" Version="$(BBVersion)" />
+    <PackageReference Include="BootstrapBlazor" Version="9.11.5-beta07" />
     <PackageReference Include="PuppeteerSharp" Version="20.2.4" />
   </ItemGroup>
 

src/components/BootstrapBlazor.Html2Pdf/Extensions/ServiceCollectionExtensions.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Argo Zhang (argo@163.com). All rights reserved.
+// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 // Website: https://www.blazor.zone or https://argozhang.github.io/
 

src/components/BootstrapBlazor.Html2Pdf/Services/DefaultPdfService.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Argo Zhang (argo@163.com). All rights reserved.
+// Copyright (c) BootstrapBlazor & Argo Zhang (argo@live.ca). All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 // Website: https://www.blazor.zone or https://argozhang.github.io/
 
@@ -19,18 +19,15 @@ class DefaultPdfService(ILogger<DefaultPdfService> logger) : IHtml2Pdf
     /// </summary>
     public IWebProxy? WebProxy { get; set; }
 
-    /// <summary>
-    /// <inheritdoc/>
-    /// </summary>
-    public async Task<byte[]> PdfDataAsync(string url)
+    public async Task<byte[]> PdfDataAsync(string url, PdfOptions? options = null)
     {
         try
         {
             await using var browser = await LaunchBrowserAsync();
             await using var page = await browser.NewPageAsync();
 
             await page.GoToAsync(url);
-            return await page.PdfDataAsync();
+            return await page.PdfDataAsync(GetOptions(options));
         }
         catch (Exception ex)
         {
@@ -39,18 +36,15 @@ public async Task<byte[]> PdfDataAsync(string url)
         }
     }
 
-    /// <summary>
-    /// <inheritdoc/>
-    /// </summary>
-    public async Task<Stream> PdfStreamAsync(string url)
+    public async Task<Stream> PdfStreamAsync(string url, PdfOptions? options = null)
     {
         try
         {
             await using var browser = await LaunchBrowserAsync();
             await using var page = await browser.NewPageAsync();
             await page.GoToAsync(url);
 
-            return await page.PdfStreamAsync();
+            return await page.PdfStreamAsync(GetOptions(options));
         }
         catch (Exception ex)
         {
@@ -59,13 +53,7 @@ public async Task<Stream> PdfStreamAsync(string url)
         }
     }
 
-    /// <summary>
-    /// Export method
-    /// </summary>
-    /// <param name="html">html raw string</param>
-    /// <param name="links"></param>
-    /// <param name="scripts"></param>
-    public async Task<byte[]> PdfDataFromHtmlAsync(string html, IEnumerable<string>? links = null, IEnumerable<string>? scripts = null)
+    public async Task<byte[]> PdfDataFromHtmlAsync(string html, IEnumerable<string>? links = null, IEnumerable<string>? scripts = null, PdfOptions? options = null)
     {
         try
         {
@@ -76,7 +64,7 @@ public async Task<byte[]> PdfDataFromHtmlAsync(string html, IEnumerable<string>?
             await AddStyleTagAsync(page, links);
             await AddScriptTagAsync(page, scripts);
 
-            return await page.PdfDataAsync();
+            return await page.PdfDataAsync(GetOptions(options));
         }
         catch (Exception ex)
         {
@@ -85,13 +73,7 @@ public async Task<byte[]> PdfDataFromHtmlAsync(string html, IEnumerable<string>?
         }
     }
 
-    /// <summary>
-    /// Export method
-    /// </summary>
-    /// <param name="html">html raw string</param>
-    /// <param name="links"></param>
-    /// <param name="scripts"></param>
-    public async Task<Stream> PdfStreamFromHtmlAsync(string html, IEnumerable<string>? links = null, IEnumerable<string>? scripts = null)
+    public async Task<Stream> PdfStreamFromHtmlAsync(string html, IEnumerable<string>? links = null, IEnumerable<string>? scripts = null, PdfOptions? options = null)
     {
         try
         {
@@ -102,7 +84,7 @@ public async Task<Stream> PdfStreamFromHtmlAsync(string html, IEnumerable<string
             await AddStyleTagAsync(page, links);
             await AddScriptTagAsync(page, scripts);
 
-            return await page.PdfStreamAsync();
+            return await page.PdfStreamAsync(GetOptions(options));
         }
         catch (Exception ex)
         {
@@ -111,6 +93,14 @@ public async Task<Stream> PdfStreamFromHtmlAsync(string html, IEnumerable<string
         }
     }
 
+    private static PuppeteerSharp.PdfOptions GetOptions(PdfOptions? options)
+    {
+        return options == null ? new PuppeteerSharp.PdfOptions() : new PuppeteerSharp.PdfOptions
+        {
+            Landscape = options.Landscape
+        };
+    }
+
     private static async Task AddStyleTagAsync(IPage page, IEnumerable<string>? links = null)
     {
         var styles = new List<string>();
@@ -161,13 +151,16 @@ private async Task<IBrowser> LaunchBrowserAsync()
 
     private void Log(Exception? exception, string? message, params object?[] args)
     {
-        if (args.Length != 0)
-        {
-            logger.LogInformation(exception, "{Message} | Args: {Args}", message, args);
-        }
-        else
+        if (logger.IsEnabled(LogLevel.Information))
         {
-            logger.LogInformation(exception, "{Message}", message);
+            if (args.Length != 0)
+            {
+                logger.LogInformation(exception, "{Message} | Args: {Args}", message, args);
+            }
+            else
+            {
+                logger.LogInformation(exception, "{Message}", message);
+            }
         }
     }
 }