Skip to main content

Documentation Index

Fetch the complete documentation index at: https://react.email/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Install

Install component from your command line. 
npm install react-email -E

​
Getting started

Add the component to your email template. Include styles where needed. 
import { Html, Button } from "react-email";

const Email = () => {
  return (
    <Html lang="en" dir="ltr">
      <Button href="https://example.com" style={{ color: "#61dafb" }}>
        Click me
      </Button>
    </Html>
  );
};

​
Props

​
lang
string
default:"en"
Identify the language of text content on the email
​
dir
string
default:"ltr"
Identify the direction of text content on the email

​
Support

All components were tested using the most popular email clients.
GmailGmail
Apple MailApple Mail
OutlookOutlook
Yahoo! MailYahoo! Mail
HEYHEY
SuperhumanSuperhuman