File size: 1,951 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
---
title: mdx-components.js
description: API reference for the mdx-components.js file.
related:
title: Learn more about MDX Components
links:
- app/guides/mdx
---
The `mdx-components.js|tsx` file is **required** to use [`@next/mdx` with App Router](/docs/app/guides/mdx) and will not work without it. Additionally, you can use it to [customize styles](/docs/app/guides/mdx#using-custom-styles-and-components).
Use the file `mdx-components.tsx` (or `.js`) in the root of your project to define MDX Components. For example, at the same level as `pages` or `app`, or inside `src` if applicable.
```tsx filename="mdx-components.tsx" switcher
import type { MDXComponents } from 'mdx/types'
export function useMDXComponents(components: MDXComponents): MDXComponents {
return {
...components,
}
}
```
```js filename="mdx-components.js" switcher
export function useMDXComponents(components) {
return {
...components,
}
}
```
## Exports
### `useMDXComponents` function
The file must export a single function, either as a default export or named `useMDXComponents`.
```tsx filename="mdx-components.tsx" switcher
import type { MDXComponents } from 'mdx/types'
export function useMDXComponents(components: MDXComponents): MDXComponents {
return {
...components,
}
}
```
```js filename="mdx-components.js" switcher
export function useMDXComponents(components) {
return {
...components,
}
}
```
## Params
### `components`
When defining MDX Components, the export function accepts a single parameter, `components`. This parameter is an instance of `MDXComponents`.
- The key is the name of the HTML element to override.
- The value is the component to render instead.
> **Good to know**: Remember to pass all other components (i.e. `...components`) that do not have overrides.
## Version History
| Version | Changes |
| --------- | -------------------- |
| `v13.1.2` | MDX Components added |
|