getting started

Installation

Learn how to install and configure the module in your Vue app.

Quick Start

  1. Install vue-email dependency to your project:
pnpm
pnpm i vue-email
  1. Load in your vue project:
import { createApp } from 'vue'
import { VueEmailPlugin } from 'vue-email'

app.use(VueEmailPlugin)

app.mount('#app')

That's it! You can now use all the components and composables in your app ✨

Options

KeyDescription
baseUrlThe base URL of your site, used for images.
i18nThe i18n configuration for the plugin.

Configure options in your index.ts as such:

import { createApp } from 'vue'
import { VueEmailPlugin } from 'vue-email'

app.use(VueEmailPlugin, {
  baseUrl: 'https://example.com',
  i18n: {
      defaultLocale: 'en',
      translations: {
        en: {
          greetings: 'Welcome {user}',
        },
        es: {
          greetings: 'Bienvenido {user}',
        }
      }
    }
})

app.mount('#app')