HTML/CSS to Image

.Net / C# Packages

This repo contains a .NET client for the HTML/CSS to Image API, allowing you to generate images from HTML/CSS content directly from your .NET applications, as well as helper packages for integrating with ASP.NET Core and Blazor.

Quick Start

1) Add the package to your project:

dotnet add package HtmlCssToImage

2) Create a client:

var options = new HtmlCssToImageOptions("api-id", "api-key");
var http = new HttpClient();
var client = new HtmlCssToImageClient(http, options);

You can also load the credentials from HCTI_API_ID and HCTI_API_KEY:

var options = HtmlCssToImageOptions.FromEnvironmentVariables();
var http = new HttpClient();
var client = new HtmlCssToImageClient(http, options);

Pass custom variable names when your application uses different names:

var options = HtmlCssToImageOptions.FromEnvironmentVariables(
    "MY_HCTI_API_ID",
    "MY_HCTI_API_KEY");

3) Generate an image!

var html_request = new CreateHtmlCssImageRequest()
{
    Html = "<h1>Hello World</h1>",
    Css = "h1 { color: green; }",
    ViewportWidth = 400,
    ViewportHeight = 200
};

using var html_image = await client.CreateImageAsync(html_request);

if(html_image.Success)
{
    Console.WriteLine(html_image.Response.Url);
}else{
    Console.WriteLine(html_image.ErrorDetails.Message);
}

More Details

Check out the package READMEs for more details on integrating:

Package	Description	Readme	Nuget
HtmlCssToImage	Core library for working with the API
HtmlCssToImage.DependencyInjection	Dependency injection helpers for ASP.NET Core
HtmlCssToImage.Blazor	Blazor component for generating Open Graph image meta tags
HtmlCssToImage.TagHelpers	ASP.NET Core TagHelpers for generating Open Graph image meta tags

---

Important

Check out the HTML/CSS To Image Docs for more details on the API's capabilities.

Tip

Get started for free at htmlcsstoimage.com.