SuperAPI AI 工具集

json-render-react-email

前端与建站

查看项目

更新于 10-15 17:23

技能介绍

用途:把 JSON 规格(spec)渲染为 HTML 邮件或纯文本邮件,服务端可用,也可在浏览器中预览。

主要能力:提供 renderToHtml(spec, options?) 与 renderToPlainText(spec, options?) 两个服务端渲染函数;支持 visible 条件、$state、$cond、repeat(repeat.statePath)等表达式;可自定义组件目录(defineCatalog、defineRegistry),内置 Html、Head、Body、Container、Section、Row、Column、Heading、Text、Link、Button、Image、Hr、Preview、Markdown 等组件。

使用方式:安装后从 @json-render/react-email 导入 schema、standardComponentDefinitions、renderToHtml 等。规格为扁平元素树,含 root 与 elements;root 必须是 Html,其子节点为 Head 与 Body,Body 内用 Container 控制宽度(如 max-width 600px)。服务端渲染传入 state 以解析表达式。子路径导出:/server(仅 schema 与目录,不含 React)、/catalog(标准组件定义与类型)、/render(仅渲染函数)。

适用场景:程序化生成邮件模板、由 JSON 配置驱动邮件内容、服务端批量渲染邮件。

限制:邮件客户端兼容性有限,应使用内联样式(style 对象),避免外部 CSS;优先用基于表格的布局(Section、Row、Column);图片使用绝对 URL;建议在 Gmail、Outlook、Apple Mail 等多客户端测试。资料未提供安装命令、许可证与具体版本信息。