PinataLabs.Typography 0.1.0

PinataLabs.Typography

PinataLabs.Typography is a cross-platform .NET library that loads fonts and lays out and measures text. It is written in C# and has no native dependencies.

Read the documentation for guides, the API reference and troubleshooting.

Features

• Read font descriptions: name, family, subfamily and other string metadata.
• Load OpenType fonts with CFF1, CFF2 and TrueType outlines.
• Load TrueType fonts and TrueType collections (.ttc).
• Load WOFF and WOFF2 fonts.
• Load all compatible fonts installed on the machine (Windows, Linux and macOS).
• Line breaking based on UAX #14.
• Left-to-right, right-to-left and bidirectional text.
• Ligatures, and the OpenType glyph substitution (GSUB) and glyph positioning (GPOS) features.
• Measure the size, advance and bounds of laid-out text.

Install

dotnet add package PinataLabs.Typography

Add --prerelease while only pre-release versions are published. The library targets net8.0, net10.0 and net11.0.

Quick start

Read a font description

using System.Globalization;
using PinataLabs.Typography;

FontDescription description = FontDescription.LoadDescription("path/to/font.ttf");
string name = description.FontName(CultureInfo.InvariantCulture);

Load fonts into a collection

using PinataLabs.Typography;

FontCollection fonts = new();
FontFamily family = fonts.Add("path/to/font.ttf");
fonts.Add("path/to/other-font.woff2");

Font font = family.CreateFont(12);

Use a system font

using PinataLabs.Typography;

if (SystemFonts.TryGet("Arial", out FontFamily arial))
{
    Font font = arial.CreateFont(16);
}

Measure text

using PinataLabs.Typography;

TextOptions options = new(font);
FontRectangle size = TextMeasurer.MeasureSize("Hello, world!", options);

Contributing

Read the contribution guide before you open an issue or a pull request. Report bugs and suggest changes in GitHub Issues. This project follows the Code of Conduct.

License and attribution

PinataLabs.Typography is licensed under the Apache License, Version 2.0.

This project is derived from SixLabors.Fonts, Copyright (c) Six Labors, licensed under the Apache License, Version 2.0. It was forked at commit 32bef429 and has been modified by PinataLabs. It also includes build files from SixLabors SharedInfrastructure. PinataLabs.Typography is not affiliated with or endorsed by Six Labors. See NOTICE for the full attribution.