react/packages/react-markup
Sebastian Markbåge eb7f8b42c9
[Flight] Add Separate Outgoing Debug Channel (#33754)
This lets us pass a writable on the server side and readable on the
client side to send debug info through a separate channel so that it
doesn't interfere with the main payload as much. The main payload refers
to chunks defined in the debug info which means it's still blocked on it
though. This ensures that the debug data has loaded by the time the
value is rendered so that the next step can forward the data.

This will be a bit fragile to race conditions until #33665 lands.
Another follow up needed is the ability to skip the debug channel on the
receiving side. Right now it'll block forever if you don't provide one
since we're blocking on the debug data.
2025-07-10 16:22:44 -04:00
..
npm Move react-html to react-markup (#30688) 2024-08-14 19:22:44 +02:00
src [Flight] Add Separate Outgoing Debug Channel (#33754) 2025-07-10 16:22:44 -04:00
index.js Move react-html to react-markup (#30688) 2024-08-14 19:22:44 +02:00
package.json Bump next prerelease version numbers (#31676) 2024-12-12 14:10:46 -05:00
react-markup.react-server.js Move react-html to react-markup (#30688) 2024-08-14 19:22:44 +02:00
README.md Publish experimental_renderToHTML (#30690) 2024-08-15 08:50:56 +02:00

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

npm install react react-markup

Usage

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 for donating the react-markup package name.