The excellent drag-n-drop email editor by Unlayer as a Vue 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 |
Check out the live demo here: https://vue-email-editor-demo.netlify.app/ (Source Code)
The easiest way to use Vue Email Editor is to install it from Npm or Yarn and include it in your own Vue build process.
npm install vue-email-editor --save
or
yarn add vue-email-editor
Next, you'll need to import the Email Editor component to your app.
App.vue
<template>
<div id="app">
<div class="container">
<div id="bar">
<h1>Vue Email Editor (Demo)</h1>
<button v-on:click="saveDesign">Save Design</button>
<button v-on:click="exportHtml">Export HTML</button>
</div>
<EmailEditor
ref="emailEditor"
v-on:load="editorLoaded"
v-on:ready="editorReady"
/>
</div>
</div>
</template>
<script>
import { EmailEditor } from 'vue-email-editor';
export default {
name: 'app',
components: {
EmailEditor,
},
methods: {
// called when the editor is created
editorLoaded() {
console.log('editorLoaded');
// Pass the template JSON here
// this.$refs.emailEditor.editor.loadDesign({});
},
// called when the editor has finished loading
editorReady() {
console.log('editorReady');
},
saveDesign() {
this.$refs.emailEditor.editor.saveDesign((design) => {
console.log('saveDesign', design);
});
},
exportHtml() {
this.$refs.emailEditor.editor.exportHtml((data) => {
console.log('exportHtml', data);
});
},
},
};
</script>| 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.
editorIdStringHTML div id of the container where the editor will be embedded (optional)minHeightStringminimum height to initialize the editor with (default 500px)optionsObjectoptions passed to the Unlayer editor instance (default {})toolsObjectconfiguration for the built-in and custom tools (default {})appearanceObjectconfiguration for appearance and theme (default {})projectIdIntegerUnlayer project ID (optional)localeStringtranslations string (default en-US)
See the Unlayer Docs for all available options.
Here's an example using the above properties...
App.vue
<template>
<div id="app">
<div class="container">
<div id="bar">
<h1>Vue Email Editor (Demo)</h1>
<button v-on:click="saveDesign">Save Design</button>
<button v-on:click="exportHtml">Export HTML</button>
</div>
<EmailEditor
:appearance="appearance"
:min-height="minHeight"
:project-id="projectId"
:locale="locale"
:tools="tools"
:options="options"
ref="emailEditor"
v-on:load="editorLoaded"
v-on:ready="editorReady"
/>
</div>
</div>
</template>
<script>
import { EmailEditor } from 'vue-email-editor';
export default {
name: 'app',
components: {
EmailEditor,
},
data() {
return {
minHeight: '1000px',
locale: 'en',
projectId: 0, // replace with your project id
tools: {
// disable image tool
image: {
enabled: false,
},
},
options: {},
appearance: {
theme: 'dark',
panels: {
tools: {
dock: 'right',
},
},
},
};
},
methods: {
// called when the editor is created
editorLoaded() {
console.log('editorLoaded');
// Pass your template JSON here
// this.$refs.emailEditor.editor.loadDesign({});
},
// called when the editor has finished loading
editorReady() {
console.log('editorReady');
},
saveDesign() {
this.$refs.emailEditor.editor.saveDesign((design) => {
console.log('saveDesign', design);
});
},
exportHtml() {
this.$refs.emailEditor.editor.exportHtml((data) => {
console.log('exportHtml', data);
});
},
},
};
</script>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 by PhraseApp
Copyright (c) 2024 Unlayer. MIT Licensed.