npmpackage.info

react-email-editor

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

1.7.11

4,633

MIT

TypeScript

5,530,283 2.9

Installations

npm install react-email-editor

Score

95.5

Supply Chain

97.9

Quality

81.1

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

4

Total

74

Closed

44

Merged

26

Issues

Open

215

Total

362

Closed

147

Releases

Unable to fetch releases

Contributors

View all 12 contributors

Developer

unlayer

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=10

Typescript Support

No

Node Version

16.13.0

NPM Version

8.1.0 Statistics

4,633 Stars

193 Commits

744 Forks

52 Watching

8 Branches

12 Contributors

Updated on 29 Nov 2024

Languages

TypeScript (90.28%)

JavaScript (9.72%)

Total Downloads

Cumulative downloads

Total Downloads

5,530,283

Last day

-9.7%

8,047

Compared to previous day

Last week

9.3%

47,725

Compared to previous week

Last month

2.1%

186,389

Compared to previous month

Last year

71.7%

2,513,849

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

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

Watch video overview: https://youtu.be/MIWhX-NF3j8

Live Demo

Check out the live demo here: https://react-email-editor-demo.netlify.app/ (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:

1import React, { useRef } from 'react';
2import { render } from 'react-dom';
3
4import EmailEditor, { EditorRef, EmailEditorProps } from 'react-email-editor';
5
6const App = (props) => {
7  const emailEditorRef = useRef<EditorRef>(null);
8
9  const exportHtml = () => {
10    const unlayer = emailEditorRef.current?.editor;
11
12    unlayer?.exportHtml((data) => {
13      const { design, html } = data;
14      console.log('exportHtml', html);
15    });
16  };
17
18  const onReady: EmailEditorProps['onReady'] = (unlayer) => {
19    // editor is ready
20    // you can load your template here;
21    // the design json can be obtained by calling
22    // unlayer.loadDesign(callback) or unlayer.exportHtml(callback)
23
24    // const templateJson = { DESIGN JSON GOES HERE };
25    // unlayer.loadDesign(templateJson);
26  };
27
28  return (
29    <div>
30      <div>
31        <button onClick={exportHtml}>Export HTML</button>
32      </div>
33
34      <EmailEditor ref={emailEditorRef} onReady={onReady} />
35    </div>
36  );
37};
38
39render(<App />, document.getElementById('app'));

See the example source for a reference implementation.

Methods

All unlayer methods are available in the editor instance (emailEditorRef.current.editor). See the Unlayer Docs for more information, or log the object in the console to explore it. Here are the most used ones:

method	params	description
loadDesign	`Object data`	Takes the design JSON and loads it in the editor
saveDesign	`Function callback`	Returns the design JSON in a callback function
exportHtml	`Function callback`	Returns the design HTML and JSON in a callback function

Properties

editorId {String} HTML div id of the container where the editor will be embedded (optional)
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 {})
- See the Unlayer Docs for all available options.
style {Object} style object for the editor container (default {})

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

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

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

5

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

2

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.9

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to react-email-editor

@types/react-email-editor

1.5.6

TypeScript definitions for react-email-editor

md-to-react-email

5.0.4

A simple Markdown to jsx parser for email templates written in typescript.

react-email

3.0.2

A live preview of your emails right in your browser.

@react-email/render

1.0.2

Transform React components into HTML email templates

react-email-editor

Installations

Score

Pull Requests

4

74

44

26

Issues

215

362

147

Releases

Unable to fetch releases

Contributors

Developer

Developer Guide

CommonJS

>=10

No

16.13.0

8.1.0

Statistics

Languages

Total Downloads

5,530,283

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

React Email Editor

Live Demo

Blog Post

Installation

Usage

Methods

Properties

Custom Tools

Localization

License

10

10

5

2

2

0

0

0

0

0

2.9

/10

Other packages similar to react-email-editor