newsletter-builder
  • Type to search the documentation.

Components

Components

API reference for NewsletterBuilder, NewsletterRenderer and the headless useNewsletterEditor hook.

NewsletterBuilder

The complete editor. It owns the document state, so pass initialDocument once and listen with onChange.

NewsletterBuilder props

Handling image uploads

upload to your storage
<NewsletterBuilder
  onImageUpload={async (file) => {
    const body = new FormData()
    body.set('file', file)
    const res = await fetch('/api/upload', { method: 'POST', body })
    const { url } = await res.json()
    return url // must be a public https URL
  }}
/>

NewsletterRenderer

Renders a document exactly as it will be exported, in an iframe with sandbox="allow-same-origin allow-popups". Scripts cannot run inside it.

NewsletterRenderer props

dark mobile preview
<NewsletterRenderer
  document={doc}
  previewData={{ firstName: 'Ada' }}
  colorMode="dark"
  device="mobile"
  autoHeight
/>

useNewsletterEditor

The headless state behind the builder. Use it to build your own toolbar, inspector or an automated editing flow.

custom toolbar
import { useNewsletterEditor, createBlock, createWelcomeTemplate } from 'newsletter-builder-react'

function MiniEditor() {
  const editor = useNewsletterEditor(createWelcomeTemplate(), (doc) => save(doc))

  return (
    <>
      <button onClick={() => editor.appendBlock(createBlock('divider'))}>Add divider</button>
      <button onClick={editor.undo} disabled={!editor.canUndo}>Undo</button>
    </>
  )
}

NewsletterEditorApi