Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cssninjaStudio/unplugin-fonts
Universal Webfont loader - Unfonts - based on https://web.dev/optimize-webfont-loading/
https://github.com/cssninjaStudio/unplugin-fonts
font-loading google-fonts typekit vite vite-plugin webfontloader webfonts
Last synced: about 2 months ago
JSON representation
Universal Webfont loader - Unfonts - based on https://web.dev/optimize-webfont-loading/
- Host: GitHub
- URL: https://github.com/cssninjaStudio/unplugin-fonts
- Owner: cssninjaStudio
- License: mit
- Created: 2021-01-05T19:42:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T08:27:58.000Z (9 months ago)
- Last Synced: 2024-01-19T20:12:05.769Z (8 months ago)
- Topics: font-loading, google-fonts, typekit, vite, vite-plugin, webfontloader, webfonts
- Language: TypeScript
- Homepage:
- Size: 543 KB
- Stars: 264
- Watchers: 2
- Forks: 20
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-vite - unplugin-fonts - Load font from Typekit, Google Fonts, Fontsource or your own custom one. (Plugins / Framework-agnostic Plugins)
- awesome-vite - unplugin-fonts - Load font from Typekit, Google Fonts, Fontsource or your own custom one. (Plugins / Framework-agnostic Plugins)
README
# unplugin-fonts
㊗️ Universal Webfont loader - Unfonts
[](https://www.npmjs.com/package/unplugin-fonts)
This plugin goes beyond just generating font-face rules - it also takes care of link preload and prefetch, optimizing font loading for a faster and more efficient user experience.
Unfonts currently supports popular font providers like Typekit, Google Fonts, and Fontsource, as well as custom fonts. This gives you the flexibility to choose from a vast range of fonts and seamlessly integrate them into your projects.
With Unfonts, you no longer have to manually manage font files and font-face rules, or worry about slow loading times. Our package does all the heavy lifting for you, so you can focus on creating amazing content with ease.
View configuration:
- [Typekit](#typekit)
- [Google Fonts](#google-fonts)
- [Custom Fonts](#custom-fonts)
- [Fontsource](#fontsource)
## Install
```bash
npm i --save-dev unplugin-fonts # pnpm add -D unplugin-fonts
```
Vite
```ts
// vite.config.ts
import Unfonts from 'unplugin-fonts/vite'
export default defineConfig({
plugins: [
Unfonts({ /* options */ }),
],
})
```
Example: [`examples/vite`](./examples/vite)
Webpack
> **Warning**
> Not implemented yet
```ts
// webpack.config.js
module.exports = {
/* ... */
plugins: [
require('unplugin-fonts/webpack')({ /* options */ })
]
}
```
Nuxt
```ts
// nuxt.config.js
export default {
modules: [
['unplugin-fonts/nuxt'],
],
unfonts: {
/* options */
}
}
```
Example: [`examples/nuxt`](./examples/nuxt)
SvelteKit
```ts
// vite.config.ts
import { defineConfig } from 'vite'
import { sveltekit } from '@sveltejs/kit/vite'
import Unfonts from 'unplugin-fonts/vite'
export default defineConfig({
plugins: [
sveltekit(),
Unfonts({
/* options */
})
]
})
// +layout.svelte
import { links } from 'unplugin-fonts/head'
{#each links as link}
{/each}
```
Example: [`examples/sveltekit`](./examples/sveltekit)
Astro
```ts
// astro.config.js
import { defineConfig } from 'astro/config'
import Unfonts from 'unplugin-fonts/astro'
export default defineConfig({
integrations: [
Unfonts({
/* options */
})
]
})
```
```astro
---
// src/pages/index.astro
import Unfont from 'unplugin-fonts/astro/component.astro';
---
```
Example: [`examples/astro`](./examples/astro)
---
Migrating from vite-plugin-fonts
```diff
// vite.config.ts
-import { VitePluginFonts } from 'vite-plugin-fonts'
+import Unfonts from 'unplugin-fonts/vite'
export default defineConfig({
plugins: [
- VitePluginFonts({
+ Unfonts({
/* options */
}),
],
})
```
```diff
// main.ts
-import 'virtual:fonts.css'
+import 'unfonts.css'
```
## Import generated `@font-rules` CSS
> **Note**
> Required if using **custom** or **fontsource** providers
```ts
import 'unfonts.css'
```
## Providers
### Typekit
Load fonts from [Typekit](https://typekit.com/).
```ts
Unfonts({
// Typekit API
typekit: {
/**
* Typekit project id
*/
id: '',
/**
* enable non-blocking renderer
*
* default: true
*/
defer: true,
/**
* define where the font load tags should be inserted
* default: 'head-prepend'
* values: 'head' | 'body' | 'head-prepend' | 'body-prepend'
*/
injectTo: 'head-prepend',
},
})
```
### Google Fonts
Load fonts from [Google Fonts](https://fonts.google.com/).
```ts
Unfonts({
// Google Fonts API V2
google: {
/**
* enable preconnect link injection
*
* default: true
*/
preconnect: false,
/**
* values: auto, block, swap(default), fallback, optional
* default: 'swap'
*/
display: 'block',
/**
* define which characters to load
* default: undefined (load all characters)
*/
text: 'ViteAwsom',
/**
* define where the font load tags should be inserted
* default: 'head-prepend'
* values: 'head' | 'body' | 'head-prepend' | 'body-prepend'
*/
injectTo: 'head-prepend',
/**
* Fonts families lists
*/
families: [
// families can be either strings (only regular 400 will be loaded)
'Source Sans Pro',
// or objects
{
/**
* Family name (required)
*/
name: 'Roboto',
/**
* Family styles
*/
styles: 'ital,wght@0,400;1,200',
/**
* enable non-blocking renderer
*
* default: true
*/
defer: true,
},
],
},
})
```
### Custom Fonts
Load custom fonts from files.
```ts
Unfonts({
// Custom fonts.
custom: {
/**
* Fonts families lists
*/
families: [{
/**
* Name of the font family.
*/
name: 'Roboto',
/**
* Local name of the font. Used to add `src: local()` to `@font-rule`.
*/
local: 'Roboto',
/**
* Regex(es) of font files to import. The names of the files will
* predicate the `font-style` and `font-weight` values of the `@font-rule`'s.
*/
src: './src/assets/fonts/*.ttf',
/**
* This function allow you to transform the font object before it is used
* to generate the `@font-rule` and head tags.
*/
transform(font) {
if (font.basename === 'Roboto-Bold') {
// update the font weight
font.weight = 700
}
// we can also return null to skip the font
return font
}
}],
/**
* Defines the default `font-display` value used for the generated
* `@font-rule` classes.
*/
display: 'auto',
/**
* Using `` will trigger a request for the WebFont
* early in the critical rendering path, without having to wait for the
* CSSOM to be created.
*/
preload: true,
/**
* Using `` is intended for prefetching resources
* that will be used in the next navigation/page load
* (e.g. when you go to the next page)
*
* Note: this can not be used with `preload`
*/
prefetch: false,
/**
* define where the font load tags should be inserted
* default: 'head-prepend'
* values: 'head' | 'body' | 'head-prepend' | 'body-prepend'
*/
injectTo: 'head-prepend',
},
})
```
### Fontsource
Load fonts from [Fontsource](https://fontsource.org/) packages.
> **Note**
> You will need to install `@fontsource/` packages.
```ts
Unfonts({
// Fontsource API
fontsource: {
/**
* Fonts families lists
*/
families: [
// families can be either strings (load default font set)
// Require the `@fontsource/abeezee` package to be installed.
'ABeeZee',
'Inter Variable', // Require the `@fontsource-variable/inter` package to be installed.
{
/**
* Name of the font family.
* Require the `@fontsource/roboto` package to be installed.
*/
name: 'Roboto',
/**
* Load only a subset of the font family.
*/
weights: [400, 700],
/**
* Restrict the font styles to load.
*/
styles: ['italic', 'normal'],
/**
* Use another font subset.
*/
subset: 'latin-ext',
},
{
/**
* Name of the font family.
* Require the `@fontsource-variable/cabin` package to be installed.
*/
name: 'Cabin',
/**
* When using variable fonts, you can choose which axes to load.
*/
variable: {
wght: true,
slnt: true,
ital: true,
},
},
],
},
})
```
## Typescript Definitions
```json
{
"compilerOptions": {
"types": ["unplugin-fonts/client"]
}
}
```
or
```ts
// declaration.d.ts
///
```
## Resources
- https://web.dev/optimize-webfont-loading/
- https://csswizardry.com/2020/05/the-fastest-google-fonts/
- _(unmaintained)_ https://www.npmjs.com/package/webfontloader