Skip to content
Drag-n-Drop Email Editor Component for React.js
JavaScript
Branch: master
Clone or download

Latest commit

Latest commit eecf9ca Mar 13, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo/src Updated demo bar color. Oct 27, 2019
src Updated to 1.0.0. Sep 20, 2019
tests Initial commit from nwb v0.18.10 Oct 1, 2017
.gitignore Initial commit from nwb v0.18.10 Oct 1, 2017
.travis.yml Initial commit from nwb v0.18.10 Oct 1, 2017
CONTRIBUTING.md Initial commit from nwb v0.18.10 Oct 1, 2017
LICENSE
README.md Update README.md Mar 13, 2020
nwb.config.js Initial commit from nwb v0.18.10 Oct 1, 2017
package-lock.json Updated to 1.0.0. Sep 20, 2019
package.json Updated to 1.0.0. Sep 20, 2019

README.md

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) 2020 Unlayer. MIT Licensed.

You can’t perform that action at this time.