Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Developmint/nuxt-webfontloader
Efficient web font loading has never been easier!
https://github.com/Developmint/nuxt-webfontloader
font nuxt nuxt-module nuxtjs webfont webfontloader
Last synced: 3 months ago
JSON representation
Efficient web font loading has never been easier!
- Host: GitHub
- URL: https://github.com/Developmint/nuxt-webfontloader
- Owner: Developmint
- License: mit
- Created: 2018-11-24T16:13:12.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T20:20:34.000Z (3 months ago)
- Last Synced: 2024-10-28T21:24:54.698Z (3 months ago)
- Topics: font, nuxt, nuxt-module, nuxtjs, webfont, webfontloader
- Language: JavaScript
- Size: 187 KB
- Stars: 306
- Watchers: 3
- Forks: 7
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Nuxt Webfontloader - Efficient web font loading has never been easier!
[](https://npmjs.com/package/nuxt-webfontloader)
[](https://npmjs.com/package/nuxt-webfontloader)
[](https://travis-ci.com/Developmint/nuxt-webfontloader)
[](https://codecov.io/gh/Developmint/nuxt-webfontloader)
[](https://david-dm.org/Developmint/nuxt-webfontloader)
[](http://standardjs.com)
[](https://thanks.lichter.io/)
>
[📖 **Release Notes**](./CHANGELOG.md)
## Features
* Full support of SVGs as components. Import them like your Vue SFCs
* Built on top of Google's/Typekit's [webfontloader](https://www.npmjs.com/package/webfontloader)
* Improves site performance by loading web-fonts asynchronously
* Nuxt 2 (and only Nuxt 2) support
* Fully tested!
## Setup
- Add `nuxt-webfontloader` as a dependency using yarn or npm to your project
- Add `nuxt-webfontloader` to `modules` section of `nuxt.config.js`
```js
{
modules: [
'nuxt-webfontloader',
],
}
```
- Include your webfontloader options in the `nuxt.config.js`, for example:
```js
export default {
webfontloader: {
google: {
families: ['Lato:400,700'] //Loads Lato font with weights 400 and 700
}
},
}
```
- Remove old stylesheets from your app template or `nuxt.config.js` head part:
```js
export default {
head:{
link: [
// You don't need that line anymore!
{ rel: 'stylesheet', href: 'https://fonts.googleapis.com/css?family=Lato:400,700' }
]
}
}
```
## Adding Google Fonts with Font Display option
If you like to use Goggle Fonts with font-display option, this is possible.
**But there is a small difference if you want to add only one Font Family or more than one**.
Here an example for adding **one font family** with font-display option:
```js
export default {
webfontloader: {
google: {
// Loads Open Sans font with weights 300 and 400 + display font as swap
families: ['Open+Sans:300,400,600&display=swap']
}
},
}
```
Here an example for adding **more font families** with font-display option:
```js
export default {
webfontloader: {
// add Google Fonts as "custom" | workaround required
custom: {
families: [
'Open Sans:n3,n4',
'Roboto:n3,n7'
],
urls: [
// for each Google Fonts add url + options you want
// here add font-display option
'https://fonts.googleapis.com/css?family=Open+Sans:300,400&display=swap',
'https://fonts.googleapis.com/css?family=Roboto:300,700&display=swap'
]
}
},
}
```
## Development
- Clone this repository
- Install dependencies using `yarn install` or `npm install`
- Start development server using `npm run dev`
## License
[MIT License](./LICENSE)
Copyright (c) Alexander Lichter