Back to React Email

Readme

packages/link/readme.md

0.0.153.1 KB
Original Source

<div align="center"><strong>@react-email/link</strong></div> <div align="center">A hyperlink to web pages, email addresses, or anything else a URL can address.</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

sh
yarn add @react-email/link -E

With npm

sh
npm install @react-email/link -E

Getting started

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

jsx
import { Link } from "@react-email/link";

const Email = () => {
  return <Link href="https://example.com">Example</Link>;
};

Props

NameTypeDefaultDescription
hrefstringLink to be triggered when the button is clicked
targetstring_blankSpecify the target attribute for the button link

Support

This component was tested using the most popular email clients.

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

License

MIT License