Simple, modern and lightweight font loader for Nuxt.
Repository | Package | Releases | Discussions
npm i -D nuxt-font-loader- Helps you to easily load fonts on your site
- Supports local and external loading
- Provides font composables
- Follows modern methods and practices
- Designed for Nuxt 3+
- TypeScript friendly
- Super easy to use
- No dependencies
- Install
nuxt-font-loaderto your project
npm i -D nuxt-font-loader- Enable the module in the main config file
// nuxt.config.ts
{
modules: ['nuxt-font-loader'],
fontLoader: {
local: [
{
src: '/new-font.woff2',
family: 'Family Name',
class: 'font-new-font'
}
]
}
}That's it!
The nuxt-font-loader brings an updated font loading strategies to your project. It automatically optimizes all your font sources and improves page loading speed.
Depending on the strategy, either local or external, the module adds preconnect and preload link tags to the <head> section with minified inline styles for @font-face rules.
So you don't have to worry about optimization at all since the module will do all the work under the hood.
The module also provides custom functions designed to load fonts on a specific page only.
Using this composables, the font sources will not be loaded globally, but only on the page from which the function is called.
This can be super useful if you want to change fonts for different pages or layouts.
By default, font composables are not automatically imported since they are optional, but you can enable this via module option.
// nuxt.config.ts
{
fontLoader: {
autoImport: true // enables auto-import feature
}
}If enabled, you can use font composables across your application without explicitly importing them.
Loads fonts from the same domain as your deployment.
At the moment, this is the most recommended method for handling fonts. You can optimally load fonts with performance, flexibility and privacy in mind.
Also, try to use variable fonts whenever you can to take advantage of their customization and fast loading speed.
In addition, check out Nuxt Font, a much lighter version with the same API.
Place the previously downloaded fonts in the public/fonts/ directory and specify the path to the local font files.
// nuxt.config.ts
{
fontLoader: {
local: [
{
src: '/fonts/AspektaVF.woff2',
family: 'Aspekta Variable',
weight: '100 900',
class: 'font-aspekta',
},
]
}
}You can now use it in the templates like this:
<template>
<h1 class="font-aspekta">Nuxt Font Loader</h1>
</template>Import the function where you need it.
<!-- index.vue -->
<template>
<h1 class="font-aspekta">Nuxt Font Loader</h1>
</template>
<script setup lang="ts">
import { useLocalFont } from '#font-loader'
useLocalFont([
{
src: '/fonts/AspektaVF.woff2',
family: 'Aspekta Variable',
weight: '100 900',
class: 'font-aspekta',
},
])
</script>Loads fonts directly from third-party servers, such as Google, Typekit, etc.
Specify the full url to external font sources and adjust other options as needed.
// nuxt.config.ts
{
fontLoader: {
external: [
{
src: 'https://fonts.googleapis.com/css2?family=Inter&display=swap',
family: 'Inter',
class: 'font-inter',
},
]
}
}You can now use it in the templates like this:
<template>
<h1 class="font-inter">Nuxt Font Loader</h1>
</template>Import the function where you need it.
<!-- index.vue -->
<template>
<h1 class="font-inter">Nuxt Font Loader</h1>
</template>
<script setup lang="ts">
import { useExternalFont } from '#font-loader'
useExternalFont([
{
src: 'https://fonts.googleapis.com/css2?family=Inter&display=swap',
family: 'Inter',
class: 'font-inter',
},
])
</script>Nuxt Font Loader has been completely rewritten so it's TypeScript friendly.
It also improves the development experience with detailed descriptions, examples, and auto-hinted configuration right in the code editor.
// nuxt.config.ts
{
fontLoader: {
local: [],
external: [],
autoImport: false
}
}- Type:
object[] - Default:
[]
An array of objects that specifies local font sources.
Each object is treated as a separate block of rules.
// nuxt.config.ts
{
fontLoader: {
local: [
{
src: '/fonts/AspektaVF.woff2',
family: 'Aspekta Variable',
weight: '100 900',
class: 'font-aspekta', // optional
},
]
}
}- Type:
boolean - Default:
true
Specifies the preload links.
{
preload: true
}- Type:
string - Required:
true
Specifies path to the font file.
{
src: '/path/to/font.woff2'
}- Type:
string - Required:
true
Defines the font family name.
{
family: 'Family Name'
}- Type:
string - Default:
undefined
Defines the font family fallback.
{
fallback: 'sans-serif'
}Example above will generate the font fallback:
.my-font {
font-family: 'family-name', sans-serif;
}- Type:
string - Default:
400
Defines the font weight.
{
// static weight
weight: '300'
}{
// variable weight range
weight: '100 900'
}- Type:
string - Default:
optional - Auto-hinted
Specifies how a font face is displayed.
{
display: 'swap'
}- Type:
string - Default:
normal - Auto-hinted
Defines the font style.
{
style: 'normal'
}- Type:
string - Default:
undefined
Defines the global css class for the current source.
{
class: 'my-font'
}Example above will generate global css class:
.my-font {
font-family: 'family-name';
}So it can be used in templates:
<h1 class="my-font">Font Loader</h1>- Type:
string - Default:
undefined
Defines the global css variable for the current source.
{
variable: 'my-font'
}Example above will generate global css variable:
:root {
--my-font: 'family-name';
}So it can be used in templates:
h1 {
font-family: var(--my-font);
}- Type:
string[] - Default:
undefined
Defines a specific range of characters to be used from the font.
{
preload: false, // disables the preload link
display: 'swap', // or 'fallback', 'auto' ...
unicode: ['U+26']
}Example above will generate:
@font-face {
font-display: swap;
unicode-range: U+26;
}- Type:
object[] - Default:
[]
An array of objects that specifies external font sources.
It is also possible to specify static sources from the public/ directory.
Each object is treated as a separate block of rules.
// nuxt.config.ts
{
fontLoader: {
external: [
{
src: 'https://fonts.googleapis.com/css2?family=Inter&display=swap',
family: 'Inter',
class: 'font-inter', // optional
},
]
}
}- Type:
string - Required:
true
Specifies path to the external source.
{
src: 'path-to-external-source'
}- Type:
string - Default:
undefined
Defines the font family name.
Use this in combination with the class or variable options.
{
family: 'Family Name',
class: 'my-font'
}- Type:
string - Default:
undefined
Defines the font family fallback.
{
fallback: 'sans-serif'
}Example above will generate the font fallback:
.my-font {
font-family: 'family-name', sans-serif;
}- Type:
string - Default:
undefined
Defines the global css class for the current source.
{
class: 'my-font'
}Example above will generate global css class:
.my-font {
font-family: 'family-name';
}So it can be used in templates:
<h1 class="my-font">Font Loader</h1>- Type:
string - Default:
undefined
Defines the global css variable for the current source.
{
variable: 'my-font'
}Example above will generate global css variable:
:root {
--my-font: 'family-name';
}So it can be used in templates:
h1 {
font-family: var(--my-font);
}- Type:
boolean - Default:
false
Manages the built-in auto-import feature.
If enabled, you can use font composables across your application without explicitly importing them.
// nuxt.config.ts
{
fontLoader: {
autoImport: true
}
}Feel free to use the official discussions for any additional questions.
Developed in ðŸ‡ðŸ‡· Croatia
Released under the MIT license.
© Ivo Dolenc
