nuxt-newsletter

Newsletter module for Nuxt 3

• ✨  Release Notes
• 📖  Read the documentation

Features

• Nuxt 3 ready
• Easy integration with Mailchimp, Revue, Buttondown
• Unstyled NewletterForm.vue component
• Handy useNewsletterSubscribe composable
• TypeScript support

📖  Read the documentation

Setup

yarn add nuxt-newsletter # yarn
npm i nuxt-newsletter # npm

Basic usage

Firstly, you need to add nuxt-newsletter to your Nuxt config.

// nuxt.config.js

{
    modules: [
        "nuxt-newsletter",
    ],
    newsletter: {
      // mailchimp | revue | buttondown
      <YOUR_NEWSLETTER_PROVIDER>: {
        // options like apiKey
      }
    }
}

Then you can start using nuxt-newsletter in your app!

<template>
  <div>
    <newsletter-form />
  </div>
</template>

Development

1. Clone this repository
2. Install dependencies using yarn install or npm install
3. Prepare playground environment using yarn dev:prepare or npm run dev:prepare
4. Start development server using yarn dev or npm run dev

License

MIT License