BlazorFast.ImageSharp.TableGenerator 1.0.1

BlazorFast.ImageSharp.TableGenerator

A powerful table rendering library for SixLabors.ImageSharp that generates beautiful table images with an HTML/CSS-inspired fluent API.

✨ Features

• 🎨 Rich Styling — Full control over colors, borders, fonts, padding, and alignment
• 📊 Advanced Layout — Row/column spans, auto-sizing columns, text wrapping
• 🎯 CSS-Like API — Familiar fluent API with style cascading
• 📑 Section Support — Header, body, and footer sections
• 🦓 Zebra Striping — Built-in alternating row styles
• ⚡ High Performance — Font caching and optimized rendering
• 🚀 Extension Methods — Quick table generation from collections with built-in themes

📦 Installation

dotnet add package BlazorFast.ImageSharp.TableGenerator

🚀 Quick Start

Builder API

using BlazorFast.ImageSharp.TableGenerator;

using BlazorFast.ImageSharp.TableGenerator.Builders;

var table = TableBuilder.Create()
    .Body(body => body
        .Row("Name", "Age", "City")
        .Row("John Doe", "30", "New York")
        .Row("Jane Smith", "25", "Los Angeles"))
    .Build();

var image = table.Render();
image.SaveAsPng("table.png");

Extension Method (Fastest)

using BlazorFast.ImageSharp.TableGenerator.Extensions;

public record Person(string Name, int Age, string City);

var people = new[]
{
    new Person("Alice", 30, "New York"),
    new Person("Bob", 25, "San Francisco"),
    new Person("Charlie", 35, "Seattle")
};

// Generate table image directly from collection
var image = people.ToTableImage();
image.SaveAsPng("people.png");

📸 Style Showcase

Condensed | Cozy | Roomy

Minimalist | Dark Mode

💼 Real-World Examples

Financial Data with Color-Coded Values

Analytics Dashboard with Footer Totals

📚 Core Examples

Styled Table with Header

var table = TableBuilder.Create()
    .DefaultFont("Arial", 14)
    .CellPadding(12)
    .Border(2)
    .Style(s => s.Background("#f8f9fa").BorderColor("#dee2e6"))
    .Header(header => header
        .Style(s => s.Background("#007bff").TextColor("#ffffff").Bold())
        .Row("Product", "Price", "Stock"))
    .Body(body => body
        .Row("Laptop", "$999", "15")
        .Row("Mouse", "$25", "50"))
    .Build();

Alternating Rows

var table = TableBuilder.Create()
    .Body(body => body
        .Row("001", "Alice", "Engineering", "$75,000")
        .Row("002", "Bob", "Marketing", "$65,000"))
    .AlternateRows(
        even => even.Background("#ffffff"),
        odd => odd.Background("#f8f9fa"))
    .Build();

Column Spans

var table = TableBuilder.Create()
    .Body(body => body
        .Row(row => row
            .Cell("Q1 Report", cell => cell.ColSpan(3).Style(s => s.Bold())))
        .Row("Month", "Revenue", "Growth"))
    .Build();

🚀 Extension Methods API

The extension methods provide the fastest way to generate tables from any collection of objects.

Basic Usage

using SixLabors.ImageSharp.TableGenerator.Extensions;

var data = new[] { /* your objects */ };
var image = data.ToTableImage();

Built-in Themes

// Light theme (default)
var lightTable = data.ToTableImage();

// Dark theme
var darkTable = data.ToTableImage(new TableGeneratorOptions 
{ 
    Theme = ThemeMode.Dark 
});

// Minimal theme (no background colors)
var minimalTable = data.ToTableImage(new TableGeneratorOptions 
{ 
    Theme = ThemeMode.Minimal 
});

// Compact theme (reduced padding)
var compactTable = data.ToTableImage(new TableGeneratorOptions 
{ 
    Theme = ThemeMode.Compact 
});

Advanced Options

var options = new TableGeneratorOptions
{
    // Theme selection
    Theme = ThemeMode.Dark,
    
    // Filter properties to include
    PropertyFilter = prop => prop.Name != "InternalId",
    
    // Customize column ordering
    PropertyOrder = new[] { "Name", "Age", "Email" },
    
    // Format property names (headers)
    PropertyNameFormatter = prop => prop.Name.ToUpper(),
    
    // Format cell values
    ValueFormatter = val => val?.ToString() ?? "N/A",
    
    // Hide headers
    IncludeHeaders = false
};

var image = data.ToTableImage(options);

Real-World Extension Examples

Example 1: Filter Sensitive Properties

public record Employee(string Name, string Email, string Password, decimal Salary);

var employees = GetEmployees();

// Exclude sensitive fields
var image = employees.ToTableImage(new TableGeneratorOptions
{
    PropertyFilter = prop => prop.Name != "Password" && prop.Name != "Salary"
});

Example 2: Custom Column Order and Formatting

var options = new TableGeneratorOptions
{
    Theme = ThemeMode.Dark,
    PropertyOrder = new[] { "Country", "City", "Population" },
    PropertyNameFormatter = prop => prop.Name.ToUpper(),
    ValueFormatter = val => val is int num ? num.ToString("N0") : val?.ToString()
};

var cities = GetCities();
var image = cities.ToTableImage(options);

Example 3: Data Export Without Headers

// Generate compact data table without headers
var image = transactions.ToTableImage(new TableGeneratorOptions
{
    Theme = ThemeMode.Compact,
    IncludeHeaders = false
});

🎯 API Reference

TableBuilder Methods

StyleBuilder Methods

CellBuilder Methods

Extension Methods

TableGeneratorOptions Properties

🏗️ Architecture

The library follows a clean layered architecture:

1. Builder API — Fluent interface for constructing tables
2. Extension API — Reflection-based table generation from collections
3. Model Layer — Immutable records representing table structure
4. Layout Engine — Grid positioning, span resolution, and text wrapping
5. Rendering Engine — ImageSharp.Drawing integration with style cascading

⚡ Performance

• Font Caching — Fonts are cached by family, size, and style to avoid repeated I/O
• Lazy Measurement — Text is measured only when necessary during layout
• Optimized Text Wrapping — Greedy algorithm with character-level fallback
• Modern C# Patterns — Uses spans, records, and value types for efficiency
• Zero Allocation Paths — Critical paths avoid unnecessary allocations

📄 License

Apache License 2.0

🤝 Contributing

Contributions are welcome!

1. Fork the repository
2. Create a feature branch
3. Make your changes with tests
4. Submit a pull request

Please ensure all tests pass and code follows existing patterns.

🙏 Credits

Built on:

• SixLabors.ImageSharp — Core image processing
• SixLabors.ImageSharp.Drawing — Drawing primitives
• SixLabors.Fonts — Font loading and text measurement

Made with ❤️ for .NET