SolarBlazorDocs.Abstractions 10.0.0

SolarBlazorDocs.Abstractions

Núcleo de SolarBlazorDocs: convierte cualquier componente Blazor en un documento renderizándolo a HTML en memoria y delegando la conversión en un motor intercambiable (patrón Strategy). Este paquete contiene los contratos, las opciones, el renderizador Blazor→HTML, el servicio orquestador, los resolvers de motores y componentes auxiliares.

Los motores concretos se distribuyen aparte:

• SolarBlazorDocs.Pdf — motor PDF (Chromium/PuppeteerSharp).
• SolarBlazorDocs.Excel — motor Excel (ClosedXML).

Instalación

dotnet add package SolarBlazorDocs.Abstractions

Por sí solo no trae ningún motor: registra al menos uno (ver los paquetes .Pdf / .Excel).

Registro

using SolarBlazorDocs.Extensions;

builder.Services.AddSolarBlazorDocs(docs =>
{
    docs.AddPuppeteerEngine();      // requiere SolarBlazorDocs.Pdf
    docs.AddClosedXmlExcelEngine(); // requiere SolarBlazorDocs.Excel
});

AddSolarBlazorDocs registra el renderizador, los resolvers y el servicio principal IBlazorDocsService. Los motores se añaden en el Action<SolarBlazorDocsBuilder>.

Servicio principal: IBlazorDocsService

// Componente Blazor -> PDF
byte[] pdf = await docs.ComponentToPdfAsync<MiComponente>(parametros, pdfOptions);

// Componente Blazor -> Excel (a partir de sus tablas)
byte[] xlsx = await docs.ComponentToExcelAsync<MiComponente>(parametros, excelOptions);

// Solo el HTML (depuración / previsualización)
string html = await docs.ComponentToHtmlAsync(typeof(MiComponente), parametros, culture: "es-ES");

// A partir de un HTML ya preparado, sin pasar por Blazor
byte[] pdf2  = await docs.HtmlToPdfAsync(html, pdfOptions);
byte[] xlsx2 = await docs.HtmlToExcelAsync(html, excelOptions);

parametros es un IDictionary<string, object?> con los [Parameter] del componente (p. ej. ["Model"] = model).

Opciones

PdfRenderOptions:

ExcelRenderOptions: SheetName, FirstRowAsHeader, AutoFitColumns, IncludeAllTables, HeaderBackgroundColor, Culture, Engine.

Internacionalización (i18n)

Al indicar Culture, el renderizador fija CultureInfo.CurrentCulture/CurrentUICulture durante el render: afecta al formato de fechas y números y a la localización por IStringLocalizer (.resx). Así, el mismo componente genera el documento en el idioma solicitado.

await docs.ComponentToPdfAsync<Factura>(p, new PdfRenderOptions { Culture = "en-US" });

Motores personalizados (patrón Strategy)

Un motor implementa IPdfEngine o IExcelEngine y se identifica por Name:

public sealed class MiMotorPdf : IPdfEngine
{
    public string Name => "mimotor";
    public Task<byte[]> ConvertHtmlToPdfAsync(string html, PdfRenderOptions o, CancellationToken ct = default)
        => /* tu conversión HTML -> PDF */;
}

builder.Services.AddSolarBlazorDocs(docs => docs.AddEngine<MiMotorPdf>());
// y se usa con: new PdfRenderOptions { Engine = "mimotor" }

El IPdfEngineResolver / IExcelEngineResolver selecciona el motor por nombre en tiempo de ejecución.

Componentes incluidos

• DocumentLayout — envuelve tu contenido en un documento HTML completo con estilos base de impresión, orientación e idioma (<html lang>). Opcional.
• DocumentActions — barra de acciones reutilizable (selector de idioma y orientación, imprimir, descargar PDF/Excel) con la lógica de descarga encapsulada y su propio módulo JS. Parametrizable y opcional:

<DocumentActions PdfComponentType="typeof(FacturaDocumento)"
                 ExcelComponentType="typeof(FacturaContenido)"
                 Parameters="DocParams"
                 FileName="factura"
                 @bind-Culture="_culture"
                 @bind-Orientation="_orientation" />

Piezas principales

Requisitos

• .NET 10