@trippete/angular-email-editor
v3.0.0
Published
The excellent drag-n-drop email editor by [Unlayer](https://unlayer.com/embed) as a [Angular](https://angular.io/) _wrapper component_. This is the most powerful and developer friendly visual email builder for your app.
Downloads
217
Keywords
Readme
Angular Email Editor
The excellent drag-n-drop email editor by Unlayer as a Angular 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://angular-email-editor-demo.netlify.com/ (Source Code)
Installation
The easiest way to use Angular Email Editor is to install it from Npm or Yarn and include it in your own Angular build process.
npm install @trippete/angular-email-editor --save
Usage
Next, you'll need to import the Email Editor module in your app's module.
app.module.ts
import { EmailEditorModule } from 'angular-email-editor';
...
@NgModule({
...
imports: [ EmailEditorModule ],
...
});
app.component.ts
import { Component, ViewChild } from '@angular/core';
import { EmailEditorComponent } from 'angular-email-editor';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css'],
})
export class AppComponent {
title = 'angular-email-editor';
@ViewChild(EmailEditorComponent)
private emailEditor: EmailEditorComponent;
// called when the editor is created
editorLoaded() {
console.log('editorLoaded');
// load the design json here
// this.emailEditor.editor.loadDesign({});
}
// called when the editor has finished loading
editorReady() {
console.log('editorReady');
}
exportHtml() {
this.emailEditor.editor.exportHtml((data) =>
console.log('exportHtml', data)
);
}
}
app.component.html
<div class="container">
<button (click)="exportHtml()">Export</button>
<email-editor
(loaded)="editorLoaded($event)"
(ready)="editorReady($event)"
></email-editor>
</div>
Methods
| 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 |
See the example source for a reference implementation.
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)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)loaded
Function
called when the editor instance is createdready
Function
called when the editor has finished loading
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
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) 2021 Unlayer. MIT Licensed.