Lyo.Barcode 2.0.1

Lyo.Barcode

Contracts for generating and decoding barcodes: IBarcodeService, request and options models, plus BarcodeBuilder. Companion packages such as Lyo.Barcode.Native own concrete rendering and symbology.

Examples

First generate call

using Lyo.Barcode;
using Lyo.Barcode.Models;

// Assume IBarcodeService is registered (e.g. Native implementation).
IBarcodeService barcodes = /* ... */;

var result = await barcodes.GenerateAsync(
    "HELLO-128",
    BarcodeSymbology.Code128,
    new BarcodeOptions { Format = BarcodeFormat.Svg, ModuleWidthPixels = 2, BarHeightPixels = 64 });

if (result.IsSuccess && result is BarcodeResult br && br.ImageBytes != null)
    await File.WriteAllBytesAsync("out.svg", br.ImageBytes);

Build with the fluent API

var (data, sym, opts) = BarcodeBuilder.New()
    .WithData("SKU-12345")
    .WithSymbology(BarcodeSymbology.Code128)
    .WithFormat(BarcodeFormat.Bmp)
    .WithModuleWidthPixels(2)
    .WithBarHeightPixels(96)
    .WithShowHumanReadableTextBelow(true)
    .WithShowBorder(true)
    .WithBorderWidthPixels(4)
    .WithBorderColorHex("#000000")
    .Build();

await barcodes.GenerateAsync(data, sym, opts);

Read a barcode from image bytes

var read = await barcodes.ReadFromImageAsync(pngBytes);
if (read.IsSuccess && read.Data != null)
    Console.WriteLine(read.Data.Text);

Public types

How the border is drawn

If BarcodeOptions.ShowBorder is true, Lyo.Barcode.Native grows width and height by 2 × BorderWidthPixels and paints a filled frame in BorderColorHex around the symbol. The usual background and bars stay the same inside that inset. BarcodeServiceOptions.MinBorderWidthPixels / MaxBorderWidthPixels clamp the width (defaults 1 to 64). When the border is on, BorderColorHex must be #RGB or #RRGGBB.

Binding from configuration

Implementations can bind BarcodeServiceOptions from the BarcodeService section (see BarcodeServiceOptions.SectionName).

Dependencies

Generated from ProjectReference / PackageReference (same model as docs/Lyo.ProjectGraph.html).

• Lyo.Exceptions (direct, lyo)
• Lyo.Metrics (direct, lyo)
• Lyo.Result (direct, lyo)
• Microsoft.Extensions.Logging.Abstractions 10.0.5 (direct, microsoft)