Readme - React Email

<div align="center"><strong>@react-email/img</strong></div> <div align="center">Display an image in your email.</div> <div align="center"> <a href="https://react.email">Website</a> <span> · </span> <a href="https://github.com/resend/react-email">GitHub</a> </div>

Install

Install component from your command line.

With yarn

yarn add @react-email/img -E

With npm

npm install @react-email/img -E

Getting started

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

jsx

import { Img } from "@react-email/img";

const Email = () => {
  return ;
};

Props

Name	Type	Description
alt	string	Alternate description for an image
src	string	The path to the image
width	string	The width of an image in pixels
height	string	The height of an image in pixels

Support

This component was tested using the most popular email clients.


Gmail ✔	Apple Mail ✔	Outlook ✔	Yahoo! Mail ✔	HEY ✔	Superhuman ✔

License

MIT License