Files
vue-email-editor/docs/api/props.md
T
Josias Mekontso 02c32ccf6b docs: add VitePress documentation site with guides and API reference
- 7 guide pages: getting-started, why, theming, i18n, blocks, plugins, events, imperative-api
- 5 API reference pages: props, events, methods, types, exports
- GitHub Pages deployment workflow (deploy-docs.yml)
- Home page with feature highlights
- Local search enabled
- docs:dev, docs:build, docs:preview scripts
2026-02-25 09:12:15 +01:00

2.0 KiB

Props

Component Props

Prop Type Default Description
modelValue string '' MJML content (v-model)
designJson Record<string, unknown> — Persisted design JSON for loading saved designs
variables string[] [] Available merge variables displayed in the sidebar
labels Partial<EditorLabels> DEFAULT_LABELS i18n label overrides
label string — Form field label (when used in a form)
required boolean false Form validation required flag
theme Partial<ThemeConfig> DEFAULT_THEME Visual customization
plugins Plugin[] [] Editor extensions

modelValue / v-model

The MJML source string. Updated whenever the document changes.

<EmailEditor v-model="mjml" />

designJson

Pass a saved design to load it. The editor detects the format:

  • New format ({ _editor: 'mesagoo-email-editor', ... }) — loaded directly
  • Legacy GrapesJS format — parsed via MJML fallback
<EmailEditor :design-json="savedDesign" />

variables

List of merge variable names displayed in a sidebar panel:

<EmailEditor :variables="['first_name', 'last_name', 'company']" />

labels

Partial label overrides. Missing keys fall back to English defaults. See i18n guide.

<EmailEditor :labels="{ editor_title: 'My Editor' }" />

theme

Partial theme overrides. See Theming guide for all 25 properties.

<EmailEditor :theme="{ primaryColor: '#7C3AED' }" />

plugins

Array of plugin functions. See Plugins guide.

<EmailEditor :plugins="[myPlugin, anotherPlugin]" />

Emitted Events (Vue)

Event Payload Description
update:modelValue string MJML source updated
update:compiled-html string Compiled HTML updated
update:design-json EmailDesignJson Design JSON updated