跳到内容
API 参考文件约定mdx-components.js

mdx-components.js

mdx-components.js|tsx 文件是必需的,才能在 App Router 中使用 @next/mdx,否则将无法工作。此外,你可以使用它来自定义样式

在你的项目根目录中使用文件 mdx-components.tsx (或 `.js`) 来定义 MDX 组件。例如,与 pagesapp 同级,或者在 src 内部(如果适用)。

mdx-components.tsx
import type { MDXComponents } from 'mdx/types'
 
export function useMDXComponents(components: MDXComponents): MDXComponents {
  return {
    ...components,
  }
}

导出

useMDXComponents 函数

该文件必须导出一个函数,可以是默认导出或命名为 useMDXComponents

mdx-components.tsx
import type { MDXComponents } from 'mdx/types'
 
export function useMDXComponents(components: MDXComponents): MDXComponents {
  return {
    ...components,
  }
}

参数

components

当定义 MDX 组件时,导出函数接受一个参数 components。此参数是 MDXComponents 的一个实例。

  • 键是要覆盖的 HTML 元素的名称。
  • 值是要替换渲染的组件。

须知:请记住传递所有其他没有覆盖的组件(即 ...components)。

版本历史

版本变更
v13.1.2添加了 MDX 组件