diff --git a/README.md b/README.md index 87a03f0..fca09a2 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Vue Email Editor -The excellent drag-n-drop email editor by [Unlayer](https://unlayer.com/embed) as a [Vue](https://vuejs.org/) *wrapper component*. This is the most powerful and developer friendly visual email builder for your app. +The excellent drag-n-drop email editor by [Unlayer](https://unlayer.com/embed) as a [Vue](https://vuejs.org/) _wrapper component_. This is the most powerful and developer friendly visual email builder for your app. -Video Overview | -:---: | -[![Vue Email Editor](https://unroll-assets.s3.amazonaws.com/unlayervideotour.png)](https://www.youtube.com/watch?v=MIWhX-NF3j8) | -*Watch video overview: https://youtu.be/MIWhX-NF3j8* | +| Video Overview | +| :-----------------------------------------------------------------------------------------------------------------------------: | +| [![Vue Email Editor](https://unroll-assets.s3.amazonaws.com/unlayervideotour.png)](https://www.youtube.com/watch?v=MIWhX-NF3j8) | +| _Watch video overview: https://youtu.be/MIWhX-NF3j8_ | ## Live Demo @@ -48,12 +48,12 @@ Next, you'll need to import the Email Editor component to your app. ``` ### 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 | + +| 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](https://github.com/unlayer/vue-email-editor/tree/master/src) for a reference implementation. ### Properties -* `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) -* `locale` `String` translations string (default en-US) +- `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) +- `locale` `String` translations string (default en-US) +- `displayMode` `String` configuration for display mode (`web` or `email`) (default `email`) See the [Unlayer Docs](https://docs.unlayer.com/) for all available options. Here's an example using the above properties... -**App.vue** +**App.vue** + ```html ``` @@ -188,7 +183,6 @@ Custom tools can help you add your own content blocks to the editor. Every appli [![Custom Tools](https://unroll-assets.s3.amazonaws.com/custom_tools.png)](https://docs.unlayer.com/docs/custom-tools) - ## Localization You can submit new language translations by creating a PR on this GitHub repo: https://github.com/unlayer/translations. Translations managed by [PhraseApp](https://phraseapp.com) diff --git a/src/components/EmailEditor.vue b/src/components/EmailEditor.vue index dae1a8a..b2f1b1e 100644 --- a/src/components/EmailEditor.vue +++ b/src/components/EmailEditor.vue @@ -1,5 +1,9 @@ \ No newline at end of file +