newsletter-builder
  • Type to search the documentation.

Getting started

Introduction

What newsletter-builder-react is, what it outputs and what it deliberately does not do.

Overview

newsletter-builder-react is a free, MIT-licensed visual email builder for React. Editors drag blocks onto a canvas, write rich text, preview light and dark mode, and export email-safe, table-based HTML with inlined CSS plus a plain-text alternative.

It is a template and HTML generator only. It never sends email, so you are never locked in to a vendor: the output is { html, text, subject }, which any SMTP library or marketing platform accepts.

  • Editor: NewsletterBuilder with palette, canvas, inspector, previews, HTML and text views, undo/redo and a quick-start walkthrough.
  • Compiler: compileNewsletter() is a pure function that runs on the server, the edge or in the browser.
  • Renderer: NewsletterRenderer shows the exact exported HTML inside a sandboxed iframe.
  • Document model: plain, versioned JSON you can store in any database.

How the pieces fit

data flow
NewsletterBuilder  --onChange-->  NewsletterDocument (JSON)
                                      |
                                      v
                        compileNewsletter(doc, { variables })
                                      |
                                      v
                          { html, text, subject }
                                      |
                  Nodemailer | SMTP2GO | Bird | Mailchimp | HubSpot | ActiveCampaign