https://github.com/innoq/iqjax

https://github.com/innoq/iqjax

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/innoq/iqjax
• Owner: innoq
• License: other
• Created: 2012-04-30T12:19:15.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-07-26T12:34:28.000Z (over 12 years ago)
• Last Synced: 2024-10-18T15:49:02.983Z (about 1 month ago)
• Language: JavaScript
• Size: 145 KB
• Stars: 5
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
iQjax

=====

This is an unobtrusive JavaScript component for doing Ajax in conformity 

with the [ROCA-Style](http://roca-style.org). It enables your web application 

to do Ajax without bigger impacts to your server side. 

An iQjax enabled DOM node loads the target of annotated links it contains into a 

specific container DOM node. This is done asynchronously via Ajax. If the 

content contains a form, the form handling (especially error handling) will be 

automatically done in the container too. After a form was successfully submitted, 

iQjax provides methods to update the iQjax container without reloading the whole 

page.

E.g. given a iQjax enabled list of person names with links pointing to a

form to edit the respective person name. Clicking on such a link will

load the form to a given container DOM node. After submitting the form 

with a changed name, the user would expect the list of names to be updated.

iQjax can do this by searching the new list entry in the response of

the form POST. Then it replaces the old node with the new one.

Documentation

-------------

We distinguish six API parts of ROCA-Style JavaScript components:

* The socket HTML markup the component initializes upon,

* the constructor method together with it's parameters,

* methods callable upon the component,

* events triggered by the component,

* HTML markup the component generates and

* Ajax-Requests the component fires.

### Socket markup

iQjax must be initialized on a DOM node with a `data-iqjax` attribute set. 

The attribute must contain a selector for the container the Ajax-response 

should be put in.

... TO BE DONE ...