SixLabors.Fonts 1.0.0-beta16

Prefix Reserved
This is a prerelease version of SixLabors.Fonts.
There is a newer version of this package available.
See the version list below for details.
dotnet add package SixLabors.Fonts --version 1.0.0-beta16                
NuGet\Install-Package SixLabors.Fonts -Version 1.0.0-beta16                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SixLabors.Fonts" Version="1.0.0-beta16" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SixLabors.Fonts --version 1.0.0-beta16                
#r "nuget: SixLabors.Fonts, 1.0.0-beta16"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install SixLabors.Fonts as a Cake Addin
#addin nuget:?package=SixLabors.Fonts&version=1.0.0-beta16&prerelease

// Install SixLabors.Fonts as a Cake Tool
#tool nuget:?package=SixLabors.Fonts&version=1.0.0-beta16&prerelease                

<h1 align="center">

<img src="https://raw.githubusercontent.com/SixLabors/Branding/master/icons/fonts/sixlabors.fonts.512.png" alt="SixLabors.Fonts" width="256"/> <br/> SixLabors.Fonts </h1>

<div align="center">

Build Status codecov License: Apache 2.0

GitHub issues GitHub stars GitHub forks

</div>

SixLabors.Fonts is a new cross-platform font loading and drawing library.

License

Support Six Labors

Support the efforts of the development of the Six Labors projects.

Documentation

  • Detailed documentation for the Fonts API is available. This includes additional conceptual documentation to help you get started.
  • Our Samples Repository is also available containing buildable code samples demonstrating common activities.

Questions

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information, see the .NET Foundation Code of Conduct.

Installation

Install stable releases via Nuget; development releases are available via MyGet.

Package Name Release (NuGet) Nightly (MyGet)
SixLabors.Fonts NuGet MyGet

Manual build

If you prefer, you can compile Fonts yourself (please do and help!)

Alternatively, you can work from command line and/or with a lightweight editor on both Linux/Unix and Windows:

To clone Fonts locally, click the "Clone in [YOUR_OS]" button above or run the following git commands:

git clone https://github.com/SixLabors/Fonts

If working with Windows please ensure that you have enabled log file paths in git (run as Administrator).

git config --system core.longpaths true

Submodules

This repository contains git submodules. To add the submodules to the project, navigate to the repository root and type:

git submodule update --init --recursive

Features

  • Reading font description (name, family, subname etc plus other string metadata).
  • Loading True type fonts.
  • Loading WOFF fonts.
  • Loading WOFF2 fonts.
  • Load all compatible fonts from local machine store.
  • Support for rendering left to right, right to left and bidirectional text.
  • Support for ligatures.
  • Support for advanced OpenType features glyph substitution (GSUB) and glyph positioning (GPOS)
Limitations

We currently only support otf and woff/woff2 fonts with True Type outlines.

API Examples

Read font description

FontDescription description = null;
using(var fs = File.OpenRead("Font.ttf")){
    description = FontDescription.Load(fs); // once it has loaded the data the stream is no longer required and can be disposed of
}

string name = description.FontName(CultureInfo.InvariantCulture);

Populating a font collection

FontCollection fonts = new FontCollection();
FontFamily font1 = fonts.Add("./path/to/font1.ttf");
FontFamily font2 = fonts.Add("./path/to/font2.woff");

How can you help?

Please... Spread the word, contribute algorithms, submit performance improvements, unit tests.

Projects using SixLabors.Fonts

The SixLabors.Fonts Team

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 is compatible. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (90)

Showing the top 5 NuGet packages that depend on SixLabors.Fonts:

Package Downloads
ClosedXML

See release notes https://github.com/ClosedXML/ClosedXML/releases/tag/0.104.2 ClosedXML is a .NET library for reading, manipulating and writing Excel 2007+ (.xlsx, .xlsm) files. It aims to provide an intuitive and user-friendly interface to dealing with the underlying OpenXML API.

NPOI

.NET port of Apache POI

SixLabors.ImageSharp.Drawing

An extension to ImageSharp that allows the drawing of images, paths, and text.

PdfSharpCore

PdfSharp for .NET Core PdfSharpCore is a partial port of PdfSharp.Xamarin for .NET Core Additionally MigraDoc has been ported as well (from version 1.32). Images have been implemented with ImageSharp from https://www.nuget.org/packages/SixLabors.ImageSharp

SixLabors.Shapes.Text

Allows generating glyphs for text and a fonts for manipulation using SixLabors.Shapes

GitHub repositories (26)

Showing the top 5 popular GitHub repositories that depend on SixLabors.Fonts:

Repository Stars
nissl-lab/npoi
a .NET library that can read/write Office formats without Microsoft Office installed. No COM+, no interop.
ClosedXML/ClosedXML
ClosedXML is a .NET library for reading, manipulating and writing Excel 2007+ (.xlsx, .xlsm) files. It aims to provide an intuitive and user-friendly interface to dealing with the underlying OpenXML API.
cyanfish/naps2
Scan documents to PDF and more, as simply as possible.
peachpiecompiler/peachpie
PeachPie - the PHP compiler and runtime for .NET and .NET Core
Webreaper/Damselfly
Damselfly is a server-based Photograph Management app. The goal of Damselfly is to index an extremely large collection of images, and allow easy search and retrieval of those images, using metadata such as the IPTC keyword tags, as well as the folder and file names. Damselfly includes support for object/face detection.
Version Downloads Last updated
2.0.7 4,750 12/16/2024
2.0.6 68,186 10/30/2024
2.0.5 578 10/30/2024
2.0.4 1,213,120 6/29/2024
2.0.3 1,027,490 3/28/2024
2.0.2 219,046 2/15/2024
2.0.1 1,254,445 12/1/2023
2.0.0 1,478,539 9/15/2023
1.0.1 3,977,146 9/15/2023
1.0.0 20,365,098 8/11/2023
1.0.0-beta19 6,706,165 10/30/2022
1.0.0-beta18 16,222,170 7/22/2022
1.0.0-beta17 8,391,312 5/18/2022
1.0.0-beta16 3,243,779 2/9/2022
1.0.0-beta15 1,345,725 5/20/2021
1.0.0-beta0013 7,897,809 6/18/2020
1.0.0-beta0012 66,501 6/8/2020
1.0.0-beta0011 352,009 5/13/2020
1.0.0-beta0009 2,087,075 9/1/2019
1.0.0-beta0008 1,096,984 1/25/2019
1.0.0-beta0007 784,689 8/5/2018
1.0.0-beta0006 8,325 6/7/2018
1.0.0-beta0005 2,953,090 5/24/2018
1.0.0-beta0004 3,619 3/27/2018
1.0.0-beta0003 143,419 11/17/2017
1.0.0-beta0002 15,914 9/16/2017
1.0.0-beta0001 28,054 9/13/2017
0.1.0-alpha0016 14,517 7/16/2017
0.1.0-alpha0015 1,187 6/22/2017
0.1.0-alpha0014 73,897 6/13/2017
0.1.0-alpha0013 11,622 6/6/2017
0.1.0-alpha0012 1,198 6/4/2017
0.1.0-alpha0011 243,915 5/30/2017
0.1.0-alpha0010 27,132 5/2/2017
0.1.0-alpha0009 1,143 4/21/2017
0.1.0-alpha0008 2,352 4/17/2017
0.1.0-alpha0007 1,184 4/16/2017
0.1.0-alpha0006 1,222 4/13/2017
0.1.0-alpha0005 1,329 4/12/2017
0.1.0-alpha0004 1,240 4/12/2017
0.1.0-alpha0003 1,162 4/12/2017
0.1.0-alpha0002 21,005 3/12/2017
0.1.0-alpha0001 1,333 3/5/2017