Repository files navigation

The excellent drag-n-drop email editor byUnlayer as aAngularwrapper 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

Check out the live demo here:https://angular-email-editor-demo.netlify.app/ (Source Code)

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

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

app.module.ts

If you don't have anapp.module.ts file, you can ignore this step and addimports: [ EmailEditorModule ] to yourapp.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],})exportclassAppComponent{title='angular-email-editor';options:EmailEditorComponent['options']={version:'latest',appearance:{theme:'modern_dark',},};  @ViewChild(EmailEditorComponent)privateemailEditor!:EmailEditorComponent;privategetunlayer(){returnthis.emailEditor.editor;}// called when the editor is creatededitorLoaded(){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 loadingeditorReady(){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

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

Skip Lib Check

SetskipLibCheck: true intsconfig.json.

tsconfig.json

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

See theexample source for a reference implementation.

All unlayer methods are available inthis.unlayer. Here are the most used ones:

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

• editorIdString HTML div id of the container where the editor will be embedded (optional)
• minHeightString minimum height to initialize the editor with (default 500px)
• optionsObject options passed to the Unlayer editor instance (default {})
• toolsObject configuration for the built-in and custom tools (default {})
• appearanceObject configuration for appearance and theme (default {})
• projectIdInteger Unlayer project ID (optional)
• loadedFunction called when the editor instance is created
• readyFunction called when the editor has finished loading

See theUnlayer Docs for all available options.

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

You can submit new language translations by creating a PR on this GitHub repo:https://github.com/unlayer/translations. Translations managed byPhraseApp

Copyright (c) 2024 Unlayer.MIT Licensed.