Font Module

这个 API 参考将帮助你了解如何使用 next/font/google 和 next/font/local。关于功能和用法，请查看 优化字体 页面。

字体函数参数

关于用法，请查看 Google 字体 和 本地字体。

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 的两个值数组 - 值来自 normal 和 italic

subsets

字体的 subsets，由字符串数组定义，每个字符串表示你想要 预加载 的子集名称。当 preload 选项为 true 时 (默认值)，通过 subsets 指定的字体将在头部注入一个链接预加载标签。

用于 next/font/google

• 可选

示例：

• subsets: ['latin']：包含 latin 子集的数组

你可以在 Google Fonts 页面上找到你的字体的所有子集列表。

axes

一些可变字体有额外的 axes 可以包含。默认情况下，只包含字体权重以保持文件大小较小。axes 的可能值取决于特定的字体。

用于 next/font/google

• 可选

示例：

• axes: ['slnt']：包含 slnt 值的数组，用于 Inter 可变字体，它有 slnt 作为额外的 axes，如 这里 所示。你可以通过在 Google 可变字体页面 上使用过滤器，并查找除 wght 之外的轴来找到你的字体的可能 axes 值

display

字体的 display，可能的字符串 值 为 'auto'、'block'、'swap'、'fallback' 或 'optional'，默认值为 'swap'。

用于 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：一个布尔值，设置是否使用自动备用字体来减少 累积布局偏移。默认值为 true。
• 对于 next/font/local：一个字符串或布尔值 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%' }]

应用样式

你可以通过三种方式应用字体样式：

• className
• style
• CSS 变量

className

返回一个只读的 CSS className，用于加载的字体，可以传递给 HTML 元素。

<p className={inter.className}>你好，Next.js！</p>

style

返回一个只读的 CSS style 对象，用于加载的字体，可以传递给 HTML 元素，包括 style.fontFamily 以访问字体族名称和备用字体。

<p style={inter.style}>你好，世界</p>

CSS 变量

如果你想在外部样式表中设置样式并在那里指定其他选项，请使用 CSS 变量方法。

除了导入字体外，还要导入定义 CSS 变量的 CSS 文件，并按如下方式设置字体加载器对象的变量选项：

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}>你好，世界</p>
</main>

在 component.module.css CSS 文件中定义 text 选择器类如下：

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

在上面的例子中，文本 "你好，世界" 使用 Inter 字体和生成的字体备用进行样式设置，font-weight: 200 和 font-style: italic。

使用字体定义文件

每次调用 localFont 或 Google 字体函数时，该字体将作为一个实例托管在你的应用程序中。因此，如果你需要在多个地方使用相同的字体，你应该在一个地方加载它，并在需要的地方导入相关的字体对象。这是通过使用字体定义文件来完成的。

例如，在你的 app 目录的根目录下的 styles 文件夹中创建一个 fonts.ts 文件。

然后，按如下方式指定你的字体定义：

import { Inter, Lora, Source_Sans_3 } from "next/font/google";
import localFont from "next/font/local";
 
// 定义你的可变字体
const inter = Inter();
const lora = Lora();
// 定义一个非可变字体的 2 种粗细
const sourceCodePro400 = Source_Sans_3({ weight: "400" });
const sourceCodePro700 = Source_Sans_3({ weight: "700" });
// 定义一个自定义本地字体，其中 GreatVibes-Regular.ttf 存储在 styles 文件夹中
const greatVibes = localFont({ src: "./GreatVibes-Regular.ttf" });
 
export { inter, lora, sourceCodePro400, sourceCodePro700, greatVibes };

import { Inter, Lora, Source_Sans_3 } from "next/font/google";
import localFont from "next/font/local";
 
// 定义你的可变字体
const inter = Inter();
const lora = Lora();
// 定义一个非可变字体的 2 种粗细
const sourceCodePro400 = Source_Sans_3({ weight: "400" });
const sourceCodePro700 = Source_Sans_3({ weight: "700" });
// 定义一个自定义本地字体，其中 GreatVibes-Regular.ttf 存储在 styles 文件夹中
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}>使用 Inter 字体的 Hello world</p>
      <p style={lora.style}>使用 Lora 字体的 Hello world</p>
      <p className={sourceCodePro700.className}>
        使用粗细为 700 的 Source_Sans_3 字体的 Hello world
      </p>
      <p className={greatVibes.className}>使用 Great Vibes 字体的标题</p>
    </div>
  );
}

为了更方便地在你的代码中访问字体定义，你可以在 tsconfig.json 或 jsconfig.json 文件中定义一个路径别名，如下所示：

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

现在你可以按如下方式导入任何字体定义：

import { greatVibes, sourceCodePro400 } from "@/fonts";

版本变更