​
Install

Install component from your command line.

npm install @react-email/components -E

# or get the individual package

npm install @react-email/html -E

​
Getting started

Add the component to your email template. Include styles where needed.

import { Html, Button } from "@react-email/components";

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.

Gmail

Gmail

Apple Mail

Apple Mail

Outlook

Outlook

Yahoo! Mail

Yahoo! Mail

HEY

HEY

Superhuman

Superhuman

Migrating to React EmailHead