mirror of
https://github.com/resend/react-email.git
synced 2026-09-14 14:18:02 +08:00
576a4e1fb5
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@react-email/img
Display an image in your email.
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.
import { Img } from "@react-email/img";
const Email = () => {
return <Img src="cat.jpg" alt="Cat" width="300" height="300" />;
};
Props
| Name | Type | Default | 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
