Fonts

Loading custom fonts for use with the Canvas API

It is possible to load your own font files into an nx.js application, and then render your fonts using canvas rendering mode.

Loading a font

To load a font, you'll need to create an instance of the FontFace class, by providing the name of the font and the font data as an ArrayBuffer:

// Load the font data into a `FontFace` instance
const fontData = await Switch.readFile('romfs:/fonts/Arial.ttf');
const font = new FontFace('Arial', fontData);

Registering a font

Once you've loaded a font, you'll need to register it with the FontFaceSet registry. The fonts global is available for this purpose, similar to how you would register a font in a "web worker" context.

// Add the font to the global `fonts` registry
fonts.add(font);

The fonts registry is a global object that contains all the fonts that have been loaded into the application. You can use this registry to render text to the screen using the Canvas API.

Example

const fontData = await Switch.readFile('romfs:/fonts/Arial.ttf');
const font = new FontFace('Arial', fontData);
fonts.add(font);
 
// Render to the screen using the Canvas API by setting the "font" property
const ctx = screen.getContext('2d');
ctx.font = '48px Arial';
ctx.fillStyle = 'cyan';
ctx.fillText('This is the "Arial" font', 50, 300);