WkHtml2Image 1.0.0

.NET Core 3.1 This package targets .NET Core 3.1. The package is compatible with this framework or higher. 
dotnet add package WkHtml2Image --version 1.0.0
                    


                    

                
NuGet\Install-Package WkHtml2Image -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="WkHtml2Image" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="WkHtml2Image" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="WkHtml2Image" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add WkHtml2Image --version 1.0.0
                    


                    

                
#r "nuget: WkHtml2Image, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package WkHtml2Image@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=WkHtml2Image&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=WkHtml2Image&version=1.0.0
                    


                            Install as a Cake Tool

WkHtml2Image

Html to Image converter (based on wkhtmltox)

Install

> Install-Package WkHtml2Image

Using on API Controller

Startup.cs
public void ConfigureServices(IServiceCollection services)
{
    //....
    services.AddWkHtmlToImage(options => { options.UseGraphics = false; });
    //....
}
Controller class file
private readonly IWkHtml2ImageConverter _wkHtml2ImageConverter;

public TestController(IWkHtml2ImageConverter wkHtml2ImageConverter)
{
    _wkHtml2ImageConverter = wkHtml2ImageConverter;
}
Using with URL
var result = await _wkHtml2ImageConverter.Convert(new Uri("http://www.google.com/"), ImageFormat.Png);
Using with HTML Content
var sampleContent = @"<html>
                  <head></head>
                  <body>
                      <div style='margin: 0 auto; width: 400px; height:400px; background-color:yellow; text-align:center; font-size:18pt;'>Hello</div>
                  </body>
                 </html>";

var result = await _wkHtml2ImageConverter.Convert(sampleContent, ImageFormat.Png);

You can also use ConvertionSetting class for more detailed configurations listed below;

  • Cropping(Top, Left, Width, Height)
  • Transparancy
  • Screen Width & Height
  • Quality

If you want to use diffrent wkhtml2x libraries you can download here(https://wkhtmltopdf.org/downloads.html). You should add libraries in your project like these;

/SolutionFolder
   /ProjectFolder
     /lib
       /32 Bit
          /libwkhtmltox.dll
          /libwkhtmltox.dylib
          /libwkhtmltox.so
       /64 Bit
          /libwkhtmltox.dll
          /libwkhtmltox.dylib
          /libwkhtmltox.so
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp3.1 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 2,458 5/20/2021