@react-email/button 0.0.1 → 0.0.3

package/dist/index.js

@@ -34,8 +34,9 @@ module.exports = __toCommonJS(src_exports);
 var React = __toESM(require("react"));
 var import_jsx_runtime = require("react/jsx-runtime");
 var Button = React.forwardRef(
-  ({ children, style, ...props }, forwardedRef) => /* @__PURE__ */ (0, import_jsx_runtime.jsx)("a", {
+  ({ children, style, target = "_blank", ...props }, forwardedRef) => /* @__PURE__ */ (0, import_jsx_runtime.jsx)("a", {
     ref: forwardedRef,
+    target,
     dangerouslySetInnerHTML: {
       __html: `<!--[if mso]><i style="letter-spacing: 25px;mso-font-width:-100%;mso-text-raise:30pt" hidden>&nbsp;</i><![endif]--><span>${children}</span><!--[if mso]><i style="letter-spacing: 25px;mso-font-width:-100%" hidden>&nbsp;</i><![endif]-->`
     },

package/dist/index.mjs

@@ -2,8 +2,9 @@
 import * as React from "react";
 import { jsx } from "react/jsx-runtime";
 var Button = React.forwardRef(
-  ({ children, style, ...props }, forwardedRef) => /* @__PURE__ */ jsx("a", {
+  ({ children, style, target = "_blank", ...props }, forwardedRef) => /* @__PURE__ */ jsx("a", {
     ref: forwardedRef,
+    target,
     dangerouslySetInnerHTML: {
       __html: `<!--[if mso]><i style="letter-spacing: 25px;mso-font-width:-100%;mso-text-raise:30pt" hidden>&nbsp;</i><![endif]--><span>${children}</span><!--[if mso]><i style="letter-spacing: 25px;mso-font-width:-100%" hidden>&nbsp;</i><![endif]-->`
     },

package/license.md

@@ -0,0 +1,7 @@
+Copyright 2022 Bu Kinoshita and Zeno Rocha
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@react-email/button",
-  "version": "0.0.1",
+  "version": "0.0.3",
+  "description": "A React button component to help build emails",
   "sideEffects": false,
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -13,14 +14,25 @@
     "build": "tsup src/index.ts --format esm,cjs --dts --external react",
     "dev": "tsup src/index.ts --format esm,cjs --dts --external react --watch",
     "lint": "TIMING=1 eslint src/**/*.ts* --fix",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "format:check": "prettier --check \"**/*.{ts,tsx,md}\"",
+    "format": "prettier --write \"**/*.{ts,tsx,md}\""
+  },
+  "dependencies": {
+    "react": "18.2.0"
   },
   "devDependencies": {
+    "@babel/preset-react": "7.18.6",
+    "@react-email/render": "*",
     "@types/react": "18.0.20",
     "@types/react-dom": "18.0.6",
+    "babel-jest": "28.1.3",
     "eslint": "8.23.1",
     "eslint-config-custom": "*",
-    "react": "18.2.0",
+    "jest": "28.1.3",
+    "ts-jest": "28.0.8",
     "tsconfig": "*",
     "tsup": "6.2.3",
     "typescript": "4.8.3"

package/readme.md

@@ -1,4 +1,4 @@
-![React Email button cover](../../.github/static/button.png)
+![React Email button cover](https://react.email/static/images/readme/covers/button.png)
 
 <div align="center"><strong>@react-email/button</strong></div>
 <div align="center">A React button component to help build emails.</div>
@@ -6,44 +6,57 @@
 <div align="center">
 <a href="https://react.email">Website</a> 
 <span> · </span>
-<a href="https://react.email">Documentation</a> 
+<a href="https://github.com/zenorocha/react-email">GitHub</a> 
 <span> · </span>
-<a href="https://react.email">Twitter</a>
+<a href="https://react.email/discord">Discord</a>
 </div>
 
-## Installation
+## Install
+
+Install component from your command line.
 
 #### With yarn
 
 ```sh
-yarn add -E @react-email/button
+yarn add @react-email/button -E
 ```
 
-#### With NPM
+#### With npm
 
 ```sh
-npm install --save-exact @react-email/button
+npm install @react-email/button -E
 ```
 
-## Getting Started
+## Getting started
 
-Add the `Button` to your app first.
+Add the component to your email template. Include styles where needed.
 
 ```jsx
 import { Button } from '@react-email/button';
 
-const App = () => {
+const Email = () => {
   return (
-    <div>
-      <Button href="https://react.email">Button</Button>
-    </div>
+    <Button href="https://example.com" style={{ color: '#61dafb' }}>
+      Click me
+    </Button>
   );
 };
 ```
 
-## Documentation
+## 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.
 
-Find the full API reference on [official documentation](https://react.email).
+| <img src="https://react.email/static/images/readme/icons/gmail.svg" width="48px" height="48px" alt="Gmail logo"> | <img src="https://react.email/static/images/readme/icons/apple-mail.svg" width="48px" height="48px" alt="Apple Mail"> | <img src="https://react.email/static/images/readme/icons/outlook.svg" width="48px" height="48px" alt="Outlook logo"> | <img src="https://react.email/static/images/readme/icons/yahoo-mail.svg" width="48px" height="48px" alt="Yahoo! Mail logo"> | <img src="https://react.email/static/images/readme/icons/hey.svg" width="48px" height="48px" alt="HEY logo"> | <img src="https://react.email/static/images/readme/icons/superhuman.svg" width="48px" height="48px" alt="Superhuman logo"> |
+| --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
+| Gmail ✔                                                                                             | Apple Mail ✔                                                                                             | Outlook ✔                                                                                               | Yahoo! Mail ✔                                                                                                  | HEY ✔                                                                                           | Superhuman ✔                                                                                                  |
 
 ## License