@inkdes-email/get-html
v0.2.8TypeScript
A React email helper to get the HTML of a React email component (InkDes Mailer)
reactemailemail-notificationreact-email-componentreact-emailsend-emailemail-componentinkdes-mailerinkdes-email-compsinkdes
0/weekUpdated 1 months agoMITUnpacked: 8.0 KB
Published by iclasser
npm install @inkdes-email/get-html$3
Helper function to convert Email components to text only.
Installation
``bashpnpm
pnpm add @inkdes-email/get-html
npm
npm install @inkdes-email/get-html
yarn
yarn add @inkdes-email/get-html
`
- Signature:
- Description: Renders a valid React element to a static HTML string using . Returns { html, error: null } on success or { html: null, error } on failure. Validates input with React.isValidElement.
- Example:`tsx
import { getHtml } from "@inkdes-email/get-html";
import { Html, Head, Body, Text, Button } from "@inkdes-emailcomponents";function EmailTemplate() {
return (
Hello
)
}const { html, error } = getHtml(
if (error) {
// handle error
} else if (html) {
// use html
}
``- Requirements:
- Node >= 18
- React 18 or 19