React-pdf

Edit

Fonts

React-pdf is shipped with a Font module that enables to load fonts from different sources, handle how words are wrapped and defined an emoji source to embed these glyphs on your document.

You can define multiple sources for the same font family, each with a different fontStyle or fontWeight. React-pdf will pick the appropiate font for each <Text /> based on its style and the registered fonts.

import { StyleSheet, Font } from '@react-pdf/renderer'

// Register font
Font.register({ family: 'Roboto', src: source });

// Reference font
const styles = StyleSheet.create({
  title: {
    fontFamily: 'Roboto'
  }
})

register

Fonts really make the difference when it comes on styling a document. For obvious reasons, react-pdf cannot ship a wide amount of them. That's why we provide an easy way to load your custom fonts from many different sources via the register method very easily.

import { Font } from '@react-pdf/renderer'

Font.register({ family: 'FamilyName', src: source, fontStyle: 'normal', fontWeight: 'normal', fonts?: [] });

source

Specifies the source of the font. This can either be a valid URL, or an absolute path if you're using react-pdf on Node.

family

Name to which the font will be referenced on styles definition. Can be any unique valid string

fontStyle

Specifies to which font style the registered font refers to.

ValueDescription
normalSelects a font that is classified as normal Default
italicSelects a font that is classified as italic. If no italic version of the font is registered, react-pdf will fail when a style of this type is present
obliqueSelects a font that is classified as oblique. If no oblique version of the font is registered, react-pdf will fail when a style of this type is present

fontWeight

Specifies the registered font weight.

ValueDescription
thinEquals to value 100
ultralightEquals to value 200
lightEquals to value 300
normalEquals to value 400 Default
mediumEquals to value 500
semiboldEquals to value 600
boldEquals to value 700
ultraboldEquals to value 800
heavyEquals to value 900
numberAny integer value between 0 and 1000

When the exact font weight is not registered for a given text, react-pdf will fallback to the nearest registered weight in the same way browsers do. More information here

See it in action →

fonts

In many cases you will end up registering multiple sources for the same font family (each with different font-style and font-weight for instance). As an alternative of calling Font.register for each of this, you can use the fonts attribute to register them all at once:

Font.register({ family: 'Roboto', fonts: [
 { src: source1 }, // font-style: normal, font-weight: normal
 { src: source2, fontStyle: 'italic' },
 { src: source3, fontStyle: 'italic', fontWeight: 700 },
]});

registerHyphenationCallback

Enables you to have fine-grained control over how words break, passing your own callback and handle all that logic for yourself:

import { Font } from '@react-pdf/renderer'

const hyphenationCallback = (word) => {
  // Return word parts in an array
}

Font.registerHyphenationCallback(hyphenationCallback);

Disabling hyphenation

You can easily disable word hyphenation by just returning the same word as it is passed to the hyphenation callback

Font.registerHyphenationCallback(word => [word]);

registerEmojiSource

PDF documents do not support color emoji fonts. This is a bummer for the ones out there who love their expressiveness and simplicity. The only way of rendering this glyphs on a PDF document, is by embedding them as images.

React-pdf makes this task simple by enabling you to use a CDN from where to download emoji images. All you have to do is setup a valid URL (we recommend using Twemoji for this task), and react-pdf will take care of the rest:

import { Font } from '@react-pdf/renderer'

Font.registerEmojiSource({
  format: 'png',
  url: 'https://twemoji.maxcdn.com/2/72x72/',
});

Protip: react-pdf will need a internet connection to download emoji's images at render time, so bare that in mind when choosing to use this API