Skip to content

AshWilliams/intercooler-js

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Introduction

Intercooler is a small (25K unzipped) library that allows you to add AJAX to your application using HTML attributes.

Here is an example:

// When this button is clicked an AJAX POST request is sent to /example and the response content is
// swapped in to the body of the button
<button ic-post-to="/example">
    Click Me!
</button>

Despite its small size, intercooler supports quite a bit of functionality:

  • Specifying the UI event that causes an AJAX request
  • A rich event model
  • Custom HTTP response headers for meta directives
  • A REST-ful dependency mechanism
  • Simple AJAX history/back-button support
  • And much more...

These features allow you to build a modern web application with minimal fuss, following are REST-ful architecture that ensures good performance and a minimum of complexity.

It also is very easy to incrementally retrofit intercooler into existing applications to add AJAX functionality where it is most valuable.

Full documentation is available on the main intercooler website

Installing

Intercooler can be downloaded or hot-linked from the downloads page.

Or installed via bower:

 "dependencies": {
    "intercooler-js" : "0.9.3"
  }

License

Intercooler is licenced under the MIT License

Contributing

To contribute a change to intercooler:

  • Fork the main intercooler repository
  • Create a new feature branch based on the development branch with a reasonably descriptive name (e.g. fix_http_get_parameter_overriding)
  • Implement your fix
  • Add a test to /test/unit_tests.html. (It's pretty easy!)
  • Create a pull request for that branch against development in the main repository

Thank you to all the contributors!

About

Making AJAX as easy as anchor tags

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 53.8%
  • JavaScript 45.8%
  • Other 0.4%