Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fabioquarantini/formchimp
🐵 A customizable MailChimp ajax plugin for jQuery
https://github.com/fabioquarantini/formchimp
ajax form javascript jquery mailchimp
Last synced: about 1 month ago
JSON representation
🐵 A customizable MailChimp ajax plugin for jQuery
- Host: GitHub
- URL: https://github.com/fabioquarantini/formchimp
- Owner: fabioquarantini
- Created: 2013-09-12T14:59:44.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2019-02-11T10:04:47.000Z (almost 6 years ago)
- Last Synced: 2024-05-22T21:35:04.845Z (7 months ago)
- Topics: ajax, form, javascript, jquery, mailchimp
- Language: JavaScript
- Homepage:
- Size: 59.6 KB
- Stars: 97
- Watchers: 6
- Forks: 25
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# jQuery FormChimp
A customizable MailChimp ajax plugin for jQuery, provides an easy and lightweight way to let your users sign up to your MailChimp list.
#### Features
- Customizable Error and Success messages.
- Ability to specify which element the output should be appended to, if it exists or where the element should be created
- Automatically transforms the mailchimp signup url in the JSONP format
- Changes the value of the button if the response is successful
- This solution is language agnostic, only dependency is jQuery.
- is AJAX-enabled, but degrades gracefully if Javascript isn't turned on
- Multiple sign-up forms, for multiple lists.
## Install
Choose one of the following methods:
**Download source files**
- [jquery.formchimp.min.js](https://raw.github.com/fabioquarantini/formchimp/master/jquery.formchimp.min.js)
- [jquery.formchimp.js](https://raw.github.com/fabioquarantini/formchimp/master/jquery.formchimp.js)
**Git clone**
``` bash
git clone https://github.com/fabioquarantini/formchimp.git
```
**Bower**
``` bash
bower install formchimp
```
## Usage
1. Create a form with the required attributes ( form action and input with name attribute. [Where do i find them?](http://kb.mailchimp.com/article/can-i-host-my-own-sign-up-forms) )
```html
Email*:
Subscribe
```
2. Include jQuery:
```html
```
3. Include plugin's code:
```html
```
4. Call the plugin:
```javascript
$(".form-selector").formchimp();
```
## Settings
FormChimp accepts settings from an object of key/value pairs.
##### Example:
```javascript
$(".form-selector").formchimp({
key: value,
key: value
});
```
## List of settings
#### appendElement:
*Selector*: Declare where the new element, containing the messages from Mailchimp will be appended to.
*Default*: `$(this)`
#### buttonSelector:
*String*: Set the button selector.
*Default*: `$form.find('[type="submit"]')`
#### buttonText:
*String*: The message to be written on the submit button after a successful subscription.
*Default*: `''`
#### debug:
*Boolean*: Activate debug message in console.
*Default*: `false`
#### errorMessage:
*String*: Set custom error message given when return an error.
*Default*: `''`
#### onMailChimpSuccess:
*Function*: Callback that fires on MailChimp success.
*Default*: `function() {}`
#### onMailChimpError:
*Function*: Callback that fires on MailChimp error.
*Default*: `function() {}`
#### responseClass:
*Selector*: Declare custom element in page for message output. (Set different classes for multiple sign-up forms)
*Default*: `mc-response`
#### successMessage:
*String*: Set a custom success message.
*Default*: `''`
#### url:
*String*: The mailchip list subscription url, to get the JSONP address just change `post` to `post-json` and append `&c=?` at the end.
*Default*: `form action attribute`
## Event Hooks
These event hooks fire at the same time as their corresponding callbacks (ie. onMailChimpSuccess & onMailChimpSuccess)
`mailChimpSuccess` : This event is triggered on Mailchip success
`mailChimpError` : This event is triggered on Mailchip errors
##### Example:
```javascript
$( document ).on( 'mailChimpSuccess', function() {
// Your code here
});
```
## License
[MIT License](http://opensource.org/licenses/MIT) © [Fabio Quarantini](http://www.fabioquarantini.com)