react-email-editor

Drag-n-Drop Email Editor Component for React.js

Github stars Tracking Chart

React Email Editor

The excellent drag-n-drop email editor by Unlayer as a React.js wrapper component. This is the most powerful and developer friendly visual email builder for your app.

Video Overview, :---:, React Email Editor, Watch video overview: https://youtu.be/MIWhX-NF3j8, ## Live Demo

Check out the live demo here: http://react-email-editor-demo.netlify.com/ (Source Code)

Blog Post

Here's a blog post with a quickstart guide: https://medium.com/unlayer-blog/creating-a-drag-n-drop-email-editor-with-react-db1e9eb42386

Installation

The easiest way to use React Email Editor is to install it from NPM and include it in your own React build process.

npm install react-email-editor --save

Usage

Require the EmailEditor component and render it with JSX:

import React, { Component } from 'react'
import { render } from 'react-dom'

import EmailEditor from 'react-email-editor'

class App extends Component {
  render() {
    return <div>
      <h1>react-email-editor Demo</h1>

      <div>
        <button onClick={this.exportHtml}>Export HTML</button>
      </div>

      <EmailEditor
        ref={editor => this.editor = editor}
      />
    </div>
  }

  exportHtml = () => {
    this.editor.exportHtml(data => {
      const { design, html } = data
      console.log('exportHtml', html)
    })
  }
}

render(<App />, document.getElementById('app'))

Properties

  • style Object style object for the editor container (default {})
  • minHeight String minimum height to initialize the editor with (default 500px)
  • onLoad Function called when the editor has finished loading
  • options Object options passed to the Unlayer editor instance (default {})
  • tools Object configuration for the built-in and custom tools (default {})
  • appearance Object configuration for appearance and theme (default {})
  • projectId Integer Unlayer project ID (optional)

See the Unlayer Docs for all available options.

Methods

  • loadDesign - function(Object data) - Takes the design JSON and loads it in the editor
  • saveDesign - function(Function callback) - Returns the design JSON in a callback function
  • exportHtml - function(Function callback) - Returns the design HTML and JSON in a callback function

See the example source for a reference implementation.

Custom Tools

Custom tools can help you add your own content blocks to the editor. Every application is different and needs different tools to reach it's full potential. Learn More

Custom Tools

Localization

You can submit new language translations by creating a PR on this GitHub repo: https://github.com/unlayer/translations. Translations managed by PhraseApp

License

Copyright (c) 2019 Unlayer. MIT Licensed.

Main metrics

Overview
Name With Ownerunlayer/react-email-editor
Primary LanguageTypeScript
Program languageJavaScript (Language Count: 2)
Platform
License:MIT License
所有者活动
Created At2017-10-01 22:44:29
Pushed At2025-03-05 18:32:48
Last Commit At2024-12-06 02:28:28
Release Count1
Last Release Namev1.7.0-beta.0 (Posted on 2023-02-14 02:55:31)
First Release Namev1.7.0-beta.0 (Posted on 2023-02-14 02:55:31)
用户参与
Stargazers Count4.8k
Watchers Count52
Fork Count771
Commits Count194
Has Issues Enabled
Issues Count381
Issue Open Count231
Pull Requests Count26
Pull Requests Open Count5
Pull Requests Close Count44
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private