Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

@openuidev/react-email

React Email component definitions for OpenUI Lang. Use this package when a model should generate email layouts that can be previewed, rendered, and converted to HTML.

npm version monthly downloads License: MIT

Links: Package docs | OpenUI Lang guide | GitHub repo

Install

npm install @openuidev/react-email @openuidev/react-lang
# or
pnpm add @openuidev/react-email @openuidev/react-lang

Peer dependencies: react >=19.0.0, react-dom >=19.0.0, @openuidev/react-lang

Quick Start

1. Generate a system prompt

import { emailLibrary, emailPromptOptions } from "@openuidev/react-email";

const systemPrompt = emailLibrary.prompt(emailPromptOptions);

2. Render the email output

import { Renderer } from "@openuidev/react-lang";
import { emailLibrary } from "@openuidev/react-email";

function EmailPreview({ response, isStreaming }) {
  return <Renderer response={response} library={emailLibrary} isStreaming={isStreaming} />;
}

3. Get the HTML

Install @react-email/render to convert the output to an email-safe HTML string:

npm install @react-email/render
import { Renderer } from "@openuidev/react-lang";
import { emailLibrary } from "@openuidev/react-email";
import { render } from "@react-email/render";

const html = await render(
  <Renderer response={llmResponse} library={emailLibrary} isStreaming={false} />,
  { pretty: true },
);

Exports

Export Description
emailLibrary Pre-configured Library instance with all 44 email components
emailPromptOptions Prompt options with examples and rules for email generation

Documentation

License

MIT