README.md

@jsx-email/preview

A JSX email component which renders a preview viewable in recipient email clients

@jsx-email/preview Documentation

Requirements

This package requires an LTS Node version (v18.0.0+) and React v18.2.0+.

Install

pnpm add @jsx-email/preview

# We recommend pnpm - https://pnpm.io
# But npm and yarn are supported
# npm add @jsx-email/preview
# yarn add @jsx-email/preview

Usage

We recommend using the @jsx-email/cli for creating new templates.

Create an email template file (e.g. Email.tsx) and import the component:

import { Preview } from '@jsx-email/preview';

const Email = () => {
  return <Preview>Email preview text</Preview>;
};

Please see the @jsx-email/preview Documentation for props and additional usage information.

Attribution 🧡

This package was built upon prior work for react-email by Bu Kinoshita (@bukinoshita) and Zeno Rocha (@zenorocha).

License

MIT License