The Humble Contact Form, Reconsidered
JavaScript CSS PHP HTML
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
source
.gitignore
Gruntfile.js
LICENSE.txt
README.md
package.json

README.md

Clever Contact

The Humble Contact Form, Reconsidered

Overview

Clever Contact includes everything one needs to add a simple, clean, and modern contact form to a PHP-powered Web site:

  • an HTML5 form, including a demo page that can be customized and deployed in full if desired
  • CSS 3 style sheets
  • JavaScript to handle form-submission and response-handling
  • PHP to handle form-processing

Clever Contact was made with current and developing standards, browsers, and techniques in mind, including the following:

  • HTML5, including browser-provided input validation
  • CSS 3
  • XMLHttpRequest level 2
  • FormData
  • single-page applications (SPAs) and form submission via API
  • modern, evergreen browsers - no legacy cruft
  • easy customization and deployment
  • clean and valid code, preferably free of unnecessary and possibly conflicting IDs

Setup

You may find Clever Contact usable pretty much as presented in the demo directory, in which case you should be able to just customize things to your liking and drop the files where you like on a Web server running a recent version of PHP.

  • config.php: Be sure to check that the constant values are to your liking.
  • contact.html: Ensure that the "form" element's "onsubmit" attribute includes the proper path to clever-contact-api.php.

If you have Node.js, npm, and grunt-cli installed (and you should because they are great), you can also minify the JavaScript, CSS, and HTML and open and serve the demo page from your command line. To install the necessary packages to enable this functionality, just type the following from within your copy of the Clever Contact repository:

npm install

After that, you should be able to build Clever Contact and open and serve the front-end demo page (which you can adapt for your own needs) just by running Grunt:

grunt

You can also run specific Grunt tasks if you are so inclined. For example, you can delete the build directory like so:

grunt clean

If Clever Contact has already been built, you can skip right to opening and serving the front-end demo page like so:

grunt demo

Please explore Gruntfile.js for more details.

Demo via Browsersync

If you have Browsersync installed, you can have it serve the built demo page and watch for and respond to changes by running the provided npm script like so:

npm run-script demo

Obviously, the build directory will need to exist before that will work.

At some point I plan to replace grunt-serve, which has not as of this writing been updated for recent versions of Grunt, with Browsersync, but for now you can use either.

Room for Improvement

Yes, there is plenty. :)

  • User input is currently passed to PHP's mail function with minimal processing. The form-processor should probably have a full security audit, including both input validation and data-handling.
  • As Clever Contact is specifically intended to be a modern system, no effort has been made to provide fallback functionality or graceful degradation for old browsers. Supporting obsolete browsers whose ubiquity slows the modernization of the Web is not a particularly compelling use case for me as I do not think of it as an actual improvement, but if you disagree, you can fork Clever Contact and corrupt it to your evil purposes between eating babies or not using turn signals or whatever it is you do to express the darkness in your heart.
  • I made several themes and a theme switcher, but I removed them to focus on completing and delivering a minimum viable product. I will likely restore and further develop them later.

There is much more room for improvement, but I am presently more inclined to sleep than to write documentation, so I recommend either embracing the mystery, looking through the code, or just trying things out to see what you think.

Known Issues

  • Things look great on some mobile devices, but not very good on others. I may refine the demo appearance and responsiveness soon, although appearance is really secondary to functionality since library users can implement their own user interfaces and styles.
  • As alluded to above, I am not asleep. This issue will be addressed as soon as I post this documentation.

Security Notes

You might want to put that form-processor PHP script at a different origin (domain and/or port) from your main site, especially if you are using a crossdomain.xml file.

I am not a security expert, but I do recommend looking into both crossdomain.xml security and CORS to get some idea of the kinds of vulnerabilities and challenges that can arise when using APIs.

Why "Clever Contact"?

Because "Susan" would be a silly name for a contact-form library.

Who made this?

Clever Contact was made by Brian Sexton, the leading mobile device and notebook computer rapid descent initiator at Carroket, Inc.