Modules

vue-email
vue-email

💌 Write email templates with vue

vue-email

npm versionnpm downloadsJSDocsLicense

@vue-email/nuxt

Official Nuxt module for Vue Email. Build email templates with Vue components.

Features

  • Auto-import Vue Email components and composables
  • useCompiler utility to render emails on the server
  • All the DX Magic that comes with Nuxt ✨
  • Vue Email DevTools integration

Ecosystem

PackageVersion
Vue-Emailtres version
Nuxtnuxt version
SSR Compilercientos version
CLItres version

Quick Setup

  1. Add @vue-email/nuxt dependency to your project
# Using pnpm
pnpm add -D @vue-email/nuxt

# Using yarn
yarn add --dev @vue-email/nuxt

# Using npm
npm install --save-dev @vue-email/nuxt
  1. Add @vue-email/nuxt to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: [
    '@vue-email/nuxt'
  ]
})

That's it! You can now use My Module in your Nuxt app ✨

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release

License

MIT License © 2023-PRESENT Vue Email