RE

react-email

This tool enables the design, preview, and rendering of React-based emails compatible across different email clients.

Install

mkdir -p .claude/skills/react-email && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/1770" && unzip -o skill.zip -d .claude/skills/react-email && rm skill.zip

Installs to .claude/skills/react-email

Activation

This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.

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.
356 chars✓ has a “when” triggerlonger than Claude Code's old 250-char listing cap (fine on current versions)
Intermediate

Key capabilities

  • Render React components as HTML emails
  • Preview email templates in a local browser environment
  • Convert React components to plain text
  • Integrate Tailwind CSS with pixel-based presets
  • Manage static assets via a dedicated folder

How it works

The library provides a set of specialized React components that map to email-safe HTML structures, which are then rendered into static HTML strings.

Inputs & outputs

You give it
React component with props
You get back
HTML string or plain text

When to use react-email

  • Create password reset emails
  • Design transactional email templates
  • Develop newsletter layouts
  • Preview email components in browser

About this 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

npm i react-email

Or scaffold a new project:

npx create-email@latest
cd react-email-starter
npm install
npm run dev

This works with any package manager (npm, yarn, pnpm, bun) — substitute accordingly.

The dev server runs at localhost:3000 with a preview interface for templates in the emails folder.

Adding to an Existing Project

Install the packages and add a script to your package.json:

{
  "scripts": {
    "email": "email dev --dir emails --port 3000"
  }
}

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

Create an email component with proper structure using the Tailwind component for styling:

import {
  Html,
  Head,
  Preview,
  Body,
  Container,
  Heading,
  Text,
  Button,
  Tailwind,
  pixelBasedPreset
} from 'react-email';

interface WelcomeEmailProps {
  name: string;
  verificationUrl: string;
}

export default function WelcomeEmail({ name, verificationUrl }: WelcomeEmailProps) {
  return (
    <Html lang="en">
      <Tailwind
        config={{
          presets: [pixelBasedPreset],
          theme: {
            extend: {
              colors: {
                brand: '#007bff',
              },
            },
          },
        }}
      >
        <Head />
        <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>
            <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 box-border"
            >
              Verify Email
            </Button>
          </Container>
        </Body>
      </Tailwind>
    </Html>
  );
}

// Preview props for testing
WelcomeEmail.PreviewProps = {
  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:
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 for complete component documentation.

Core Structure:

  • Html - Root wrapper with lang attribute
  • Head - Meta elements, styles, fonts
  • Body - Main content wrapper
  • 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 inside <Body>
  • Heading - h1-h6 headings
  • Text - Paragraphs
  • 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?

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

Dev vs Production URLs

Use this pattern for images that work in both dev preview and production:

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.

Styling

See references/STYLING.md for comprehensive styling documentation including typography, layout patterns, dark mode, and brand consistency.

Key Rules

  • 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).

Required Classes

ComponentRequired ClassWhy
Buttonbox-borderPrevents padding from overflowing the button width
Hr / any borderborder-solid (or border-dashed, etc.)Email clients don't inherit border type
Single-side bordersborder-none + the sideResets default borders on other sides

Structure Notes

  • Always define <Head /> inside <Tailwind> when using Tailwind CSS
  • <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

import { render } from 'react-email';
import { WelcomeEmail } from './emails/welcome';

const html = await render(
  <WelcomeEmail name="John" verificationUrl="https://example.com/verify" />
);

Convert to Plain Text

const text = await render(<WelcomeEmail name="John" verificationUrl="https://example.com/verify" />, { plainText: true });

Sending

React Email supports sending with any email service provider. See references/SENDING.md for complete sending documentation including Resend, Nodemailer, and SendGrid examples.

Quick example using the Resend SDK:

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 <[email protected]>',
  to: ['[email protected]'],
  subject: 'Welcome to Acme',
  react: <WelcomeEmail name="John" verificationUrl="https://example.com/verify" />
});

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:

CommandDescription
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 startRun the built preview app
email export --outDir <path> --pretty --plainText --dir <path>Export templates to static HTML files
email resend setupConnect the CLI to your Resend account via API key
email resend resetRemove the stored Resend API key

Internationalization

See references/I18N.md for complete i18n documentation. React Email supports three libraries: next-intl, react-i18next, and react-intl.

Email Editor

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.

See 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

Quick example:

import { EmailEditor, type EmailEditorRef } fro

---

*Content truncated.*

When not to use it

  • When media queries are required for responsive design
  • When using SVG or WEBP image formats

Prerequisites

Node.jsReactTypeScript

Limitations

  • Limited support for CSS media queries
  • Incompatibility with SVG and WEBP image formats
  • Requires specific Tailwind presets to avoid rem units

How it compares

Unlike manual HTML email coding, this approach uses a component-based architecture that enforces email-safe structures and provides a live preview server.

Compared to similar skills

react-email side by side with the closest alternatives in the catalog.

SkillInstallsUpdatedSafetyDifficulty
react-email (this skill)52moReviewIntermediate
web-development52moNo flagsIntermediate
webf-quickstart17moReviewBeginner
fullstack-guardian13moNo flagsAdvanced

Try saying

Example prompts that trigger this skill in your AI assistant.

You might also like

web-development

TencentCloudBase

Web frontend project development rules. Use this skill when developing web frontend pages, deploying static hosting, and integrating CloudBase Web SDK.

514

webf-quickstart

openwebf

Get started with WebF development - setup WebF Go, create a React/Vue/Svelte project with Vite, and load your first app. Use when starting a new WebF project, onboarding new developers, or setting up development environment.

16

fullstack-guardian

Jeffallan

Use when implementing features across frontend and backend, building APIs with UI, or creating end-to-end data flows. Invoke for feature implementation, API development, UI building, cross-stack work.

15

podcast-generation

microsoft

Generate AI-powered podcast-style audio narratives using Azure OpenAI's GPT Realtime Mini model via WebSocket. Use when building text-to-speech features, audio narrative generation, podcast creation from content, or integrating with Azure OpenAI Realtime API for real audio output. Covers full-stack implementation from React frontend to Python FastAPI backend with WebSocket streaming.

13

react-server

lazarv

Build applications with @lazarv/react-server — a React Server Components runtime built on Vite. Covers use directives, file-system router, HTTP hooks, caching, live components, workers, MCP, deployment, and all core APIs.

00

hap-view-plugin

garfield-bb

创建和开发明道云 HAP 自定义视图插件的技能。**立即触发条件**:用户提到"HAP 视图插件"、"自定义视图"、"mdye"、"视图开发"、"插件开发"、"初始化视图项目"、"启动视图调试"。提供完整的开发工作流程、API 使用指南和最佳实践。

00

Search skills

Search the agent skills registry