React Email Editor

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

ReactEmailRich text editor
unlayer/react-email-editorunlayer.com/embedreact-email-editor

README

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.

  1. ```
  2. npm install react-email-editor --save
  3. ```

Usage


Require the EmailEditor component and render it with JSX:

  1. ``` js
  2. import React, { useRef } from 'react';
  3. import { render } from 'react-dom';

  5. import EmailEditor from 'react-email-editor';

  7. const App = (props) => {
  8.   const emailEditorRef = useRef(null);

  10.   const exportHtml = () => {
  11.     emailEditorRef.current.editor.exportHtml((data) => {
  12.       const { design, html } = data;
  13.       console.log('exportHtml', html);
  14.     });
  15.   };

  17.   const onLoad = () => {
  18.     // editor instance is created
  19.     // you can load your template here;
  20.     // const templateJson = {};
  21.     // emailEditorRef.current.editor.loadDesign(templateJson);
  22.   }

  24.   const onReady = () => {
  25.     // editor is ready
  26.     console.log('onReady');
  27.   };

  29.   return (
  30.     <div>
  31.       <div>
  32.         <button onClick={exportHtml}>Export HTML</button>
  33.       </div>
  34. <EmailEditor ref={emailEditorRef} onLoad={onLoad} onReady={onReady} />
  35.     </div>
  36.   );
  37. };

  39. render(<App />, document.getElementById('app'));
  40. ```

Methods


methodparamsdescription
----------------------------------------------------------------------------------------
**loadDesign**`ObjectTakes
**saveDesign**`FunctionReturns
**exportHtml**`FunctionReturns

See the example source for a reference implementation.

Properties


- editorId String HTML div id of the container where the editor will be embedded (optional)
- 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 instance is created
- onReady 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.

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