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.app/ (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 angular-email-editor --save

Usage

Next, you'll need to import the Email Editor module in your app's module.

app.module.ts

If you don't have an app.module.ts file, you can ignore this step and add imports: [ EmailEditorModule ] to your app.component.ts instead.

import { EmailEditorModule } from 'angular-email-editor';
...

@NgModule({
  ...
  imports: [ EmailEditorModule ],
  ...
});

app.component.ts

import { Component, ViewChild } from '@angular/core';
import { EmailEditorComponent, EmailEditorModule } from 'angular-email-editor';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css'],
  imports: [EmailEditorModule],
})
export class AppComponent {
  title = 'angular-email-editor';
  options: EmailEditorComponent['options'] = {
    version: 'latest',
    appearance: {
      theme: 'modern_dark',
    },
  };

  @ViewChild(EmailEditorComponent)
  private emailEditor!: EmailEditorComponent;

  private get unlayer() {
    return this.emailEditor.editor;
  }

  // called when the editor is created
  editorLoaded() {
    console.log('editorLoaded');
    // load the design json here
    // you can get the design json by calling unlayer.exportHtml (see below)
    // this.unlayer.loadDesign({ /* json object here */ });
  }

  // called when the editor has finished loading
  editorReady() {
    console.log('editorReady');
  }

  exportHtml() {
    this.unlayer.exportHtml((result) => {
      // result object format: { html: string, design: object, amp: object, chunks: object }
      console.log('exportHtml', result);
    });
  }
}

app.component.html

<div class="container">
  <button (click)="exportHtml()">Export</button>
  <email-editor
    [options]="options"
    (loaded)="editorLoaded()"
    (ready)="editorReady()"
  ></email-editor>
</div>

Skip Lib Check

Set skipLibCheck: true in tsconfig.json.

tsconfig.json

{
  "compilerOptions": {
    "skipLibCheck": true,
  }
}

See the example source for a reference implementation.

Methods

All unlayer methods are available in this.unlayer. 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

See the Unlayer Docs for all available methods, or log the object in the console to explore it.

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 created
• ready 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) 2024 Unlayer. MIT Licensed.