跳至內容
API 參考檔案慣例mdx-components.js

mdx-components.js

mdx-components.js|tsx 檔案是 使用 @next/mdx 搭配 App Router 的必要檔案,沒有它將無法運作。此外,您也可以使用它來自訂樣式

在專案的根目錄中使用 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 元件