> ## 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.

# HTML

> A React html component to wrap emails.

## Install

Install component from your command line.

```sh npm theme={"theme":{"light":"github-light","dark":"vesper"}}
npm install react-email -E
```

```sh yarn theme={"theme":{"light":"github-light","dark":"vesper"}}
yarn add react-email -E
```

```sh pnpm theme={"theme":{"light":"github-light","dark":"vesper"}}
pnpm add react-email -E
```

## Getting started

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

```jsx theme={"theme":{"light":"github-light","dark":"vesper"}}
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

> [!NOTE]
>
> When customizing `lang` and/or `dir`, you should set the same values on the
> [`Body`](https://react.email/docs/components/body) component. Some email clients strip the `html` or
> `body` tags, so it's necessary to have both.

## Support

All components were tested using the most popular email clients.

![Gmail](https://react.email/static/icons/gmail.svg)

Gmail

![Apple Mail](https://react.email/static/icons/apple-mail.svg)

Apple Mail

![Outlook](https://react.email/static/icons/outlook.svg)

Outlook

![Yahoo! Mail](https://react.email/static/icons/yahoo-mail.svg)

Yahoo! Mail

![HEY](https://react.email/static/icons/hey.svg)

HEY

![Superhuman](https://react.email/static/icons/superhuman.svg)

Superhuman


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.