Skip to content
This repository has been archived by the owner on Nov 9, 2017. It is now read-only.
/ mailbox Public archive

Contact forms re-imagined

License

Notifications You must be signed in to change notification settings

leo/mailbox

Repository files navigation

mailbox

usage (demo)

To use beautiful contact forms in your project, you don't need to do anything else than to just include all files and initialize the main-script. You can download the minified versions from the lower links.

Download: JS (2.9 KB), CSS (1.8 KB), PHP (0.8 KB).

After downloading and including the scripts in your site, you need to load them - of course (preferably right before the 'body'-tag is closed):

<link rel="stylesheet" type="text/css" href="mailbox.css" />
<script src="http://code.jquery.com/jquery-1.10.1.min.js"></script>
<script src="jquery.mailbox.js"></script>

Important: Please make sure that you've either placed the PHP-script in the same directory as the JS-script or set the right path to the file in the configuration.

After loading all scripts on your site, just initialize mailbox and you're finished! :)

$( document ).mailbox();

Please note: 'document' stands for an object that contains mailto-links (you can simply replace it with a nother object, e.g. '.container').

configuration

Mailbox is designed to adapt to many kinds of possible requirements. To change the default settings, you simply need to pass the corresponding parameters through JS:

$( document ).mailbox({

  send: 'Send message',
  success: 'Message sent successfully!',

  labels: {
    name: 'Your name',
    email: 'Your email',
    subject: 'Subject',
    body: 'Your message'
  },

  on: 'mailbox-on',			// A class that's added to links that are used to open mailbox
  script: 'mailbox.php',		// Path to the PHP-script

  viewport: 992,				// The window width in px, from which the project should be visible
  complete: function() {}		// A function to be executed after a mail has been sent

});

I need to thank the guys from shipp.co for creating such a beautiful project (balloon.io). It helped me to shape the looking of mailbox to something great.

About

Contact forms re-imagined

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published