Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

react-markup reference docs #7107

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/content/reference/react-markup/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: React Markup APIs
---

<Intro>

The `react-markup` package provides the ability to render standalone HTML from Server Components for use in embedded contexts such as e-mails and RSS/Atom feeds.
It cannot use Client Components and does not hydrate. It is intended to be paired with the generic React package, which is shipped as `react` to npm.

</Intro>

## APIs {/*apis*/}

These APIs can be imported from the React Server environment (e.g. in Server Actions):

* [`renderToHTML`](/reference/react-markup/renderToHTML) renders a non-interactive React tree with support for Server Components but not Client Components.
74 changes: 74 additions & 0 deletions src/content/reference/react-markup/renderToHTML.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: renderToHTML
canary: true
---


<Intro>

`renderToHTML` renders a React tree to non-interactive HTML.

```js
const stream = renderToHTML(reactNode, options?)
```

</Intro>

<InlineToc />

---

## Reference {/*reference*/}

### `renderToHTML(reactNode, options?)` {/*rendertohtml*/}

You can call `renderToHTML` to render a non-interactive tree of React components to HTML.
By default, it supports shared components and built-in components.
Server Components are only allowed if used in a React Server environment (e.g. in Server Actions).
You can also use it during Client-Side Rendering but only without Server Components.

When a `<html>` tag is rendered, `renderToHTML` will automatically add `<!DOCTYPE html>` doctype.

```js
import { experimental_renderToHTML as renderToHTML } from 'react-markup';

const markup = await renderToHTML(<App />);
```

#### Parameters {/*parameters*/}

* `reactNode`: A React node you want to render to HTML. For example, a JSX element like `<App />`.

* **optional** `options`: An object for server render.
* **optional** `identifierPrefix`: A string prefix React uses for IDs generated by [`useId`.](/reference/react/useId) Useful to avoid conflicts when the markup is embedded in or combined with other markup that is rendered by React.
* **optional** `onError`: A callback that fires whenever there is a server error. By default, this only calls `console.error`. If you override it to [log crash reports,](#logging-crashes-on-the-server) make sure that you still call `console.error`. This is different to the rejection reason of the created Promise since it'll include the parent component stack.
* **optional** `signal`: An [abort signal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) that lets you [abort rendering](#aborting-server-rendering). The original Promise will reject.

#### Returns {/*returns*/}

`renderToHTML` returns a Promise that will resolve with the HTML string of the rendered React tree.

#### Caveats {/*caveats*/}

* Will throw when Client APIs (e.g. `useState` or `useEffect`) are used.

---

## Usage {/*usage*/}

### Rendering a React tree as an Email {/*rendering-a-react-tree-as-an-email*/}

Await the call of `renderToHTML` :

```js {7}
import { experimental_renderToHTML as renderToHTML } from 'react-markup';
eps1lon marked this conversation as resolved.
Show resolved Hide resolved
import EmailTemplate from './my-email-template-component.js'

async function action(email, name) {
"use server";
// ... in your server, e.g. a Server Action...
const htmlString = await renderToHTML(<EmailTemplate name={name} />);
// ... send e-mail using some e-mail provider
await sendEmail({ to: email, contentType: 'text/html', body: htmlString });
}
```
14 changes: 13 additions & 1 deletion src/sidebarReference.json
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,18 @@
}
]
},
{
"title": "react-markup",
"path": "/reference/react-markup",
"canary": true,
"routes": [
{
"title": "renderToHTML",
"path": "/reference/react-markup/renderToHTML",
"canary": true
}
]
},
{
"hasSectionHeader": true,
"sectionHeader": "Legacy APIs"
Expand Down Expand Up @@ -433,4 +445,4 @@
]
}
]
}
}
Loading