1.0.2 • Published 5 years ago

webiny-app-mailchimp v1.0.2

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

webiny-app-mailchimp

npm.io npm.io code style: prettier PRs Welcome

Enables inserting Mailchimp newsletter signup forms on your site.

Install

npm install --save webiny-app-mailchimp

Or if you prefer yarn:

yarn add webiny-app-mailchimp

Note: the webiny-api-mailchimp is also required.

Setup

To setup, you must register a set of plugins. For more information on plugins, please visit Webiny documentation.

Admin

import mailchimpPlugins from "webiny-app-mailchimp/admin"
import { registerPlugins } from "webiny-plugins";

registerPlugins(...mailchimpPlugins);

Enables management of Mailchimp settings, which can be accessed via Settings section in the main menu. You will paste your Mailchimp API key here (this is required in order for the app to work properly). Additionally, this will also register Mailchimp element in CMS editor, which will enable you to insert newsletter signup forms in your pages. The element will be registered under the "Form" element category.

You can optionally register one or more newsletter signup form plugins (type: cms-element-mailchimp-component).

{
        type: "cms-element-mailchimp-component",
        name: "cms-element-mailchimp-component-test1",
        title: "Test newsletter form",
        component: MailchimpTestForm
}

An example component can be found here.

Site

import mailchimpPlugins from "webiny-app-mailchimp/render"
import { registerPlugins } from "webiny-plugins";

registerPlugins(mailchimpPlugins);

This enables rendering of Mailchimp newsletter signup form in your public website.