256 lines
5.4 KiB
Plaintext
256 lines
5.4 KiB
Plaintext
|
|
||
|
|
|
||
|
|
|
||
|
|
# Astro Font Optimization
|
||
|
|
|
||
|
|
`astro-font` will automatically optimize your Custom Fonts, Local Fonts, Fonts over any CDN and Google fonts for performance.
|
||
|
|
|
||
|
|
The project is inspired by the [Next.js Font Optimization](https://nextjs.org/docs/pages/building-your-application/optimizing/fonts).
|
||
|
|
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install astro-font
|
||
|
|
## or yarn
|
||
|
|
yarn add astro-font
|
||
|
|
## or pnpm
|
||
|
|
pnpm add astro-font
|
||
|
|
```
|
||
|
|
|
||
|
|
## Google Fonts
|
||
|
|
|
||
|
|
Automatically optimize any Google Font. To use the font in all your pages, add it to `<head>` file in an Astro layout:
|
||
|
|
|
||
|
|
### Use Google Fonts URL directly
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
```astro
|
||
|
|
---
|
||
|
|
import { AstroFont } from "astro-font";
|
||
|
|
---
|
||
|
|
|
||
|
|
<head>
|
||
|
|
<AstroFont
|
||
|
|
config={[
|
||
|
|
{
|
||
|
|
src: [],
|
||
|
|
name: "Poppins",
|
||
|
|
// Google Fonts URL
|
||
|
|
googleFontsURL: 'https://fonts.googleapis.com/css2?family=Poppins:ital,wght@0,400;0,600;1,400;1,700&display=swap',
|
||
|
|
preload: true,
|
||
|
|
display: "swap",
|
||
|
|
selector: "body",
|
||
|
|
fallback: "sans-serif",
|
||
|
|
},
|
||
|
|
]}
|
||
|
|
/>
|
||
|
|
</head>
|
||
|
|
```
|
||
|
|
|
||
|
|
### Pick fonts from Google Fonts URL
|
||
|
|
|
||
|
|
```astro
|
||
|
|
---
|
||
|
|
import { AstroFont } from "astro-font";
|
||
|
|
---
|
||
|
|
|
||
|
|
<head>
|
||
|
|
<AstroFont
|
||
|
|
config={[
|
||
|
|
{
|
||
|
|
name: "Afacad",
|
||
|
|
src: [
|
||
|
|
{
|
||
|
|
style: 'bold',
|
||
|
|
weight: '700',
|
||
|
|
// Picked up font URL by manually visiting Google Fonts URL
|
||
|
|
path: 'https://fonts.gstatic.com/s/afacad/v1/6NUK8FKMIQOGaw6wjYT7ZHG_zsBBfvLqagk-80KjZfJ_uw.woff2'
|
||
|
|
},
|
||
|
|
],
|
||
|
|
preload: true,
|
||
|
|
display: "swap",
|
||
|
|
selector: "body",
|
||
|
|
fallback: "sans-serif",
|
||
|
|
},
|
||
|
|
]}
|
||
|
|
/>
|
||
|
|
</head>
|
||
|
|
```
|
||
|
|
|
||
|
|
## Local Fonts
|
||
|
|
|
||
|
|
```astro
|
||
|
|
---
|
||
|
|
import { AstroFont } from "astro-font";
|
||
|
|
---
|
||
|
|
|
||
|
|
<head>
|
||
|
|
<AstroFont
|
||
|
|
config={[
|
||
|
|
{
|
||
|
|
name: "Afacad",
|
||
|
|
src: [
|
||
|
|
{
|
||
|
|
style: 'normal',
|
||
|
|
weight: '400',
|
||
|
|
path: './public/fonts/Afacad-Regular.ttf'
|
||
|
|
},
|
||
|
|
{
|
||
|
|
style: 'medium',
|
||
|
|
weight: '500',
|
||
|
|
path: './public/fonts/Afacad-Medium.ttf'
|
||
|
|
},
|
||
|
|
],
|
||
|
|
preload: false,
|
||
|
|
display: "swap",
|
||
|
|
selector: "body",
|
||
|
|
fallback: "sans-serif",
|
||
|
|
},
|
||
|
|
]}
|
||
|
|
/>
|
||
|
|
</head>
|
||
|
|
```
|
||
|
|
|
||
|
|
## Using Multiple Fonts
|
||
|
|
|
||
|
|
You can import and use multiple fonts in your application. There are two approaches you can take.
|
||
|
|
|
||
|
|
Just extend the array of the config to contain the new collection of the fonts:
|
||
|
|
|
||
|
|
```astro
|
||
|
|
---
|
||
|
|
import { AstroFont } from "astro-font";
|
||
|
|
---
|
||
|
|
|
||
|
|
<head>
|
||
|
|
<AstroFont
|
||
|
|
config={[
|
||
|
|
{
|
||
|
|
name: "Afacad",
|
||
|
|
src: [
|
||
|
|
{
|
||
|
|
style: 'bold',
|
||
|
|
weight: '700',
|
||
|
|
path: 'https://fonts.gstatic.com/s/afacad/v1/6NUK8FKMIQOGaw6wjYT7ZHG_zsBBfvLqagk-80KjZfJ_uw.woff2'
|
||
|
|
},
|
||
|
|
],
|
||
|
|
preload: true,
|
||
|
|
display: "swap",
|
||
|
|
selector: "body",
|
||
|
|
fallback: "sans-serif",
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name: "Inter",
|
||
|
|
src: [
|
||
|
|
{
|
||
|
|
weight: '400',
|
||
|
|
style: 'normal',
|
||
|
|
path: './public/fonts/Inter-Regular.ttf'
|
||
|
|
}
|
||
|
|
],
|
||
|
|
preload: true,
|
||
|
|
display: "swap",
|
||
|
|
selector: "body > span",
|
||
|
|
fallback: "serif",
|
||
|
|
},
|
||
|
|
]}
|
||
|
|
/>
|
||
|
|
</head>
|
||
|
|
```
|
||
|
|
|
||
|
|
## Configuring CSS Classes
|
||
|
|
|
||
|
|
The `selector` attribute per config object can be used to configure which CSS class will reflect the whole CSS (automatically including the references to fallback fonts CSS).
|
||
|
|
|
||
|
|
```
|
||
|
|
<AstroFont
|
||
|
|
config={[
|
||
|
|
{
|
||
|
|
name: "Afacad",
|
||
|
|
src: [
|
||
|
|
{
|
||
|
|
style: 'bold',
|
||
|
|
weight: '700',
|
||
|
|
path: 'https://fonts.gstatic.com/s/afacad/v1/6NUK8FKMIQOGaw6wjYT7ZHG_zsBBfvLqagk-80KjZfJ_uw.woff2'
|
||
|
|
},
|
||
|
|
],
|
||
|
|
preload: true,
|
||
|
|
display: "swap",
|
||
|
|
fallback: "sans-serif",
|
||
|
|
|
||
|
|
// My Custom CSS Selector
|
||
|
|
// Type: ClassName
|
||
|
|
selector: ".custom_class",
|
||
|
|
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name: "Inter",
|
||
|
|
src: [
|
||
|
|
{
|
||
|
|
weight: '400',
|
||
|
|
style: 'normal',
|
||
|
|
path: './public/fonts/Inter-Regular.ttf'
|
||
|
|
}
|
||
|
|
],
|
||
|
|
preload: true,
|
||
|
|
display: "swap",
|
||
|
|
fallback: "serif",
|
||
|
|
|
||
|
|
// My Custom CSS Selector
|
||
|
|
// Type: CSS Selector
|
||
|
|
selector: "body > span",
|
||
|
|
},
|
||
|
|
]}
|
||
|
|
/>
|
||
|
|
```
|
||
|
|
|
||
|
|
## Configuring CSS Variables
|
||
|
|
|
||
|
|
The `cssVariable` attribute per config object can be used to configure which CSS variable will reflect in your document's `:root` CSS selector (automatically including the references to fallback fonts CSS).
|
||
|
|
|
||
|
|
```
|
||
|
|
<AstroFont
|
||
|
|
config={[
|
||
|
|
{
|
||
|
|
name: "Afacad",
|
||
|
|
src: [
|
||
|
|
{
|
||
|
|
style: 'bold',
|
||
|
|
weight: '700',
|
||
|
|
path: 'https://fonts.gstatic.com/s/afacad/v1/6NUK8FKMIQOGaw6wjYT7ZHG_zsBBfvLqagk-80KjZfJ_uw.woff2'
|
||
|
|
},
|
||
|
|
],
|
||
|
|
preload: true,
|
||
|
|
display: "swap",
|
||
|
|
fallback: "sans-serif",
|
||
|
|
|
||
|
|
// My Custom CSS Selector
|
||
|
|
// Type: ClassName
|
||
|
|
selector: ".custom_class",
|
||
|
|
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name: "Inter",
|
||
|
|
src: [
|
||
|
|
{
|
||
|
|
weight: '400',
|
||
|
|
style: 'normal',
|
||
|
|
path: './public/fonts/Inter-Regular.ttf'
|
||
|
|
}
|
||
|
|
],
|
||
|
|
preload: true,
|
||
|
|
display: "swap",
|
||
|
|
fallback: "serif",
|
||
|
|
|
||
|
|
// My Custom CSS Variable
|
||
|
|
// Type: CSS Variable
|
||
|
|
cssVariable: "astro-font",
|
||
|
|
|
||
|
|
// and now use it as style="font-family: var(--astro-font)"
|
||
|
|
},
|
||
|
|
]}
|
||
|
|
/>
|
||
|
|
```
|