フォントモジュール

このAPIリファレンスは、next/font/googleとnext/font/localの使用方法を理解するのに役立ちます。機能と使用方法については、「フォントの最適化」ページを参照してください。

フォント関数引数

使用方法については、Google Fontsとローカルフォントを確認してください。

src

フォントローダー関数が呼び出されるディレクトリからの相対パスとして、フォントファイルのパスを文字列またはオブジェクトの配列（型はArray<{path: string, weight?: string, style?: string}>）で指定します。

next/font/localで使用

• 必須

例

• src:'./fonts/my-font.woff2'（my-font.woff2はappディレクトリ内のfontsという名前のディレクトリに配置されています）
• src:[{path: './inter/Inter-Thin.ttf', weight: '100',},{path: './inter/Inter-Regular.ttf',weight: '400',},{path: './inter/Inter-Bold-Italic.ttf', weight: '700',style: 'italic',},]
• フォントローダー関数がapp/page.tsxでsrc:'../styles/fonts/my-font.ttf'を使って呼び出される場合、my-font.ttfはプロジェクトのルートにあるstyles/fontsに配置されます

weight

フォントのweightには以下の可能性があります

• 特定のフォントで利用可能なウェイトの可能な値、またはそれが可変フォントである場合は値の範囲を示す文字列
• フォントが可変Googleフォントでない場合のウェイト値の配列。next/font/googleにのみ適用されます。

next/font/googleとnext/font/localで使用

• 使用するフォントが可変でない場合は必須

例

• weight: '400': 単一のウェイト値の文字列 - フォントInterの場合、可能な値は'100'、'200'、'300'、'400'、'500'、'600'、'700'、'800'、'900'、または'variable'です（'variable'がデフォルトです）
• weight: '100 900': 可変フォントの場合の100から900までの範囲を示す文字列
• weight: ['100','400','900']: 非可変フォントの場合の3つの可能な値の配列

style

フォントのstyleには以下の可能性があります

• デフォルト値が'normal'である文字列値
• フォントが可変Googleフォントでない場合のスタイル値の配列。next/font/googleにのみ適用されます。

next/font/googleとnext/font/localで使用

• オプション

例

• style: 'italic': 文字列 - next/font/googleではnormalまたはitalicを指定できます
• style: 'oblique': 文字列 - next/font/localでは任意の値を取ることができますが、標準のフォントスタイルから来ることが期待されます
• style: ['italic','normal']: next/font/googleの2つの値の配列 - 値はnormalとitalicです

subsets

プリロードしたい各サブセットの名前を含む文字列値の配列によって定義されるフォントのsubsets。subsetsを介して指定されたフォントは、preloadオプションがtrue（デフォルト）の場合、headにリンクプリロードタグが挿入されます。

next/font/googleで使用

• オプション

例

• subsets: ['latin']: サブセットlatinを含む配列

お使いのフォントのGoogle Fontsページで、すべてのサブセットのリストを見つけることができます。

axes

一部の可変フォントには、含めることができる追加のaxesがあります。デフォルトでは、ファイルサイズを抑えるためにフォントウェイトのみが含まれます。axesの可能な値は、特定のフォントによって異なります。

next/font/googleで使用

• オプション

例

• axes: ['slnt']: Inter可変フォントのslnt値を持つ配列。このフォントにはこちらに示すようにslntが追加のaxesとして含まれています。お使いのフォントの可能なaxes値は、Google可変フォントページのフィルターを使用し、wght以外のaxesを探すことで見つけることができます。

display

フォントのdisplayは、デフォルト値が'swap'で、'auto'、'block'、'swap'、'fallback'、または'optional'の文字列値を取ることができます。

next/font/googleとnext/font/localで使用

• オプション

例

• display: 'optional': optional値に割り当てられる文字列

preload

フォントをプリロードするかどうかを指定するブール値。デフォルトはtrueです。

next/font/googleとnext/font/localで使用

• オプション

例

• preload: false

fallback

フォントを読み込めない場合に使用するフォールバックフォント。デフォルト値なしのフォールバックフォントの文字列配列です。

• オプション

next/font/googleとnext/font/localで使用

例

• fallback: ['system-ui', 'arial']: フォールバックフォントをsystem-uiまたはarialに設定する配列

adjustFontFallback

• next/font/googleの場合: Cumulative Layout Shiftを減らすために自動フォールバックフォントを使用するかどうかを設定するブール値。デフォルトはtrueです。
• next/font/localの場合: Cumulative Layout Shiftを減らすために自動フォールバックフォントを使用するかどうかを設定する文字列またはブール値false。可能な値は'Arial'、'Times New Roman'、またはfalseです。デフォルトは'Arial'です。

next/font/googleとnext/font/localで使用

• オプション

例

• adjustFontFallback: false: next/font/googleの場合
• adjustFontFallback: 'Times New Roman': next/font/localの場合

variable

スタイルがCSS変数メソッドで適用される場合に使用するCSS変数名を定義する文字列値。

next/font/googleとnext/font/localで使用

• オプション

例

• variable: '--my-font': CSS変数--my-fontが宣言されます

declarations

生成された@font-faceをさらに定義する、フォントフェイス記述子のキーと値のペアの配列。

next/font/localで使用

• オプション

例

• declarations: [{ prop: 'ascent-override', value: '90%' }]

スタイルの適用

フォントスタイルは3つの方法で適用できます

• className
• style
• CSS変数

className

読み込まれたフォントの読み取り専用CSS classNameを返します。これはHTML要素に渡すことができます。

<p className={inter.className}>Hello, Next.js!</p>

style

読み込まれたフォントの読み取り専用CSS styleオブジェクトを返します。これには、フォントファミリー名とフォールバックフォントにアクセスするためのstyle.fontFamilyが含まれます。

<p style={inter.style}>Hello World</p>

CSS変数

スタイルを外部スタイルシートで設定し、追加オプションを指定したい場合は、CSS変数メソッドを使用してください。

フォントをインポートするだけでなく、CSS変数が定義されているCSSファイルもインポートし、フォントローダーオブジェクトのvariableオプションを次のように設定します

import { Inter } from 'next/font/google'
import styles from '../styles/component.module.css'
 
const inter = Inter({
  variable: '--font-inter',
})

フォントを使用するには、スタイルを適用したいテキストの親コンテナのclassNameをフォントローダーのvariable値に設定し、テキストのclassNameを外部CSSファイルからのstylesプロパティに設定します。

<main className={inter.variable}>
  <p className={styles.text}>Hello World</p>
</main>

component.module.cssというCSSファイルで、textセレクタクラスを次のように定義します

.text {
  font-family: var(--font-inter);
  font-weight: 200;
  font-style: italic;
}

上記の例では、テキストHello WorldはInterフォントと生成されたフォントフォールバックを使用して、font-weight: 200およびfont-style: italicでスタイルが適用されています。

フォント定義ファイルの使用

localFontまたはGoogleフォント関数を呼び出すたびに、そのフォントはアプリケーション内で1つのインスタンスとしてホストされます。したがって、複数の場所で同じフォントを使用する必要がある場合は、一箇所で読み込み、必要な場所で関連するフォントオブジェクトをインポートする必要があります。これはフォント定義ファイルを使用して行われます。

たとえば、appディレクトリのルートにあるstylesフォルダにfonts.tsファイルを作成します。

次に、次のようにフォント定義を指定します

import { Inter, Lora, Source_Sans_3 } from 'next/font/google'
import localFont from 'next/font/local'
 
// define your variable fonts
const inter = Inter()
const lora = Lora()
// define 2 weights of a non-variable font
const sourceCodePro400 = Source_Sans_3({ weight: '400' })
const sourceCodePro700 = Source_Sans_3({ weight: '700' })
// define a custom local font where GreatVibes-Regular.ttf is stored in the styles folder
const greatVibes = localFont({ src: './GreatVibes-Regular.ttf' })
 
export { inter, lora, sourceCodePro400, sourceCodePro700, greatVibes }

これで、これらの定義をコードで次のように使用できます

import { inter, lora, sourceCodePro700, greatVibes } from '../styles/fonts'
 
export default function Page() {
  return (
    <div>
      <p className={inter.className}>Hello world using Inter font</p>
      <p style={lora.style}>Hello world using Lora font</p>
      <p className={sourceCodePro700.className}>
        Hello world using Source_Sans_3 font with weight 700
      </p>
      <p className={greatVibes.className}>My title in Great Vibes font</p>
    </div>
  )
}

コードでフォント定義にアクセスしやすくするために、tsconfig.jsonまたはjsconfig.jsonファイルで次のようにパスエイリアスを定義できます

{
  "compilerOptions": {
    "paths": {
      "@/fonts": ["./styles/fonts"]
    }
  }
}

これで、次のように任意のフォント定義をインポートできます

import { greatVibes, sourceCodePro400 } from '@/fonts'

バージョン変更