mirror of
https://github.com/facebook/react.git
synced 2026-02-25 05:03:03 +00:00
37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# `react-markup`
|
|
|
|
This 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.
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
npm install react react-markup
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
import { experimental_renderToHTML as renderToHTML } from 'react-markup';
|
|
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 });
|
|
}
|
|
```
|
|
|
|
Note that this is an async function that needs to be awaited - unlike the legacy `renderToString` in `react-dom`.
|
|
|
|
## API
|
|
|
|
### `react-markup`
|
|
|
|
See https://react.dev/reference/react-markup
|
|
|
|
## Thanks
|
|
|
|
The React team thanks [Nikolai Mavrenkov](https://www.koluch.ru/) for donating the `react-markup` package name.
|