@react-email/img
Version:
Display an image in your email
62 lines (43 loc) • 3.24 kB
Markdown
<div align="center"><strong>@react-email/img</strong></div>
<div align="center">Display an image in your email.</div>
<br />
<div align="center">
<a href="https://react.email">Website</a>
<span> · </span>
<a href="https://github.com/resend/react-email">GitHub</a>
<span> · </span>
<a href="https://react.email/discord">Discord</a>
</div>
## Install
Install component from your command line.
#### With yarn
```sh
yarn add @react-email/img -E
```
#### With npm
```sh
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 <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.
| <img src="https://react.email/static/icons/gmail.svg" width="48px" height="48px" alt="Gmail logo"> | <img src="https://react.email/static/icons/apple-mail.svg" width="48px" height="48px" alt="Apple Mail"> | <img src="https://react.email/static/icons/outlook.svg" width="48px" height="48px" alt="Outlook logo"> | <img src="https://react.email/static/icons/yahoo-mail.svg" width="48px" height="48px" alt="Yahoo! Mail logo"> | <img src="https://react.email/static/icons/hey.svg" width="48px" height="48px" alt="HEY logo"> | <img src="https://react.email/static/icons/superhuman.svg" width="48px" height="48px" alt="Superhuman logo"> |
| -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| Gmail ✔ | Apple Mail ✔ | Outlook ✔ | Yahoo! Mail ✔ | HEY ✔ | Superhuman ✔ |
## License
MIT License