Font

Sets up custom fonts for use in email

pnpm

aube

bun

npm

yarn

pnpm add jsx-email

Usage

Add the component to your email template. This applies your font to all tags inside your email. Note, that not all email clients supports web fonts, this is why it is important to configure your fallbackFontFamily. To view all email clients that supports web fonts see

import { Font, Head, Html } from 'jsx-email';

const Email = () => {
  return (
    <Html lang="en">
      <Head>
        <Font
          fontFamily="Roboto"
          fallbackFontFamily="Verdana"
          webFont={{
            url: 'https://fonts.gstatic.com/s/roboto/v27/KFOmCnqEu92Fr1Mu4mxKKTU1Kg.woff2',
            format: 'woff2'
          }}
          fontWeight={400}
          fontStyle="normal"
        />
      </Head>
    </Html>
  );
};

Component Props

export interface FontProps {
  fallbackFontFamily: FallbackFont | FallbackFont[];
  fontFamily: string;
  fontStyle?: FontStyle;
  fontWeight?: FontWeight;
  webFont?: {
    format: FontFormat;
    url: string;
  };
}

Props

fallbackFontFamily: FallbackFont | FallbackFont[];

The fallback font family the system should use, if web fonts are not supported or the chosen font is not installed on the system.

fontFamily: string;

The font family you want to use. If the webFont property is configured, this should contain the name of that font. Note: Do not insert multiple fonts here, use fallbackFontFamily for that_

fontStyle?: FontStyle;`

Default: 'normal'

The style of the font.

fontWeight?: FontWeight;`

Default: 400

The weight of the font.

webFont?: {
  format: FontFormat;
  url: string;
}

The webFont the supported email client should use. Note: Not all clients support web fonts. For support check: https://www.caniemail.com/features/css-at-font-face