@webiny/app-mailchimp
v5.2.1
Published
Enables inserting Mailchimp newsletter signup forms on your website.
Downloads
230
Readme
@webiny/app-mailchimp
Enables inserting Mailchimp newsletter signup forms on your site.
Use together with @webiny/api-mailchimp package.
Install
npm install --save @webiny/app-mailchimp
Or if you prefer yarn:
yarn add @webiny/app-mailchimp
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 { plugins } from "@webiny/plugins";
plugins.register(...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 the 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: pb-page-element-mailchimp-component
). For example:
{
type: "pb-page-element-mailchimp-component",
name: "pb-page-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 { plugins } from "@webiny/plugins";
plugins.register(mailchimpPlugins);
This enables rendering of Mailchimp newsletter signup form in your public website.