eone.Spectre.Console.TemplateColumn 1.1.0

eone.Spectre.Console.TemplateColumn

A message template-based progress column for Spectre.Console.

What is this?

TemplateColumn allows you to render progress bars using Serilog's message template syntax. Instead of manually composing multiple progress columns, you can use a familiar string template format to define how your progress should look.

This solves the problem of creating custom, flexible progress displays without writing custom ProgressColumn implementations for each variation.

Installation

dotnet add package eone.Spectre.Console.TemplateColumn

Quick Start

using Spectre.Console;
using eone.Spectre.Console.TemplateColumn;

// Basic usage with auto-discovered columns
AnsiConsole
    .Progress()
    .Columns(new TemplateColumn("{Description} {ProgressBarColumn} {Percentage}%", true))
    .Start(ctx =>
    {
        var task = ctx.AddTask("Downloading");
        while (!task.IsFinished)
        {
            task.Increment(1);
            Thread.Sleep(10);
        }
    }); 

Usage

Constructor Options

TemplateColumn provides two constructors:

1. Auto-discover columns

new TemplateColumn("{Description}: {ProgressBarColumn}", autoDiscoverColumns: true)

This scans all loaded assemblies for ProgressColumn subclasses and makes them available in your template.

2. Explicit columns

new TemplateColumn(
    "{Description}: {ProgressBarColumn}",
    new ProgressBarColumn(),
    new PercentageColumn(),
    new TaskDescriptionColumn()
)

Pass columns explicitly for more controlled behavior.

Column Templates

Templates use Serilog's message template syntax. You can include ProgressTask properties and columns:

"{Value}"                  // Task value
"{Description,-20}"        // Left-align, 20 chars wide
"{Percentage,5}%"          // Right-align, 5 chars wide, followed by %
"{ProgressBarColumn,-20}"  // Columns can be aligned too
"{Percentage:P0}"          // Format percentage (e.g., 45%)
"{MaxValue:N1}"            // Format max value with 1 decimal place (e.g., 100.0)

Note: Alignment works for both properties and columns. Format specifiers only work with properties.

Note: Spectre.Console markup (e.g., [bold], [red]) is not currently supported in templates.

Examples

Simple progress with percentage

new TemplateColumn("{Description} [{ProgressBarColumn}] {Percentage}%", true)

Detailed status

new TemplateColumn("{Description,-30} {Value}/{MaxValue} {SpinnerColumn}", true)

Custom layout with explicit columns

new TemplateColumn(
    "{Description}: {ProgressBarColumn} {Percentage:P0}",
    new ProgressBarColumn(),
    new PercentageColumn()
)

Requirements

• .NET 10.0+
• Spectre.Console 0.54.0+
• Serilog (for message template parsing)

License

MIT License - see LICENSE