Skip to content

Reduce layout shift from font loading #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MHolmes91 merged 1 commit into from
Jun 27, 2025
Merged

Reduce layout shift from font loading #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ colors and fonts. The following keys are supported:
"fonts": {
"body": "'lato', sans-serif",
"header": "'PT Sans', sans-serif",
"googleFontsUrl": "//fonts.googleapis.com/css?family=Lato:300,400,700,300italic,400italic|PT+Sans:400,700|PT+Sans+Narrow:400,700|Inconsolata:400"
"googleFontsUrl": "https://fonts.googleapis.com/css?family=Lato:300,400,700,300italic,400italic|PT+Sans:400,700|PT+Sans+Narrow:400,700|Inconsolata:400&display=swap"
}
}
}
Expand All @@ -46,8 +46,11 @@ defaults to the value in `DEFAULT_GOOGLE_FONTS_URL` inside `pages/index.js`.

1. Browse or search fonts at [fonts.google.com](https://fonts.google.com).
2. Add each font to your selection then open the **Get embed code** panel.
3. Copy the `href` attribute from the `<link>` tag and place it in
`style.fonts.googleFontsUrl`.
3. Copy the `href` attribute from the `<link>` tag and append `&display=swap` to
minimize layout shift, then place the result in `style.fonts.googleFontsUrl`.
4. Use an `https:` URL if possible. The application forces Google Fonts URLs to
`https` and preconnects to the fonts domains to start the TLS handshake early
for faster loading.

## `portfolio.json` Reference

Expand All @@ -71,7 +74,7 @@ The file `portfolio.json` controls what content appears on your portfolio site.

### Styling

The optional `style.colors` and `style.fonts` objects override the default colours and fonts as shown above. The `googleFontsUrl` value should be copied from the `href` attribute of the embed link on [Google Fonts](https://fonts.google.com).
The optional `style.colors` and `style.fonts` objects override the default colours and fonts as shown above. The `googleFontsUrl` value should be copied from the `href` attribute of the embed link on [Google Fonts](https://fonts.google.com) and include the `&display=swap` parameter.

### Portfolio Links

Expand Down
29 changes: 26 additions & 3 deletions pages/_document.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,21 @@ import Document, { Html, Head, Main, NextScript } from 'next/document';
import getPortfolioProps from '../lib/getPortfolioProps';

const DEFAULT_GOOGLE_FONTS_URL =
"//fonts.googleapis.com/css?family=Lato:300,400,700,300italic,400italic|PT+Sans:400,700|PT+Sans+Narrow:400,700|Inconsolata:400";
"https://fonts.googleapis.com/css?family=Lato:300,400,700,300italic,400italic|PT+Sans:400,700|PT+Sans+Narrow:400,700|Inconsolata:400&display=swap";

class MyDocument extends Document {
static async getInitialProps(ctx) {
const initialProps = await Document.getInitialProps(ctx);
const { data } = getPortfolioProps();
const fontsUrl = data.style?.fonts?.googleFontsUrl || DEFAULT_GOOGLE_FONTS_URL;
const fontsUrlRaw =
data.style?.fonts?.googleFontsUrl || DEFAULT_GOOGLE_FONTS_URL;
// Always use HTTPS even if the config omits the protocol or specifies HTTP
let fontsUrl = fontsUrlRaw;
if (fontsUrl.startsWith('http://')) {
fontsUrl = `https://${fontsUrl.slice(7)}`;
} else if (fontsUrl.startsWith('//')) {
fontsUrl = `https:${fontsUrl}`;
}
return { ...initialProps, fontsUrl };
}

Expand All @@ -17,7 +25,22 @@ class MyDocument extends Document {
return (
<Html>
<Head>
{fontsUrl && <link href={fontsUrl} rel="stylesheet" type="text/css" />}
{fontsUrl && (
<>
{/*
Preconnect warms up the TLS and DNS connections for Google's
font domains. This helps fonts load faster and reduces layout
shift before the CSS file is downloaded.
*/}
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link
rel="preconnect"
href="https://fonts.gstatic.com"
crossOrigin="anonymous"
/>
<link href={fontsUrl} rel="stylesheet" />
</>
)}
</Head>
<body>
<Main />
Expand Down
2 changes: 1 addition & 1 deletion portfolio.default.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"fonts": {
"body": "'lato', sans-serif",
"header": "'PT Sans', sans-serif",
"googleFontsUrl": "//fonts.googleapis.com/css?family=Lato:300,400,700,300italic,400italic|PT+Sans:400,700|PT+Sans+Narrow:400,700|Inconsolata:400"
"googleFontsUrl": "https://fonts.googleapis.com/css?family=Lato:300,400,700,300italic,400italic|PT+Sans:400,700|PT+Sans+Narrow:400,700|Inconsolata:400&display=swap"
}
},
"footer": "<a href=\"https://github.com/MHolmes91/mini-me\">Use this repo for your own portfolio site!</a>",
Expand Down