react-email · diff
v1.1.0 to v2.1.0
144 added, 323 removed. Audit F to F.
---
name: react-email
- description: Use when creating HTML email templates with React components - welcome emails, password resets, notifications, order confirmations, newsletters, or transactional emails.
+ description: Use when building HTML email templates with React components, adding a visual email editor to an application using the React Email visual editor, rendering emails to HTML, or sending emails with Resend. Covers welcome emails, password resets, notifications, order confirmations, newsletters, transactional emails, and the embeddable email editor component.
license: MIT
metadata:
author: Resend
- version: "1.1.0"
+ version: "2.1.0"
+ homepage: https://react.email
+ source: https://github.com/resend/react-email
+ openclaw:
+ install:
+ - kind: node
+ package: react-email
+ label: React Email
+ links:
+ repository: https://github.com/resend/react-email
+ documentation: https://resend.com/docs/react-email-skill
---
# React Email
Build and send HTML emails using React components - a modern, component-based approach to email development that works across all major email clients.
## Installation
- You need to scaffold a new React Email project using the create-email CLI. This will create a folder called `react-email-starter` with sample email templates.
-
- Using npm:
-
```sh
- npx create-email@latest
- ```
-
- Using yarn:
-
- ```sh
- yarn create email
- ```
-
- Using pnpm:
-
- ```sh
- pnpm create email
- ```
-
- Using bun:
-
- ```sh
- bun create email
+ npm i react-email
```
- ## Navigate to Project Directory
-
- You must change into the newly created project folder:
+ Or scaffold a new project:
```sh
+ npx create-email@latest
cd react-email-starter
- ```
-
- ## Install Dependencies
-
- You need to install all project dependencies before running the development server.
-
- Using npm:
-
- ```sh
npm install
- ```
-
- Using yarn:
-
- ```sh
- yarn
- ```
-
- Using pnpm:
-
- ```sh
- pnpm install
- ```
-
- Using bun:
-
- ```sh
- bun install
- ```
-
- ## Start the Development Server
-
- Your task is to start the local preview server to view and edit email templates.
-
- Using npm:
-
- ```sh
npm run dev
```
- Using yarn:
-
- ```sh
- yarn dev
- ```
-
- Using pnpm:
-
- ```sh
- pnpm dev
- ```
-
- Using bun:
-
- ```sh
- bun dev
- ```
-
- ## Verify Installation
+ This works with any package manager (npm, yarn, pnpm, bun) — substitute accordingly.
- Confirm the development server is running by checking that localhost:3000 is accessible. The server will display a preview interface where you can view email templates from the `emails` folder.
+ The dev server runs at localhost:3000 with a preview interface for templates in the `emails` folder.
- ### Notes on installation
+ ### Adding to an Existing Project
- Assuming React Email is installed in an existing project, update the top-level package.json file with a script to run the React Email preview server.
+ Install the packages and add a script to your `package.json`:
```json
{
"scripts": {
"email": "email dev --dir emails --port 3000"
}
}
```
- Make sure the path to the emails folder is relative to the base project directory.
-
- ### tsconfig.json updating or creation
-
- Ensure the tsconfig.json includes proper support for jsx.
+ Make sure the path to the emails folder is relative to the base project directory. Ensure `tsconfig.json` includes proper support for JSX.
## Basic Email Template
- Replace the sample email templates. Here is how to create a new email template:
-
Create an email component with proper structure using the Tailwind component for styling:
```tsx
import {
Html,
Head,
Preview,
Body,
Container,
Heading,
Text,
Button,
Tailwind,
- pixelBasedPreset,
- } from "@react-email/components";
+ pixelBasedPreset
+ } from 'react-email';
interface WelcomeEmailProps {
name: string;
verificationUrl: string;
}
- export default function WelcomeEmail({
- name,
- verificationUrl,
- }: WelcomeEmailProps) {
+ export default function WelcomeEmail({ name, verificationUrl }: WelcomeEmailProps) {
return (
<Html lang="en">
<Tailwind
config={{
presets: [pixelBasedPreset],
theme: {
extend: {
colors: {
- brand: "#007bff",
+ brand: '#007bff',
},
},
},
}}
>
<Head />
- <Preview>Welcome - Verify your email</Preview>
<Body className="bg-gray-100 font-sans">
+ <Preview>Welcome - Verify your email</Preview>
<Container className="max-w-xl mx-auto p-5">
- <Heading className="text-2xl text-gray-800">Welcome!</Heading>
+ <Heading className="text-2xl text-gray-800">
+ Welcome!
+ </Heading>
<Text className="text-base text-gray-800">
Hi {name}, thanks for signing up!
</Text>
<Button
href={verificationUrl}
- className="bg-brand text-white px-5 py-3 rounded block text-center no-underline"
+ className="bg-brand text-white px-5 py-3 rounded block text-center no-underline box-border"
>
Verify Email
</Button>
</Container>
</Body>
</Tailwind>
</Html>
);
}
// Preview props for testing
WelcomeEmail.PreviewProps = {
- name: "John Doe",
- verificationUrl: "https://example.com/verify/abc123",
+ name: 'John Doe',
+ verificationUrl: 'https://example.com/verify/abc123'
} satisfies WelcomeEmailProps;
export { WelcomeEmail };
```
+ ## Behavioral Guidelines
+
+ - When iterating over the code, only update what the user asked for. Keep the rest intact.
+ - If the user asks to use media queries, inform them that most email clients don't support them and suggest a different approach.
+ - Never use template variables (like `{{name}}`) directly in TypeScript code. Instead, reference the underlying properties directly. If the user explicitly asks for `{{variableName}}`, place the mustache string only in PreviewProps, never in the component JSX:
+
+ ```typescript
+ const EmailTemplate = (props) => {
+ return (
+ <h1>Hello, {props.variableName}!</h1>
+ );
+ }
+
+ EmailTemplate.PreviewProps = {
+ variableName: "{{variableName}}",
+ };
+
+ export default EmailTemplate;
+ ```
+
+ - Never write the `{{variableName}}` pattern directly in the component structure. If the user insists, explain that this would make the template invalid.
+
## Essential Components
See [references/COMPONENTS.md](references/COMPONENTS.md) for complete component documentation.
**Core Structure:**
-
- `Html` - Root wrapper with `lang` attribute
- `Head` - Meta elements, styles, fonts
- `Body` - Main content wrapper
- - `Container` - Centers content (max-width layout)
- - `Section` - Layout sections
+ - `Container` - Outermost centering wrapper (has built-in `max-width: 37.5em`). Use only once per email.
+ - `Section` - Interior content blocks (no built-in max-width). Use for grouping content inside `Container`.
- `Row` & `Column` - Multi-column layouts
- `Tailwind` - Enables Tailwind CSS utility classes
**Content:**
-
- - `Preview` - Inbox preview text, always first in `Body`
+ - `Preview` - Inbox preview text, always first inside `<Body>`
- `Heading` - h1-h6 headings
- `Text` - Paragraphs
- - `Button` - Styled link buttons
+ - `Button` - Styled link buttons (always include `box-border`)
- `Link` - Hyperlinks
- `Img` - Images (see Static Files section below)
- `Hr` - Horizontal dividers
**Specialized:**
-
- `CodeBlock` - Syntax-highlighted code
- `CodeInline` - Inline code
- `Markdown` - Render markdown
- `Font` - Custom web fonts
## Before Writing Code
When a user requests an email template, ask clarifying questions FIRST if they haven't provided:
1. **Brand colors** - Ask for primary brand color (hex code like #007bff)
2. **Logo** - Ask if they have a logo file and its format (PNG/JPG only - warn if SVG/WEBP)
3. **Style preference** - Professional, casual, or minimal tone
4. **Production URL** - Where will static assets be hosted in production?
- Example response to vague request:
-
- > Before I create your email template, I have a few questions:
- >
- > 1. What is your primary brand color? (hex code)
- > 2. Do you have a logo file? (PNG or JPG - note: SVG and WEBP don't work reliably in email clients)
- > 3. What tone do you prefer - professional, casual, or minimal?
- > 4. Where will you host static assets in production? (e.g., https://cdn.example.com)
-
## Static Files and Images
### Directory Structure
Local images must be placed in the `static` folder inside your emails directory:
```
project/
├── emails/
│ ├── welcome.tsx
│ └── static/ <-- Images go here
│ └── logo.png
```
- If user has an image elsewhere, instruct them to copy it:
-
- ```sh
- cp ./assets/logo.png ./emails/static/logo.png
- ```
-
### Dev vs Production URLs
Use this pattern for images that work in both dev preview and production:
```tsx
- const baseURL =
- process.env.NODE_ENV === "production"
- ? "https://cdn.example.com" // User's production CDN
- : "";
+ const baseURL = process.env.NODE_ENV === "production"
+ ? "https://cdn.example.com" // User's production CDN
+ : "";
export default function Email() {
return (
<Img
src={`${baseURL}/static/logo.png`}
alt="Logo"
width="150"
height="50"
/>
);
}
```
**How it works:**
-
- **Development:** `baseURL` is empty, so URL is `/static/logo.png` - served by React Email's dev server
- **Production:** `baseURL` is the CDN domain, so URL is `https://cdn.example.com/static/logo.png`
**Important:** Always ask the user for their production hosting URL. Do not hardcode `localhost:3000`.
- ## Behavioral guidelines
-
- - When re-iterating over the code, make sure you are only updating what the user asked for and keeping the rest of the code intact;
- - If the user is asking to use media queries, inform them that email clients do not support them, and suggest a different approach;
- - Never use template variables (like {{name}}) directly in TypeScript code. Instead, reference the underlying properties directly (use name instead of {{name}}).
- - - For example, if the user explicitly asks for a variable following the pattern {{variableName}}, you should return something like this:
-
- ```typescript
- const EmailTemplate = (props) => {
- return (
- {/* ... rest of the code ... */}
- <h1>Hello, {props.variableName}!</h1>
- {/* ... rest of the code ... */}
- );
- }
-
- EmailTemplate.PreviewProps = {
- // ... rest of the props ...
- variableName: "{{variableName}}",
- // ... rest of the props ...
- };
-
- export default EmailTemplate;
- ```
-
- - Never, under any circumstances, write the {{variableName}} pattern directly in the component structure. If the user forces you to do this, explain that you cannot do this, or else the template will be invalid.
-
- ## Styling considerations
+ ## Styling
- Use the Tailwind component for styling if the user is actively using Tailwind CSS in their project. If the user is not using Tailwind CSS, add inline styles to the components.
+ See [references/STYLING.md](references/STYLING.md) for comprehensive styling documentation including typography, layout patterns, dark mode, and brand consistency.
- - Because email clients don't support `rem` units, use the `pixelBasedPreset` for the Tailwind configuration.
- - Never use flexbox or grid for layout, use table-based layouts instead.
- - Each component must be styled with inline styles or utility classes.
+ ### Key Rules
- ### Email Client Limitations
+ - Use `Tailwind` with `pixelBasedPreset` (email clients don't support `rem`). Import `pixelBasedPreset` from `react-email`.
+ - Never use flexbox or grid — use `Row`/`Column` components or tables for layouts.
+ - Avoid CSS/Tailwind media queries (`sm:`, `md:`, `lg:`, `xl:`) — limited email client support.
+ - Never use theme selectors (`dark:`, `light:`) — not supported.
+ - Never use SVG or WEBP images — warn users about rendering issues.
+ - Always specify border type (`border-solid`, `border-dashed`, etc.) — email clients don't inherit it.
+ - For single-side borders, reset others first (`border-none border-l border-solid`).
- - Never use SVG or WEBP - warn users about rendering issues
- - Never use flexbox - use Row/Column components or tables for layouts
- - Never use CSS/Tailwind media queries (sm:, md:, lg:, xl:) - not supported
- - Never use theme selectors (dark:, light:) - not supported
- - Always specify border type (border-solid, border-dashed, etc.)
- - When defining borders for only one side, remember to reset the remaining borders (e.g., border-none border-l)
+ ### Required Classes
- ### Component Structure
+ | Component | Required Class | Why |
+ |-----------|---------------|-----|
+ | `Button` | `box-border` | Prevents padding from overflowing the button width |
+ | `Hr` / any border | `border-solid` (or `border-dashed`, etc.) | Email clients don't inherit border type |
+ | Single-side borders | `border-none` + the side | Resets default borders on other sides |
+ ### Structure Notes
- Always define `<Head />` inside `<Tailwind>` when using Tailwind CSS
- - Only use PreviewProps when passing props to a component
- - Only include props in PreviewProps that the component actually uses
-
- ```tsx
- const Email = (props) => {
- return (
- <div>
- <a href={props.source}>click here if you want candy 👀</a>
- </div>
- );
- };
-
- Email.PreviewProps = {
- source: "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
- };
- ```
-
- ### Default Structure
-
- - Body: `font-sans py-10 bg-gray-100`
- - Container: white, centered, content left-aligned
- - Footer: physical address, unsubscribe link, current year with `m-0` on address/copyright
-
- ### Typography
-
- - Titles: bold, larger font, larger margins
- - Paragraphs: regular weight, smaller font, smaller margins
- - Use consistent spacing respecting content hierarchy
-
- ### Images
-
- - Only include if user requests
- - Never use fixed width/height - use responsive units (w-full, h-auto)
- - Never distort user-provided images
- - Never create SVG images - only use provided or web images
-
- ### Buttons
-
- - Always use `box-border` to prevent padding overflow
-
- ### Layout
-
- - Always mobile-friendly by default
- - Use stacked layouts that work on all screen sizes
- - Remove default spacing/margins/padding between list items
-
- ### Dark Mode
-
- When requested: container black (#000), background dark gray (#151516)
-
- ### Best Practices
-
- - Choose colors, layout, and copy based on user's request
- - Make templates unique, not generic
- - Use keywords in email body to increase conversion
+ - `<Preview>` should always be the first element inside `<Body>`
+ - Only include props in `PreviewProps` that the component actually uses
+ - Use fixed width/height for known-size elements (logos, icons); responsive sizing (`w-full`, `h-auto`) for content images
## Rendering
### Convert to HTML
```tsx
- import { render } from "@react-email/components";
- import { WelcomeEmail } from "./emails/welcome";
+ import { render } from 'react-email';
+ import { WelcomeEmail } from './emails/welcome';
const html = await render(
- <WelcomeEmail name="John" verificationUrl="https://example.com/verify" />,
+ <WelcomeEmail name="John" verificationUrl="https://example.com/verify" />
);
```
### Convert to Plain Text
```tsx
- import { render } from "@react-email/components";
- import { WelcomeEmail } from "./emails/welcome";
-
- const text = await render(
- <WelcomeEmail name="John" verificationUrl="https://example.com/verify" />,
- { plainText: true },
- );
+ const text = await render(<WelcomeEmail name="John" verificationUrl="https://example.com/verify" />, { plainText: true });
```
## Sending
- React Email supports sending with any email service provider. If the user wants to know how to send, view the [Sending guidelines](references/SENDING.md).
+ React Email supports sending with any email service provider. See [references/SENDING.md](references/SENDING.md) for complete sending documentation including Resend, Nodemailer, and SendGrid examples.
- Quick example using the Resend SDK for Node.js:
+ Quick example using the Resend SDK:
```tsx
- import { Resend } from "resend";
- import { WelcomeEmail } from "./emails/welcome";
+ import { Resend } from 'resend';
+ import { WelcomeEmail } from './emails/welcome';
const resend = new Resend(process.env.RESEND_API_KEY);
const { data, error } = await resend.emails.send({
- from: "Acme <onboarding@resend.dev>",
- to: ["user@example.com"],
- subject: "Welcome to Acme",
- react: (
- <WelcomeEmail name="John" verificationUrl="https://example.com/verify" />
- ),
+ from: 'Acme <onboarding@resend.dev>',
+ to: ['user@example.com'],
+ subject: 'Welcome to Acme',
+ react: <WelcomeEmail name="John" verificationUrl="https://example.com/verify" />
});
-
- if (error) {
- console.error("Failed to send:", error);
- }
```
- The Node SDK automatically handles the plain-text rendering and HTML rendering for you.
+ The Resend Node SDK automatically handles both HTML and plain-text rendering.
+ ## CLI Commands
+
+ The `react-email` package provides a CLI accessible via the `email` command:
+
+ | Command | Description |
+ |---------|-------------|
+ | `email dev --dir <path> --port <port>` | Start the preview development server (default: `./emails`, port 3000) |
+ | `email build --dir <path>` | Build the preview app for production deployment |
+ | `email start` | Run the built preview app |
+ | `email export --outDir <path> --pretty --plainText --dir <path>` | Export templates to static HTML files |
+ | `email resend setup` | Connect the CLI to your Resend account via API key |
+ | `email resend reset` | Remove the stored Resend API key |
+
## Internationalization
- See [references/I18N.md](references/I18N.md) for complete i18n documentation.
+ See [references/I18N.md](references/I18N.md) for complete i18n documentation. React Email supports three libraries: next-intl, react-i18next, and react-intl.
- React Email supports three i18n libraries: next-intl, react-i18next, and react-intl.
+ ## Email Editor
- ### Quick Example (next-intl)
+ React Email includes a visual editor (`@react-email/editor`) that can be embedded in your app. It's built on TipTap/ProseMirror and produces email-ready HTML.
- ```tsx
- import { createTranslator } from 'next-intl';
- import {
- Html,
- Body,
- Container,
- Text,
- Button,
- Tailwind,
- pixelBasedPreset
- } from '@react-email/components';
+ See [references/EDITOR.md](references/EDITOR.md) for complete documentation including:
+ - `EmailEditor` — batteries-included component with bubble menus, slash commands, and theming
+ - `StarterKit` — 35+ email-aware extensions (headings, lists, tables, columns, buttons, etc.)
+ - `Inspector` — contextual sidebar for editing styles
+ - `EmailTheming` — built-in themes (`basic`, `minimal`) with customizable CSS properties
+ - `composeReactEmail` — export editor content to email-ready HTML and plain text
+ - Custom extensions via `EmailNode` and `EmailMark`
- interface EmailProps {
- name: string;
- locale: string;
- }
+ Quick example:
- export default async function WelcomeEmail({ name, locale }: EmailProps) {
- const t = createTranslator({
- messages: await import(\`../messages/\${locale}.json\`),
- namespace: 'welcome-email',
- locale
- });
+ ```tsx
+ import { EmailEditor, type EmailEditorRef } from '@react-email/editor';
+ import '@react-email/editor/themes/default.css';
+ import { useRef } from 'react';
+ export function MyEditor() {
+ const ref = useRef<EmailEditorRef>(null);
+
return (
- <Html lang={locale}>
- <Tailwind config={{ presets: [pixelBasedPreset] }}>
- <Body className="bg-gray-100 font-sans">
- <Container className="max-w-xl mx-auto p-5">
- <Text className="text-base text-gray-800">{t('greeting')} {name},</Text>
- <Text className="text-base text-gray-800">{t('body')}</Text>
- <Button href="https://example.com" className="bg-blue-600 text-white px-5 py-3 rounded">
- {t('cta')}
- </Button>
- </Container>
- </Body>
- </Tailwind>
- </Html>
+ <EmailEditor
+ ref={ref}
+ content="<p>Start typing...</p>"
+ theme="basic"
+ />
);
}
```
- Message files (\`messages/en.json\`, \`messages/es.json\`, etc.):
-
- ```json
- {
- "welcome-email": {
- "greeting": "Hi",
- "body": "Thanks for signing up!",
- "cta": "Get Started"
- }
- }
- ```
-
- ## Email Best Practices
-
- 1. **Test across email clients** - Test in Gmail, Outlook, Apple Mail, Yahoo Mail. Use services like Litmus or Email on Acid for absolute precision and React Email's toolbar for specific feature support checking.
-
- 2. **Keep it responsive** - Max-width around 600px, test on mobile devices.
-
- 3. **Use absolute image URLs** - Host on reliable CDN, always include \`alt\` text.
-
- 4. **Provide plain text version** - Required for accessibility and some email clients.
-
- 5. **Keep file size under 102KB** - Gmail clips larger emails.
-
- 6. **Add proper TypeScript types** - Define interfaces for all email props.
-
- 7. **Include preview props** - Add \`.PreviewProps\` to components for development testing.
-
- 8. **Handle errors** - Always check for errors when sending emails.
-
- 9. **Use verified domains** - For production, use verified domains in \`from\` addresses.
-
## Common Patterns
See [references/PATTERNS.md](references/PATTERNS.md) for complete examples including:
-
- Password reset emails
- Order confirmations with product lists
- Notification emails with code blocks
- Multi-column layouts
- - Email templates with custom fonts
+ - Team invitation emails
+ ## Email Best Practices
+
+ 1. **Test across email clients** - Gmail, Outlook, Apple Mail, Yahoo Mail
+ 2. **Keep it responsive** - Max-width around 600px, test on mobile
+ 3. **Use absolute image URLs** - Host on reliable CDN, always include `alt` text
+ 4. **Provide plain text version** - Required for accessibility
+ 5. **Keep file size under 102KB** - Gmail clips larger emails
+ 6. **Add proper TypeScript types** - Define interfaces for all email props
+ 7. **Include preview props** - Add `.PreviewProps` for development testing
+ 8. **Use verified domains** - For production `from` addresses
+
## Additional Resources
- [React Email Documentation](https://react.email/docs/llms.txt)
- [React Email GitHub](https://github.com/resend/react-email)
- [Resend Documentation](https://resend.com/docs/llms.txt)
- [Email Client CSS Support](https://www.caniemail.com)
- Component Reference: [references/COMPONENTS.md](references/COMPONENTS.md)
+ - Styling Guide: [references/STYLING.md](references/STYLING.md)
+ - Email Editor: [references/EDITOR.md](references/EDITOR.md)
+ - Sending Guide: [references/SENDING.md](references/SENDING.md)
- Internationalization Guide: [references/I18N.md](references/I18N.md)
- Common Patterns: [references/PATTERNS.md](references/PATTERNS.md)