-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.md
599 lines (428 loc) · 9.39 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
# Nuxt Font Loader
Simple, modern and lightweight font loader for Nuxt.
<sub><a href="https://github.com/ivodolenc/nuxt-font-loader">Repository</a> | <a href="https://www.npmjs.com/package/nuxt-font-loader">Package</a> | <a href="https://github.com/ivodolenc/nuxt-font-loader/releases">Releases</a> | <a href="https://github.com/ivodolenc/nuxt-font-loader/discussions">Discussions</a></sub>
```sh
npm i -D nuxt-font-loader
```
## Features
- 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
## Quick Start
1. Install `nuxt-font-loader` to your project
```sh
npm i -D nuxt-font-loader
```
2. Enable the module in the main config file
```js
// nuxt.config.ts
{
modules: ['nuxt-font-loader'],
fontLoader: {
local: [
{
src: '/new-font.woff2',
family: 'Family Name',
class: 'font-new-font'
}
]
}
}
```
That's it!
## Optimization
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.
## Font Composables
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.
```js
// nuxt.config.ts
{
fontLoader: {
autoImport: true // enables auto-import feature
}
}
```
If enabled, you can use _font composables_ across your application without explicitly importing them.
## Local Strategy
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](https://github.com/hypernym-studio/nuxt-font), a much lighter version with the same API.
### Global Settings
Place the previously downloaded fonts in the `public/fonts/` directory and specify the path to the local font files.
```js
// 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:
```html
<template>
<h1 class="font-aspekta">Nuxt Font Loader</h1>
</template>
```
### Font Composable
Import the function where you need it.
```html
<!-- 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>
```
## External Strategy
Loads fonts directly from third-party servers, such as Google, Typekit, etc.
### Global Settings
Specify the full url to external font sources and adjust other options as needed.
```js
// 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:
```html
<template>
<h1 class="font-inter">Nuxt Font Loader</h1>
</template>
```
### Font Composable
Import the function where you need it.
```html
<!-- 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>
```
## Options
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.
### Defaults
```js
// nuxt.config.ts
{
fontLoader: {
local: [],
external: [],
autoImport: false
}
}
```
## local
- Type: `object[]`
- Default: `[]`
An array of objects that specifies `local` font sources.
Each object is treated as a separate block of rules.
```js
// nuxt.config.ts
{
fontLoader: {
local: [
{
src: '/fonts/AspektaVF.woff2',
family: 'Aspekta Variable',
weight: '100 900',
class: 'font-aspekta', // optional
},
]
}
}
```
### preload
- Type: `boolean`
- Default: `true`
Specifies the _preload_ links.
```js
{
preload: true
}
```
### src
- Type: `string`
- Required: `true`
Specifies path to the font file.
```js
{
src: '/path/to/font.woff2'
}
```
### family
- Type: `string`
- Required: `true`
Defines the font family name.
```js
{
family: 'Family Name'
}
```
### fallback
- Type: `string`
- Default: `undefined`
Defines the font family fallback.
```js
{
fallback: 'sans-serif'
}
```
Example above will generate the font fallback:
```css
.my-font {
font-family: 'family-name', sans-serif;
}
```
### weight
- Type: `string`
- Default: `400`
Defines the font weight.
```js
{
// static weight
weight: '300'
}
```
```js
{
// variable weight range
weight: '100 900'
}
```
### display
- Type: `string`
- Default: `optional`
- Auto-hinted
Specifies how a font face is displayed.
```js
{
display: 'swap'
}
```
### style
- Type: `string`
- Default: `normal`
- Auto-hinted
Defines the font style.
```js
{
style: 'normal'
}
```
### class
- Type: `string`
- Default: `undefined`
Defines the global css _class_ for the current source.
```js
{
class: 'my-font'
}
```
Example above will generate global css class:
```css
.my-font {
font-family: 'family-name';
}
```
So it can be used in templates:
```html
<h1 class="my-font">Font Loader</h1>
```
### variable
- Type: `string`
- Default: `undefined`
Defines the global css _variable_ for the current source.
```js
{
variable: 'my-font'
}
```
Example above will generate global css variable:
```css
:root {
--my-font: 'family-name';
}
```
So it can be used in templates:
```css
h1 {
font-family: var(--my-font);
}
```
### unicode
- Type: `string[]`
- Default: `undefined`
Defines a specific range of characters to be used from the font.
```js
{
preload: false, // disables the preload link
display: 'swap', // or 'fallback', 'auto' ...
unicode: ['U+26']
}
```
Example above will generate:
```css
@font-face {
font-display: swap;
unicode-range: U+26;
}
```
## external
- 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.
```js
// nuxt.config.ts
{
fontLoader: {
external: [
{
src: 'https://fonts.googleapis.com/css2?family=Inter&display=swap',
family: 'Inter',
class: 'font-inter', // optional
},
]
}
}
```
### src
- Type: `string`
- Required: `true`
Specifies path to the external source.
```js
{
src: 'path-to-external-source'
}
```
### family
- Type: `string`
- Default: `undefined`
Defines the font family name.
Use this in combination with the _class_ or _variable_ options.
```js
{
family: 'Family Name',
class: 'my-font'
}
```
### fallback
- Type: `string`
- Default: `undefined`
Defines the font family fallback.
```js
{
fallback: 'sans-serif'
}
```
Example above will generate the font fallback:
```css
.my-font {
font-family: 'family-name', sans-serif;
}
```
### class
- Type: `string`
- Default: `undefined`
Defines the global css _class_ for the current source.
```js
{
class: 'my-font'
}
```
Example above will generate global css class:
```css
.my-font {
font-family: 'family-name';
}
```
So it can be used in templates:
```html
<h1 class="my-font">Font Loader</h1>
```
### variable
- Type: `string`
- Default: `undefined`
Defines the global css _variable_ for the current source.
```js
{
variable: 'my-font'
}
```
Example above will generate global css variable:
```css
:root {
--my-font: 'family-name';
}
```
So it can be used in templates:
```css
h1 {
font-family: var(--my-font);
}
```
## autoImport
- 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.
```js
// nuxt.config.ts
{
fontLoader: {
autoImport: true
}
}
```
## Community
Feel free to use the official [discussions](https://github.com/ivodolenc/nuxt-font-loader/discussions) for any additional questions.
## License
Developed in 🇭🇷 Croatia
Released under the [MIT](LICENSE.txt) license.
© Ivo Dolenc