Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ipikuka/next-mdx-remote-client
A wrapper of the `@mdx-js/mdx` for the `nextjs` applications in order to load MDX content. It is a fork of `next-mdx-remote`.
https://github.com/ipikuka/next-mdx-remote-client
mdx-js next-mdx next-mdx-remote next-mdx-remote-client nextjs
Last synced: 8 days ago
JSON representation
A wrapper of the `@mdx-js/mdx` for the `nextjs` applications in order to load MDX content. It is a fork of `next-mdx-remote`.
- Host: GitHub
- URL: https://github.com/ipikuka/next-mdx-remote-client
- Owner: ipikuka
- License: mpl-2.0
- Created: 2024-02-29T10:43:48.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-12T18:31:22.000Z (5 months ago)
- Last Synced: 2024-10-21T04:29:23.521Z (18 days ago)
- Topics: mdx-js, next-mdx, next-mdx-remote, next-mdx-remote-client, nextjs
- Language: TypeScript
- Homepage: https://next-mdx-remote-client-in-pages-router.vercel.app/
- Size: 683 KB
- Stars: 48
- Watchers: 0
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# next-mdx-remote-client
[![NPM version][badge-npm-version]][npm-package-url]
[![NPM downloads][badge-npm-download]][npm-package-url]
[![Build][badge-build]][github-workflow-url]
[](https://codecov.io/gh/ipikuka/next-mdx-remote-client)
[](https://github.com/ipikuka/next-mdx-remote-client)
[![typescript][badge-typescript]][typescript-url]
[![License][badge-license]][github-license-url]
The **`next-mdx-remote-client`** is a wrapper of **`@mdx-js/mdx`** for **`nextjs`** applications in order to load MDX content. It is a fork of **`next-mdx-remote`**.
See some blog applications in which **`next-mdx-remote-client`** is used:
+ for a **demo application** which uses **`app` router**, visit [source code](https://github.com/talatkuyuk/next-mdx-remote-client-in-app-router) or [living web site](https://next-mdx-remote-client-in-app-router.vercel.app/)
+ for a **demo application** which uses **`pages` router**, visit [source code](https://github.com/talatkuyuk/next-mdx-remote-client-in-pages-router) or [living web site](https://next-mdx-remote-client-in-pages-router.vercel.app/)
+ for a **testing application** which uses **both `app` and `pages` router**, visit [source code](https://github.com/talatkuyuk/testing-app-for-next-mdx-remote-client) or [living web site](https://testing-app-for-next-mdx-remote-client.vercel.app/)
## Why `next-mdx-remote-client` ?
I started to create the **`next-mdx-remote-client`** in line with the mindset of the **`@mdx-js/mdx`** in early 2024 considering [next-mdx-remote][next-mdx-remote] had not been updated for a long time, and finally, a brand new package emerged.
The **`next-mdx-remote-client`** serves as a **viable alternative** to **`next-mdx-remote`** having **more features**.
**I would like to highlight some main features:**
+ It supports MDX version 3.
+ It provides well designed components and functions for both "pages" router and "app" router, which completely isolated from eachother.
+ It provides internal error handling mechanism.
+ It supports `import statements` and `export statements` in MDX source, which can be disabled as well.
+ Creating table of contents (TOC) is so easy since it supports passing `vfile.data` into the `scope`.
+ You can get frontmatter without compilng the source while listing the articles/posts via a util `getFrontmatter`.
+ It exports some components and types from `@mdx-js/mdx` so as you don't need to install.
Let's compare the features of **`next-mdx-remote`** and **`next-mdx-remote-client`**.
| Features | `next-mdx-remote` | `next-mdx-remote-client` |
| :---------------------------------------------------------- | :-----------------: | :----------------------: |
| support MDX version 3 | ✅
_(as of v5)_| ✅ |
| ensure internal error handling mechanism in `app` router | ❌ | ✅ |
| ensure internal error handling mechanism in `pages` router | ❌ | ✅ |
| support _export-from-MDX_ in `app` router | ❌ | ✅ |
| support _export-from-MDX_ in `pages` router | ❌ | ✅ |
| support _import-into-MDX_ in `app` router | ❌ | ✅ |
| support _import-into-MDX_ in `pages` router | ❌ | ❌ |
| get frontmatter and mutated scope in `app` router | ❌ | ✅ |
| get frontmatter and mutated scope in `pages` router | ✅ | ✅ |
| support options for disabling imports and exports in MDX | ✅ | ✅ |
| support passing `vfile.data` into the `scope` | ❌ | ✅ |
| provide utility for getting frontmatter without compiling | ❌ | ✅ |
| expose `MDXProvider` from `@mdx-js/mdx` | ❌ | ✅ |
| provide option for disabling parent `MDXProvider` contexts | ❌ | ✅ |
| expose the necessary types from `mdx/types` | ❌ | ✅ |
> [!IMPORTANT]
> You will see a lot the abbreviatons **`csr`** and **`rsc`**. _Pay attention to the both are spelled backwards._\
> \
> **`csr`** stands for "client side rendering" which is related with **`pages`** router\
> **`rsc`** stands for "react server component" which is related with **`app`** router
## General considerations about development
- It is ESM only package
- Needs react version 18.2+, works with latest nextjs ^13.5.6 and ^14.2.4 versions (tested)
- Needs node version 18.17+ as inline with nextjs does
- Vitest is used instead of jest for testing
- Rollup is removed for bundling
- Test coverage is 100%
- Type coverage is 100%
- The parts client side (csr) and server side (rsc) are completely isolated from each other
- Exported a small utility to get frontmatter without compiling the source
- **All functions take named parameters**
- Supports `import statements` and `export statements` in the MDX
- Export statements in MDX work for **both** `app` and `pages` router
- Import statements in MDX work for **only** `app` router
> [!IMPORTANT]
> **Imported modules in MDX with relative path should be transpiled into javascript before or during build process, otherwise will not work.** I believe the community can find a solution to import reqular **`.jsx`** or **`.tsx`** modules into MDX. With the support of the **`next/mdx`**, it is viable to import **`.mdx`** into the MDX, but not tested yet.
## Installation
This package is ESM only, requires Node.js (version 18.17+).
```bash
npm install next-mdx-remote-client
```
or
```bash
yarn add next-mdx-remote-client
```
> [!WARNING]
> The `next-mdx-remote` users may follow the [migration guide](/migration_guide.md).
## The package's exported subpaths
The main entry point **`/`** also refers to **`/csr`** subpath.
```typescript
// main entry point, which is related "pages" router
import /* */ from "next-mdx-remote-client";
// isolated subpath for the "serialize" function
import /* */ from "next-mdx-remote-client/serialize";
// sub entry point related with "pages" router
import /* */ from "next-mdx-remote-client/csr";
// sub entry point related with "app" router
import /* */ from "next-mdx-remote-client/rsc";
// isolated subpath for the utils
import /* */ from "next-mdx-remote-client/utils";
```
## The part associated with Next.js `app` router
_Go to [the part associated with Next.js pages router](#the-part-associated-with-nextjs-pages-router)_
The `next-mdx-remote-client` exposes **`evaluate`** function and **`MDXRemote`** component for "app" router.
```typescript
import { evaluate, MDXRemote } from "next-mdx-remote-client/rsc";
```
> [!TIP]
> If you need to get the **exports** from MDX --> use **`evaluate`**\
> If you don't need --> use **`MDXRemote`**\
> \
> If you need to get the **frontmatter** and the **mutated scope** --> use **`evaluate`**\
> If you don't need --> use **`MDXRemote`**
Let's give some examples how to use `next-mdx-remote-client` in "app" router first, then explain the exposed function and component.
### Examples for `app` router
See a **demo application** with **`app` router**, visit [source code](https://github.com/talatkuyuk/next-mdx-remote-client-in-app-router) or [living web site](https://next-mdx-remote-client-in-app-router.vercel.app/)
#### An example with `javascript`
```jsx
import { Suspense } from "react";
import { MDXRemote } from "next-mdx-remote-client/rsc";
import { ErrorComponent, LoadingComponent } from "../components";
import { Test } from '../mdxComponents';
const components = {
Test,
wrapper: ({ children }) =>
{children},
}
export default async function Page() {
const source = "Some **bold text** in MDX, with a component ";
return (
}>
);
};
```
#### An example with `typescript`, parsing frontmatter and providing custom data with scope
```tsx
import { Suspense } from "react";
import { MDXRemote } from "next-mdx-remote-client/rsc";
import type { MDXRemoteOptions, MDXComponents } from "next-mdx-remote-client/rsc";
import { calculateSomeHow, getSourceSomeHow } from "../utils";
import { ErrorComponent, LoadingComponent } from "../components";
import { Test } from '../mdxComponents';
const components: MDXComponents = {
Test,
wrapper: function ({ children }: React.ComponentPropsWithoutRef<"div">) {
return
{children};
},
}
export default async function Page() {
const source = await getSourceSomeHow();
if (!source) {
return ;
}
const options: MDXRemoteOptions = {
mdxOptions: {
// ...
},
parseFrontmatter: true,
scope: {
readingTime: calculateSomeHow(source),
},
};
return (
}>
);
}
```
#### An example with creating a table of contents (TOC)
I assume you have a MDX file having `` inside; and you provide some MDX components which have an entry for `TableOfContentComponent: (props) => { ... }`.
```markdown
---
title: My Article
---
# {frontmatter.title}
rest of the article...
```
You can have a look at an example [TOC component](https://github.com/talatkuyuk/next-mdx-remote-client-in-app-router/blob/main/mdxComponents/Toc.tsx) in the demo application.
In order to create a table of contents (TOC) I use `remark-flexible-toc` in the remark plugin list and pass the table of contents objects `vFile.data.toc` into the `scope` via the option `vfileDataIntoScope`. That's it ! So easy !
```tsx
import { Suspense } from "react";
import { MDXRemote, type MDXRemoteOptions } from "next-mdx-remote-client/rsc";
import remarkFlexibleToc from "remark-flexible-toc"; // <---------
import { calculateSomeHow, getSourceSomeHow } from "../utils";
import { ErrorComponent, LoadingComponent } from "../components";
import { components } from '../mdxComponents';
export default async function Page() {
const source = await getSourceSomeHow();
if (!source) {
return ;
}
const options: MDXRemoteOptions = {
mdxOptions: {
remarkPlugins: [
// ...
remarkFlexibleToc, // <---------
],
},
parseFrontmatter: true,
scope: {
readingTime: calculateSomeHow(source),
},
vfileDataIntoScope: "toc", // <---------
};
return (
}>
);
}
```
#### An example with using "frontmatter" and "scope" in JSX in "app" router
```tsx
import { Suspense } from "react";
import { evaluate, type EvaluateOptions } from "next-mdx-remote-client/rsc";
import remarkFlexibleToc, { type TocItem } from "remark-flexible-toc";
import { calculateSomeHow, getSourceSomeHow } from "../utils";
import { ErrorComponent, LoadingComponent, TableOfContentComponent } from "../components";
import { components } from "../mdxComponents";
type Scope = {
readingTime: string;
toc?: TocItem[];
};
type Frontmatter = {
title: string;
author: string;
};
export default async function Page() {
const source = await getSourceSomeHow();
if (!source) {
return ;
}
const options: EvaluateOptions = {
mdxOptions: {
remarkPlugins: [
// ...
remarkFlexibleToc,
],
},
parseFrontmatter: true,
scope: {
readingTime: calculateSomeHow(source),
},
vfileDataIntoScope: "toc",
};
const { content, frontmatter, scope, error } = await evaluate({
source,
options,
components,
});
if (error) {
return ;
}
return (
<>
{frontmatter.title}
Written by {frontmatter.author}; read in {scope.readingTime}
}>
{content}
>
);
}
```
Actually, you may not need to access the "frontmatter" and "scope" in JSX, you can use them within MDX directly, and return just `content` only.
```tsx
// ...
export default async function Page({ source }: Props) {
// ...
return (
}>
{content}
);
}
```
_article.mdx_
```markdown
# {frontmatter.title}
Written by {frontmatter.author}; read in {readingTime}
rest of the article...
```
After the examples given, let's dive into the exposed function and component by `next-mdx-remote-client` for "app" router.
### The `evaluate` function
_Go to the [MDXRemote](#the-mdxremote-component) component_
The `evaluate` function is used for compiling the **MDX source**, constructing the **compiled source**, getting exported information from MDX and returning MDX content to be rendered on the server side, as a react server component.
```typescript
async function evaluate(props: EvaluateProps): Promise {}
```
The `evaluate` function takes `EvaluateProps` and returns `EvaluateResult` as a promise.
**Props of the `evaluate` function**
```typescript
type EvaluateProps = {
source: Compatible;
options?: EvaluateOptions;
components?: MDXComponents;
};
```
**Result of the `evaluate` function**
```typescript
type EvaluateResult = {
content: JSX.Element;
mod: Record;
frontmatter: TFrontmatter;
scope: TScope;
error?: Error;
};
```
The `evaluate` has **internal error handling mechanism** as much as it can, in order to do so, it returns an **`error`** object if it is catched.
> [!CAUTION]
> The eval of the compiled source returns a module `MDXModule`, and does not throw errors except syntax errors. Some errors throw during the render process which needs you to use an **ErrorBoundary**.
```tsx
import { Suspense } from "react";
import { evaluate, type EvaluateOptions } from "next-mdx-remote-client/rsc";
import { ErrorComponent, LoadingComponent, TableOfContentComponent } from "../components";
import { components } from "../mdxComponents";
import type { Frontmatter, Scope } from "../types"
export default async function MDXComponent({ source }: {source?: string}) {
if (!source) {
return ;
}
const options: EvaluateOptions = {
/* */
};
const { content, mod, frontmatter, scope, error } = await evaluate({
source,
options,
components,
});
if (error) {
return ;
}
/**
* Use "mod", "frontmatter" and "scope" as you wish
*
* "mod" object is for exported information from MDX
* "frontmatter" is available even if a MDX syntax error occurs
* "scope" is for mutated scope if the `vfileDataIntoScope` option is used
*/
return (
<>
{frontmatter.title}
{mod.something}
}>
{content}
>
);
};
```
If you provide **the generic type parameters** like `await evaluate(){}`, the `frontmatter` and the `scope` get the types, otherwise `Record` by default for both.
> [!WARNING]
> Pay attention to the order of the generic type parameters.\
> \
> The type parameters `Frontmatter` and `Scope` should extend `Record`. You should use **`type`** instead of **`interface`** for type parameters otherwise, you will receive an error saying `Type 'Xxxx' does not satisfy the constraint 'Record'.` See this [issue](https://github.com/ipikuka/next-mdx-remote-client/issues/2) for more explanation.
In the above example, I assume you use **`remark-flexible-toc`** remark plugin in order to collect the headings from the MDX content, and you pass that information into the `scope` via `vfileDataIntoScope` option.
### The evaluate options (`EvaluateOptions`)
All options are optional.
```typescript
type EvaluateOptions = {
mdxOptions?: EvaluateMdxOptions;
disableExports?: boolean;
disableImports?: boolean;
parseFrontmatter?: boolean;
scope?: TScope;
vfileDataIntoScope?: VfileDataIntoScope;
};
```
#### `mdxOptions`
It is an **`EvaluateMdxOptions`** option to be passed to the `@mdx-js/mdx` compiler.
```typescript
import { type EvaluateOptions as OriginalEvaluateOptions } from "@mdx-js/mdx";
type EvaluateMdxOptions = Omit<
OriginalEvaluateOptions,
| "Fragment"
| "jsx"
| "jsxs"
| "jsxDEV"
| "useMDXComponents"
| "providerImportSource"
| "outputFormat"
>;
```
As you see, some of the options are omitted and opinionated within the package. For example the `outputFormat` is always `function-body` by default. Visit https://mdxjs.com/packages/mdx/#evaluateoptions for available mdxOptions.
```typescript
const options: EvaluateOptions = {
// ...
mdxOptions: {
format: "mdx",
baseUrl: import.meta.url,
development: true,
remarkPlugins: [/* */],
rehypePlugins: [/* */],
recmaPlugins: [/* */],
remarkRehypeOptions: {handlers: {/* */}},
// ...
};
};
```
For more information see [the MDX documentation](https://github.com/mdx-js/mdx/blob/master/packages/mdx/index.js).
#### `disableExports`
It is a **boolean** option whether or not stripping the `export statements` out from the MDX source.
By default it is **false**, meaningly the `export statements` work as expected.
```typescript
const options: EvaluateOptions = {
disableExports: true;
};
```
Now, the `export statements` will be stripped out from the MDX.
#### `disableImports`
It is a **boolean** option whether or not stripping the `import statements` out from the MDX source.
By default it is **false**, meaningly the `import statements` work as expected.
```typescript
const options: EvaluateOptions = {
disableImports: true;
};
```
Now, the `import statements` will be stripped out from the MDX.
#### `parseFrontmatter`
It is a **boolean** option whether or not the frontmatter should be parsed out of the MDX.
By default it is **false**, meaningly the `frontmatter` will not be parsed and extracted.
```typescript
const options: EvaluateOptions = {
parseFrontmatter: true;
};
```
Now, the `frontmatter` part of the MDX file is parsed and extracted from the MDX source; and will be supplied into the MDX file so as you to use it within the javascript statements.
> [!NOTE]
> Frontmatter is a way to identify metadata in Markdown files. Metadata can literally be anything you want it to be, but often it's used for data elements your page needs and you don't want to show directly.
```mdx
---
title: "My Article"
author: "ipikuka"
---
# {frontmatter.title}
It is written by {frontmatter.author}
```
The package uses the `vfile-matter` internally to parse the frontmatter.
#### `scope`
It is an **`Record`** option which is an arbitrary object of data which will be supplied to the MDX. For example, in cases where you want to provide template variables to the MDX, like `my name is {name}`, you could provide scope as `{ name: "ipikuka" }`.
Here is another example:
```typescript
const options: EvaluateOptions = {
scope: {
readingTime: calculateSomeHow(source)
};
};
```
Now, the `scope` will be supplied into the MDX file so as you to use it within the statements.
```markdown
# My article
read in {readingTime} min.
```
The variables within the expression in the MDX content should be valid javascript variable names. **Therefore, each key of the scope must be a valid variable name.**
```markdown
My name is {name} valid expression.
My name is {my-name} is not valid expression, which will throw error
```
So, we can say for the `scope`, here:
```typescript
const options: EvaluateOptions = {
scope: {
name: "ipikuka", // valid usage
"my-name": "ipikuka", // is not valid and error prone for the MDX content !!!
};
};
```
> [!TIP]
> The scope variables can be consumed not only as a property of a component, but also within the texts.
```mdx
my name is {name}
```
#### `vfileDataIntoScope`
It is an **union** type option. It is for passing some fields of `vfile.data` into the `scope` by mutating the `scope`.
> [!IMPORTANT]
> It provides referencial copy for objects and arrays. If the `scope` has the same key already, `vfile.data` overrides it.
The reason behind of this option is that `vfile.data` may hold some extra information added by some remark plugins. Some fields of the `vfile.data` may be needed to pass into the `scope` so as you to use in the MDX.
```typescript
type VfileDataIntoScope =
| true // all fields from vfile.data
| string // one specific field
| { name: string; as: string } // one specific field but change the key as
| Array; // more than one field
```
```typescript
const options: EvaluateOptions = {
// Let's assume you use "remark-flexible-toc" plugin which composes
// the table of content (TOC) within the 'vfile.data.toc'
vfileDataIntoScope: "toc"; // or fileDataIntoScope: ["toc"];
};
```
Now, `vfile.data.toc` is copied into the scope as `scope["toc"]`, and will be supplied to the MDX via `scope`.
```mdx
# My article
```
If you need to change the name of the field, specify it for example `{ name: "toc", as: "headings" }`.
```typescript
const options: EvaluateOptions = {
vfileDataIntoScope: { name: "toc", as: "headings" };
};
```
```mdx
# My article
```
If you need to pass all the fields from `vfile.data`, specify it as `true`
```typescript
const options: EvaluateOptions = {
vfileDataIntoScope: true;
};
```
### The `MDXRemote` component
_Go to the [evaluate](#the-evaluate-function) function_
The `MDXRemote` component is used for rendering the MDX content on the server side. It is a react server component.
```typescript
async function MDXRemote(props: MDXRemoteProps): Promise {}
```
The `MDXRemote` component takes `MDXRemoteProps` and returns `JSX.Element` as a promise.
**Props of the `MDXRemote` component**
```typescript
type MDXRemoteProps = {
source: Compatible;
options?: MDXRemoteOptions;
components?: MDXComponents;
onError?: React.ComponentType<{ error: Error }>
};
```
The `MDXRemote` has **internal error handling mechanism** as much as it can, in order to do so, it takes **`onError`** prop in addition to `evaluate` function.
> [!CAUTION]
> The eval of the compiled source returns a module `MDXModule`, and does not throw errors except syntax errors. Some errors throw during the render process which needs you to use an **ErrorBoundary**.
```tsx
import { Suspense } from "react";
import { MDXRemote, type MDXRemoteOptions } from "next-mdx-remote-client/rsc";
import { ErrorComponent, LoadingComponent } from "../components";
import { components } from "../mdxComponents";
export default async function MDXComponent({ source }: {source?: string}) {
if (!source) {
return ;
}
const options: MDXRemoteOptions = {
/* */
};
return (
}>
);
};
```
### The MDXRemote options (`MDXRemoteOptions`)
All options are optional.
```typescript
type MDXRemoteOptions = {
mdxOptions?: EvaluateMdxOptions;
disableExports?: boolean;
disableImports?: boolean;
parseFrontmatter?: boolean;
scope?: TScope;
vfileDataIntoScope?: VfileDataIntoScope;
};
```
The details are the same with the [EvaluateOptions](#the-evaluate-options-evaluateoptions).
## The part associated with Next.js `pages` router
_Go to [the part associated with Next.js app router](#the-part-associated-with-nextjs-app-router)_
The `next-mdx-remote-client` exposes **`serialize`**, **`hydrate`** functions and **`MDXClient`** component for "pages" router.
The `serialize` function is used on the server side in "pages" router, while as the `hydrate` and the `MDXClient` are used on the client side in "pages" router. That is why the "serialize" function is purposefully isolated considering it is intended to run on the server side.
Let's give some examples how to use `next-mdx-remote-client` in "pages" router first, then explain the exposed functions and component.
### Examples for `pages` router
See a **demo application** with **`pages` router**, visit [source code](https://github.com/talatkuyuk/next-mdx-remote-client-in-pages-router) or [living web site](https://next-mdx-remote-client-in-pages-router.vercel.app/)
#### An example with `javascript`
```jsx
import { serialize } from 'next-mdx-remote-client/serialize';
import { MDXClient } from 'next-mdx-remote-client';
import ErrorComponent from '../components/ErrorComponent';
import Test from '../mdxComponents/Test';
const components = {
Test,
wrapper: ({children}) =>
{children},
}
export default function Page({ mdxSource }) {
if ("error" in mdxSource) {
return ;
}
return ;
}
export async function getStaticProps() {
const source = "Some **bold text** in MDX, with a component ";
const mdxSource = await serialize({source});
return { props: { mdxSource } };
}
```
#### An example with `typescript`, parsing frontmatter and providing custom data with scope
```tsx
import { MDXClient, type MDXComponents } from 'next-mdx-remote-client';
import { serialize } from "next-mdx-remote-client/serialize";
import type { SerializeOptions, SerializeResult } from "next-mdx-remote-client/serialize";
import { calculateSomeHow, getSourceSomeHow } from "../utils";
import ErrorComponent from '../components/ErrorComponent';
import Test from '../mdxComponents/Test';
type Scope = {
readingTime: string;
};
type Frontmatter = {
title: string;
author: string;
};
const components: MDXComponents = {
Test,
wrapper: function ({ children }: React.ComponentPropsWithoutRef<"div">) {
return
{children};
},
}
type Props = {
mdxSource?: SerializeResult;
}
export default function Page({ mdxSource }: Props) {
if (!mdxSource) {
return ;
}
if ("error" in mdxSource) {
return ;
}
return (
<>
{mdxSource.frontmatter.title}
Written by {mdxSource.frontmatter.author}; read in {mdxSource.scope.readingTime}
>
);
}
export async function getStaticProps() {
const source = await getSourceSomeHow();
if (!source) return { props: {} };
const options: SerializeOptions = {
disableImports: true,
mdxOptions: {
// ...
},
parseFrontmatter: true,
scope: {
readingTime: calculateSomeHow(source),
},
};
const mdxSource = await serialize({source, options});
return { props: { mdxSource } };
}
```
#### An example with creating a table of contents (TOC)
I assume you have a MDX file having `` inside; and you provide some MDX components which have an entry for `TableOfContentComponent: (props) => { ... }`.
```markdown
---
title: My Article
---
# {frontmatter.title}
rest of the article...
```
You can have a look at an example [TOC component](https://github.com/talatkuyuk/next-mdx-remote-client-in-pages-router/blob/main/mdxComponents/Toc.tsx) in the demo application.
In order to create a table of contents (TOC) I use `remark-flexible-toc` in the remark plugin list and pass the table of contents objects `vFile.data.toc` into the `scope` via the option `vfileDataIntoScope`. That's it ! So easy !
```tsx
import { MDXClient, type MDXComponents } from 'next-mdx-remote-client';
import { serialize } from "next-mdx-remote-client/serialize";
import type { SerializeOptions, SerializeResult } from "next-mdx-remote-client/serialize";
import remarkFlexibleToc, {type TocItem} from "remark-flexible-toc"; // <---------
import { calculateSomeHow, getSourceSomeHow } from "../utils";
import { ErrorComponent, TableOfContentComponent } from '../components';
import { Test } from '../mdxComponents';
type Scope = {
readingTime: string;
};
type Frontmatter = {
title: string;
author: string;
};
const components: MDXComponents = {
Test,
wrapper: function ({ children }: React.ComponentPropsWithoutRef<"div">) {
return
{children};
},
}
type Props = {
mdxSource?: SerializeResult;
}
export default function Page({ mdxSource }: Props) {
if (!mdxSource) {
return ;
}
if ("error" in mdxSource) {
return ;
}
return (
<>
{mdxSource.frontmatter.title}
Written by {mdxSource.frontmatter.author}; read in {mdxSource.scope.readingTime}
>
);
}
export async function getStaticProps() {
const source = await getSourceSomeHow();
if (!source) return { props: {} };
const options: SerializeOptions = {
disableImports: true,
mdxOptions: {
remarkPlugins: [
// ...
remarkFlexibleToc, // <---------
],
},
parseFrontmatter: true,
scope: {
readingTime: calculateSomeHow(source),
},
vfileDataIntoScope: "toc", // <---------
};
const mdxSource = await serialize({source, options});
return { props: { mdxSource } };
}
```
Actually, you may not need to access the "frontmatter" and "scope" in JSX, you can use them within MDX directly, and return just `` only.
```tsx
// ...
const components: MDXComponents = {
TableOfContentComponent, // <---------
wrapper: function ({ children }: React.ComponentPropsWithoutRef<"div">) {
return
{children};
},
}
// ...
export default function Page({ mdxSource }: Props) {
// ...
return (
);
}
```
_article.mdx_
```markdown
# {frontmatter.title}
Written by {frontmatter.author}; read in {readingTime}
rest of the article...
```
After the examples given, let's dive into the exposed functions and component by `next-mdx-remote-client` for "pages" router.
### The `serialize` function
_Go to the [hydrate](#the-hydrate-function) function_
_or the [MDXClient](#the-mdxclient-component) component_
```typescript
import { serialize } from "next-mdx-remote-client/serialize";
```
The `serialize` function is used for compiling the **MDX source**, in other words, producing the **compiled source** from MDX source, intended to run on server side at build time.
> [!WARNING]
> The `serialize` function is **asyncronous** and to be used within the `getStaticProps` or the `getServerSideProps` on the server side. (Off the record, it can be used within an `useEffect` as well, but this is not recommended because it is a heavy function as having more dependencies).
```typescript
async function serialize(props: SerializeProps): Promise {}
```
The `serialize` function takes `SerializeProps` and returns `SerializeResult` as a promise.
**Props of the `serialize` function**
```typescript
type SerializeProps = {
source: Compatible;
options?: SerializeOptions;
};
```
**Result of the `serialize` function**
Either the `compiledSource` or the `error` exists, in addition to `frontmatter` and `scope`.
```typescript
type SerializeResult =
({ compiledSource: string } | { error: Error })
& {
frontmatter: TFrontmatter;
scope: TScope;
};
```
The `serialize` function has **internal error handling mechanism** for the MDX syntax errors. The catched error is serialized via `serialize-error` package and attached into the serialize results, further you can deserialize the error on the client, if necessary. **You don't need to implement error handling by yourself.**
```tsx
import { serialize, type SerializeOptions } from "next-mdx-remote-client/serialize";
import type { Frontmatter, Scope } from "./types"
export async function getStaticProps() {
const source = await getSourceSomeHow();
if (!source) {
return { props: {} };
}
const options: SerializeOptions = {
/* */
};
const mdxSource = await serialize({
source,
options,
});
return {
props: {
mdxSource,
},
};
}
```
If you provide **the generic type parameters** like `await serialize(){}`, the `frontmatter` and the `scope` get the types, otherwise `Record` by default for both.
> [!WARNING]
> Pay attention to the order of the generic type parameters.\
> \
> The type parameters `Frontmatter` and `Scope` should extend `Record`. You should use **`type`** instead of **`interface`** for type parameters otherwise, you will receive an error saying `Type 'Xxxx' does not satisfy the constraint 'Record'.` See this [issue](https://github.com/ipikuka/next-mdx-remote-client/issues/2) for more explanation.
The `nextjs` will send the `mdxSource` ((**`compiledSource`** or **`error`**) + **`frontmatter`** + **`scope`**) to client side.
**On client side, you need first to narrow the `mdxSource` by checking `if ("error" in mdxSource) {}`.**
```tsx
type Props = {
mdxSource?: SerializeResult;
}
export default function Page({ mdxSource }: Props) {
// ...
if ("error" in mdxSource) {
return ;
}
// ...
};
```
### The serialize options (`SerializeOptions`)
All options are optional.
```typescript
type SerializeOptions = {
mdxOptions?: SerializeMdxOptions;
disableExports?: boolean;
disableImports?: boolean;
parseFrontmatter?: boolean;
scope?: TScope;
vfileDataIntoScope?: VfileDataIntoScope;
};
```
Except the `mdxOptions`, the details are the same with the [EvaluateOptions](#the-evaluate-options-evaluateoptions).
#### `mdxOptions`
It is a **`SerializeMdxOptions`** option to be passed to the `@mdx-js/mdx` compiler.
```typescript
import { type CompileOptions as OriginalCompileOptions } from "@mdx-js/mdx";
type SerializeMdxOptions = Omit<
OriginalCompileOptions,
"outputFormat" | "providerImportSource"
>;
```
As you see, some of the options are omitted and opinionated within the package. For example the `outputFormat` is always `function-body` by default. Visit https://mdxjs.com/packages/mdx/#compileoptions for available mdxOptions.
```typescript
const options: SerializeOptions = {
// ...
mdxOptions: {
format: "mdx",
baseUrl: import.meta.url,
development: true,
remarkPlugins: [/* */],
rehypePlugins: [/* */],
recmaPlugins: [/* */],
remarkRehypeOptions: {handlers: {/* */}},
// ...
};
};
```
> [!WARNING]
> Here I need to mention about the `scope` option again for the `serialize`.\
> \
> **scope**\
> \
> Actually, the `serialize` doesn't do so much with the `scope` except you provide the option `vfileDataIntoScope` for passing data from `vfile.data` into the `scope`. Since the `scope` is passed from the server to the client by `nextjs`, the `scope` must be serializable. The `scope` can not hold **function**, **component** , **Date**, **undefined**, **Error object** etc.\
> \
> If the scope has to have **unserializable** information or if you don't need or don't want to pass the `scope` into the `serialize`, you can pass it into `hydrate` or `MDXClient` directly on the client side.
### The `hydrate` function
_Go to the [serialize](#the-serialize-function) function_
_or the [MDXClient](#the-mdxclient-component) component_
```typescript
import { hydrate } from "next-mdx-remote-client/csr";
```
The `hydrate` function is used for **constructing the compiled source**, getting exported information from MDX and returning MDX content to be rendered on the client side.
```typescript
function hydrate(props: HydrateProps): HydrateResult {}
```
The `hydrate` function takes `HydrateProps` and returns `HydrateResult`. The `hydrate` has no "options" parameter.
**Props of the `hydrate` function**
```typescript
type HydrateProps = {
compiledSource: string;
frontmatter?: Record;
scope?: Record;
components?: MDXComponents;
disableParentContext?: boolean;
};
```
The option `disableParentContext` is a feature of `@mdx-js/mdx`. If it is `false`, the mdx components provided by parent `MDXProvider`s are going to be disregarded.
**Result of the `hydrate` function**
```typescript
type HydrateResult = {
content: JSX.Element;
mod: Record;
error?: Error;
};
```
The **`mod`** object is for exported information from MDX source.
> [!TIP]
> If you need to get the **exports** from MDX --> use **`hydrate`**\
> If you don't need --> use **`MDXClient`**
The `hydrate` has **internal error handling mechanism** as much as it can, in order to do so, it returns an **`error`** object if it is catched.
> [!CAUTION]
> The eval of the compiled source returns a module `MDXModule`, and does not throw errors except syntax errors. Some errors throw during the render process which needs you to use an **ErrorBoundary**.
```tsx
import { hydrate, type SerializeResult } from "next-mdx-remote-client/csr";
import { ErrorComponent, TableOfContentComponent } from "../components";
import { components } from "../mdxComponents";
import type { Frontmatter, Scope } from "../types"
type Props = {
mdxSource?: SerializeResult;
}
export default function Page({ mdxSource }: Props) {
if (!mdxSource) {
return ;
}
if ("error" in mdxSource) {
return ;
}
// Now, mdxSource has {compiledSource, frontmatter, scope}
const { content, mod, error } = hydrate({ ...mdxSource, components });
if (error) {
return ;
}
// You can use the "mod" object for exported information from the MDX as you wish
return (
<>
{mdxSource.frontmatter.title}
{mod.something}
{content}
>
);
};
```
In the above example, I assume you use **`remark-flexible-toc`** remark plugin in order to collect the headings from the MDX content, and you pass that information into the `scope` via `vfileDataIntoScope` option within the serialize on the server side.
### The `MDXClient` component
_Go to the [serialize](#the-serialize-function) function_
_or the [hydrate](#the-hydrate-function) function_
```typescript
import { MDXClient } from "next-mdx-remote-client/csr";
```
The `MDXClient` component is used for rendering the MDX content on the client side.
```typescript
function MDXClient(props: MDXClientProps): JSX.Element {}
```
The `MDXClient` component takes `MDXClientProps` and returns `JSX.Element`. The `MDXClient` has no "options" parameter like `hydrate`.
**Props of the `MDXClient` component**
```typescript
type MDXClientProps = {
compiledSource: string;
frontmatter?: Record;
scope?: Record;
components?: MDXComponents;
disableParentContext?: boolean;
onError?: React.ComponentType<{ error: Error }>
};
```
The option `disableParentContext` is a feature of `@mdx-js/mdx`. If it is `false`, the mdx components provided by parent `MDXProvider`s are going to be disregarded.
> [!TIP]
> If you need to get the **exports** from MDX --> use **`hydrate`**\
> If you don't need --> use **`MDXClient`**
The `MDXClient` has **internal error handling mechanism** as much as it can, in order to do so, it takes **`onError`** prop in addition to `hydrate` function.
> [!CAUTION]
> The eval of the compiled source returns a module `MDXModule`, and does not throw errors except syntax errors. Some errors throw during the render process which needs you to use an **ErrorBoundary**.
```tsx
import { MDXClient, type SerializeResult } from "next-mdx-remote-client/csr";
import { ErrorComponent, TableOfContentComponent } from "../components";
import { components } from "../mdxComponents";
import type { Frontmatter, Scope } from "../types"
type Props = {
mdxSource?: SerializeResult;
}
export default function Page({ mdxSource }: Props) {
if (!mdxSource) {
return ;
}
if ("error" in mdxSource) {
return ;
}
// Now, mdxSource has {compiledSource, frontmatter, scope}
return (
<>
{mdxSource.frontmatter.title}
>
);
};
```
In the above example, I assume you use **`remark-flexible-toc`** remark plugin in order to collect the headings from the MDX content, and you pass that information into the `scope` via `vfileDataIntoScope` option within the serialize on the server side.
### The `hydrateLazy` function and the `MDXClientLazy` component
The `next-mdx-remote-client` exports additional versions, say, the `hydrateLazy` and the `MDXClientLazy`, which both **have the same _functionality_, _props_, _results_** with the `hydrate` and the `MDXClient`, correspondently.
**The only difference is the hydration process takes place lazily** on the browser within a `window.requestIdleCallback` in a useEffect. You can use `hydrateLazy` or `MDXClientLazy` in order to defer hydration of the content and immediately serve the static markup.
```typescript
import { hydrateLazy, MDXClientLazy } from "next-mdx-remote-client/csr";
```
When you use `hydrateLazy`, and want to get the exports from MDX via `mod` object, please be aware that the `mod` object is always empty `{}` at first render, then it will get actual exports at second render.
> [!NOTE]
> Lazy hydration defers hydration of the components on the client. This is an optimization technique to improve the initial load of the application, but may introduce unexpected delays in interactivity for any dynamic content within the MDX content.\
> \
> This will add an additional wrapping div around the rendered MDX, which is necessary to avoid hydration mismatches during render.\
> \
> _For further explanation about the lazy hydration see [`next-mdx-remote`](https://github.com/hashicorp/next-mdx-remote) notes._
### The `hydrateAsync` function and the `MDXClientAsync` component
The `next-mdx-remote-client` exports additional versions, say, the `hydrateAsync` and the `MDXClientAsync`.
These have additional props and options, but here, I don't want to give the details since **I created them for experimental** to show the `import statements` on the client side don't work. You can have a look at the github repository for the code and the tests.
**The main difference is that the eval of the compiled source takes place in a useEffect** on the browser, since the compile source has `await` keyword for `import statements`.
```typescript
import { hydrateAsync, MDXClientAsync } from "next-mdx-remote-client/csr";
```
> [!NOTE]
> I believe, it is viable somehow using `dynamic` API if the `vercel` supports for a solution for the `pages` router via `import.meta` APIs. During the compilation of the MDX in the `serialize`, a remark/recma plugin can register the imported modules into the `import.meta.url` via a nextjs API (needs support of vercel) for them will be available to download/import on the client side via `dynamic` api. This is my imagination.
### The `MDXProvider` component
The package exports the `MDXProvider` from `@mdx-js/react`, in order the developers don't need to install the `@mdx-js/react`.
```typescript
import { MDXProvider } from "next-mdx-remote-client/csr";
```
The `` makes the mdx components available to any `` or `hydrate's { content }` being rendered in the application, as a child status of that provider.
For example, you can wrap the whole application so as **you do not need to supply the mdx components into any `` or `hydrate's { content }`.**
```tsx
import { MDXProvider } from 'next-mdx-remote-client';
import { components } from "../mdxComponents";
export default function App({ Component, pageProps }) {
return (
)
}
```
> [!NOTE]
> How this happens, because the `next-mdx-remote-client` injects the `useMdxComponents` context hook from `@mdx-js/react` during the function construction of the compiled source, internally. Pay attention that it is valid for only `MDXClient` and `hydrate` functions.
> [!CAUTION]
> Since `MDXRemote` as a react server component can not read the context, **`MDXProvider` is effectless when used within the nextjs `app` router** for `MDXRemote`, which is also for `evaluate`.
## MDX Components
You can provide a map of custom MDX components, which is a feature of `@mdx-js/mdx`, in order to replace HTML tags (see [the list of markdown syntax and equivalent HTML tags](https://mdxjs.com/table-of-components)) with the custom components.
Typescript users can use `MDXComponents` from `mdx/types`, which is exported by this package as well.
`../mdxComponents/index.ts`
```tsx
import { type MDXComponents } from "next-mdx-remote-client";
import dynamic from "next/dynamic";
import Image from "next/image";
import Link from "next/link";
import { Typography } from "@material-ui/core";
import { motion } from 'framer-motion'
import Hello from "./Hello";
import CountButton from "./CountButton";
import BlockQuote, { default as blockquote } from "./BlockQuote";
import pre from "./pre";
export const mdxComponents: MDXComponents = {
Hello,
CountButton,
Dynamic: dynamic(() => import("./dynamic")),
Image,
Link,
motion: { div: () =>
Hello world },
h2: (props: React.ComponentPropsWithoutRef<"h2">) => (
),
strong: (props: React.ComponentPropsWithoutRef<"strong">) => (
),
em: (props: React.ComponentPropsWithoutRef<"em">) => (
),
pre,
blockquote,
BlockQuote,
wrapper: (props: { children: any }) => {
return {props.children};
}
};
```
> [!NOTE]
> The **`wrapper`** is a special key, if you want to wrap the MDX content with a HTML container element.
`./data/my-article.mdx`
```markdown
---
title: "My Article"
author: "ipikuka"
---
_Read in {readingTime}, written by **{frontmatter.author}**_
# {frontmatter.title}
## Sub heading for custom components
I am blackquote content
## Sub heading for some markdown elements
Here is _italic text_ and **strong text**
> I am blackquote content
```
## Utility `getFrontmatter`
The package exports one utility **`getFrontmatter`** which is **for getting frontmatter without compiling the source**. You can get the fronmatter and the stripped source by using the `getFrontmatter` which employs the same frontmatter extractor **`vfile-matter`** used within the package.
```typescript
import { getFrontmatter } from "next-mdx-remote-client/utils";
const { frontmatter, strippedSource } = getFrontmatter(source);
```
If you provide **the generic type parameter**, it ensures the `frontmatter` gets the type, otherwise `Record` by default.
**If there is no frontmatter** in the source, the `frontmatter` will be **empty object `{}`**.
> [!IMPORTANT]
> \
> If you use **`next-mdx-remote`** and want to get `frontmatter` without compiling the source !
> \
> The subpath **`next-mdx-remote-client/utils`** is isolated from other features of the package and it does cost minimum. **So, anyone can use `next-mdx-remote-client/utils` while using `next-mdx-remote`.**
## Types
The `next-mdx-remote-client` is fully typed with [TypeScript][typescript-url].
The package exports the types for server side (rsc):
- `EvaluateProps`
- `EvaluateOptions`
- `EvaluateResult`
- `MDXRemoteProps`
- `MDXRemoteOptions`
The package exports the types for client side (csr):
- `HydrateProps`
- `HydrateResult`
- `MDXClientProps`
- `SerializeResult`
The package exports the types for the serialize function:
- `SerializeProps`
- `SerializeOptions`
- `SerializeResult`
In addition, the package exports the types from `mdx/types` so that developers do not need to import `mdx/types`:
- `MDXComponents`
- `MDXContent`
- `MDXProps`
- `MDXModule`
## Compatibility
The `next-mdx-remote-client` works with unified version 6+ ecosystem since it is compatible with MDX version 3.
## Security
Allowance of the **`export declarations`** and the **`import declarations`** in MDX source, if you don't have exact control on the content, may cause vulnerabilities and harmful activities. The **next-mdx-remote-client** gives options for disabling them.
But, you need to use a custom recma plugin for disabiling the **`import expressions`** like `await import("xyz")` since the **next-mdx-remote-client** doesn't touch the import expressions.
`Eval` a string of JavaScript can be a dangerous and may cause enabling XSS attacks, which is how the **next-mdx-remote-client** APIs do. Please, take your own measures while passing the user input.
If there is a Content Security Policy (CSP) on the website that disallows code evaluation via `eval` or `new Function()`, it is needed to loosen that restriction in order to utilize `next-mdx-remote-client`, which can be done using [unsafe-eval](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src#common_sources).
## Some Plugins
I like to contribute the Unified / Remark / MDX ecosystem, so I recommend you to have a look my plugins.
### My Remark Plugins
- [`remark-flexible-code-titles`](https://www.npmjs.com/package/remark-flexible-code-titles)
– Remark plugin to add titles or/and containers for the code blocks with customizable properties
- [`remark-flexible-containers`](https://www.npmjs.com/package/remark-flexible-containers)
– Remark plugin to add custom containers with customizable properties in markdown
- [`remark-ins`](https://www.npmjs.com/package/remark-ins)
– Remark plugin to add `ins` element in markdown
- [`remark-flexible-paragraphs`](https://www.npmjs.com/package/remark-flexible-paragraphs)
– Remark plugin to add custom paragraphs with customizable properties in markdown
- [`remark-flexible-markers`](https://www.npmjs.com/package/remark-flexible-markers)
– Remark plugin to add custom `mark` element with customizable properties in markdown
- [`remark-flexible-toc`](https://www.npmjs.com/package/remark-flexible-toc)
– Remark plugin to expose the table of contents via Vfile.data or via an option reference
- [`remark-mdx-remove-esm`](https://www.npmjs.com/package/remark-mdx-remove-esm)
– Remark plugin to remove import and/or export statements (mdxjsEsm)
### My Rehype Plugins
- [`rehype-pre-language`](https://www.npmjs.com/package/rehype-pre-language)
– Rehype plugin to add language information as a property to `pre` element
### My Recma Plugins
- [`recma-mdx-escape-missing-components`](https://www.npmjs.com/package/recma-mdx-escape-missing-components)
– Recma plugin to set the default value `() => null` for the Components in MDX in case of missing or not provided so as not to throw an error
- [`recma-mdx-change-props`](https://www.npmjs.com/package/recma-mdx-change-props)
– Recma plugin to change the `props` parameter into the `_props` in the `function _createMdxContent(props) {/* */}` in the compiled source in order to be able to use `{props.foo}` like expressions. It is useful for the `next-mdx-remote` or `next-mdx-remote-client` users in `nextjs` applications.
## License
[MPL 2.0 License](./LICENSE) © ipikuka
## Keywords
🟩 [@mdx-js][mdx-js] 🟩 [next/mdx][next-mdx] 🟩 [next-mdx-remote][next-mdx-remote] 🟩 [next-mdx-remote-client][next-mdx-remote-client]
[mdx-js]: https://www.npmjs.com/package/@mdx-js/mdx
[next-mdx]: https://www.npmjs.com/package/@next/mdx
[next-mdx-remote]: https://www.npmjs.com/package/next-mdx-remote
[next-mdx-remote-client]: https://www.npmjs.com/package/next-mdx-remote-client
[badge-npm-version]: https://img.shields.io/npm/v/next-mdx-remote-client
[badge-npm-download]:https://img.shields.io/npm/dt/next-mdx-remote-client
[npm-package-url]: https://www.npmjs.com/package/next-mdx-remote-client
[badge-license]: https://img.shields.io/github/license/ipikuka/next-mdx-remote-client
[github-license-url]: https://github.com/ipikuka/next-mdx-remote-client/blob/main/LICENSE
[badge-build]: https://github.com/ipikuka/next-mdx-remote-client/actions/workflows/publish.yml/badge.svg
[github-workflow-url]: https://github.com/ipikuka/next-mdx-remote-client/actions/workflows/publish.yml
[badge-typescript]: https://img.shields.io/npm/types/next-mdx-remote-client
[typescript-url]: https://www.typescriptlang.org/