Web Fonts preset

フォント名を提供するだけで、Google Fonts、FontShareからWebフォントを使用できます。

サポートされているすべてのプロバイダーを参照してください。

ソースコード

インストール

pnpm

pnpm add -D @unocss/preset-web-fonts

yarn

yarn add -D @unocss/preset-web-fonts

npm

npm install -D @unocss/preset-web-fonts

bun

bun add -D @unocss/preset-web-fonts

import presetWebFonts from '@unocss/preset-web-fonts'
import presetWind3 from '@unocss/preset-wind3'
import { defineConfig } from 'unocss'

export default defineConfig({
  presets: [
    presetWind3(),
    presetWebFonts({ /* options */ }),
  ],
})

TIP

このプリセットはunocssパッケージに含まれており、そこからもインポートできます：

import { presetWebFonts } from 'unocss'

プロバイダー

現在サポートされているプロバイダー：

• none - 何もしない、フォントをシステムフォントとして扱う
• google - Google Fonts
• bunny - プライバシーフレンドリーなGoogle Fonts
• fontshare - ITFによる高品質フォントサービス

INFO

より多くのプロバイダーを追加するPRを歓迎します。🙌

カスタムフェッチ関数

独自の関数を使用してフォントソースをフェッチします。

import presetWebFonts from '@unocss/preset-web-fonts'
import presetWind3 from '@unocss/preset-wind3'
import axios from 'axios'
import ProxyAgent from 'proxy-agent'
import { defineConfig } from 'unocss'

export default defineConfig({
  presets: [
    presetWind3(),
    presetWebFonts({
      // httpsプロキシを使用したaxiosを使用
      customFetch: (url: string) => axios.get(url, { httpsAgent: new ProxyAgent('https://localhost:7890') }).then(it => it.data),
      provider: 'google',
      fonts: {
        sans: 'Roboto',
        mono: ['Fira Code', 'Fira Mono:400,700'],
      },
    }),
  ],
})

オプション

provider

• 型: WebFontsProviders
• デフォルト: google

Webフォントのプロバイダーサービス。

type WebFontsProviders = 'google' | 'bunny' | 'fontshare' | 'none'

fonts

• 型: Record<string, WebFontMeta | string | (WebFontMeta | string)[]>

フォント。詳細は例を参照してください。

interface WebFontMeta {
  name: string
  weights?: (string | number)[]
  italic?: boolean
  /**
   * プロバイダーをオーバーライド
   * @default <ルート設定と一致>
   */
  provider?: WebFontsProviders
}

extendTheme

• 型: boolean
• デフォルト: true

テーマオブジェクトを拡張します。

themeKey

• 型: string
• デフォルト: fontFamily

テーマオブジェクトのキー。

inlineImports

• 型: boolean
• デフォルト: true

CSS @import()をインライン化します。

customFetch

• 型: (url: string) => Promise<string>
• デフォルト: undefined

独自の関数を使用してフォントソースをフェッチします。カスタムフェッチ関数を参照してください。

例

presetWebFonts({
  provider: 'google', // デフォルトのプロバイダー
  fonts: {
    // これらはデフォルトのテーマを拡張します
    sans: 'Roboto',
    mono: ['Fira Code', 'Fira Mono:400,700'],
    // カスタムのもの
    lobster: 'Lobster',
    lato: [
      {
        name: 'Lato',
        weights: ['400', '700'],
        italic: true,
      },
      {
        name: 'sans-serif',
        provider: 'none',
      },
    ],
  },
})

以下のCSSが自動的に生成されます：

@import url('https://fonts.googleapis.com/css2?family=Roboto&family=Fira+Code&family=Fira+Mono:wght@400;700&family=Lobster&family=Lato:ital,wght@0,400;0,700;1,400;1,700&display=swap');

/* layer: default */
.font-lato {
  font-family: "Lato", sans-serif;
}
.font-lobster {
  font-family: "Lobster";
}
.font-mono {
  font-family: "Fira Code", "Fira Mono", ui-monospace, SFMono-Regular, Menlo,
    Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
}
.font-sans {
  font-family: "Roboto", ui-sans-serif, system-ui, -apple-system,
    BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans",
    sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol",
    "Noto Color Emoji";
}

フォントをローカルで提供

デフォルトでは、プリセットはプロバイダーのCDNからフォントをフェッチします。フォントをローカルで提供したい場合は、@unocss/preset-web-fonts/localのプロセッサーを使用してフォントをダウンロードし、独自のサーバーから提供できます。

import presetWebFonts from '@unocss/preset-web-fonts'
import { createLocalFontProcessor } from '@unocss/preset-web-fonts/local'
import { defineConfig } from 'unocss'

export default defineConfig({
  presets: [
    presetWebFonts({
      provider: 'none',
      fonts: {
        sans: 'Roboto',
        mono: 'Fira Code',
      },
      // これによりフォントがダウンロードされ、ローカルで提供されます
      processors: createLocalFontProcessor({
        // フォントをキャッシュするディレクトリ
        cacheDir: 'node_modules/.cache/unocss/fonts',

        // フォントアセットを保存するディレクトリ
        fontAssetsDir: 'public/assets/fonts',

        // クライアントからフォントを提供するベースURL
        fontServeBaseUrl: '/assets/fonts'
      })
    }),
  ],
})

これにより、フォントアセットがpublic/assets/fontsにダウンロードされ、クライアントの/assets/fontsから提供されます。これを行う際は、フォントのライセンスが再配布を許可していることを確認してください。このツールは法的な問題について責任を負いません。

INFO

この機能はNode.js固有のものであり、ブラウザでは動作しません。