JSPM

  • Created
  • Published
  • Downloads 3941535
  • Score
    100M100P100Q11035F
  • License MIT

A React button component to help build emails

Package Exports

  • @react-email/button
  • @react-email/button/dist/index.js
  • @react-email/button/dist/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@react-email/button) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

React Email button cover

@react-email/button
A React button component to help build emails.

Install

Install component from your command line.

With yarn

yarn add @react-email/button -E

With npm

npm install @react-email/button -E

Getting started

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

import { Button } from '@react-email/button';

const Email = () => {
  return (
    <Button href="https://example.com" style={{ color: '#61dafb' }}>
      Click me
    </Button>
  );
};

Props

Name Type Default Description
href string Link to be triggered when the button is clicked
target string _blank Specify the target attribute for the button link

Support

This component was tested using the most popular email clients.

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

License

MIT License