A jQuery plugin to help with common ajax submission and response handling actions. In short, you initialize the plugin on a form and specify a trigger element which on click will send all form elements to a specified url.
<html>
<head><title></title></head>
<body>
<form id="my-form" href="javascript:;">
First name: <input type="text" name="fname">
Last name: <input type="text" name="lname">
<button id="btnTrigger" type="button">Submit</button>
</form>
</body>
</html>The form element needs to first be initialized with the jQuery plugin.
$("#my-form").gs_ajax_form({
trigger_el: '#btnTrigger',
target_url: 'http://host/submit.php'
});Additional data can be used to add data to the post request that might not have been present in the form as input data. It can be defined as a function if the execution needs to wait until the request is triggered to render otherwise an object can be directly set to it.
$("#my-form").gs_ajax_form({
trigger_el: '#btnTrigger',
target_url: 'http://host/submit.php',
additional_data: {another_key: 'another_value'}
});A function can be executed passed to control whether the ajax requests is allowed to proceed. This function should return true or false.
$("#my-form").gs_ajax_form({
trigger_el: '#btnTrigger',
target_url: 'http://host/submit.php',
before_request_condition: function() {
return true;
// note this can work great with message-handler-js plugin like so
// return $('#message-handler').gs_message_handler('status') == null;
},
});A function to be executed prior to sending the ajax request.
$("#my-form").gs_ajax_form({
trigger_el: '#btnTrigger',
target_url: 'http://host/submit.php',
before_request: function() {
console.log('this is executed before the request');
// note this can work great with message-handler-js plugin like so
// $('#message-handler').gs_message_handler('set', {message: 'Processing...', type: 'warning'});
},
});A function to be executed after an ajax request which was succesful.
$("#my-form").gs_ajax_form({
trigger_el: '#btnTrigger',
target_url: 'http://host/submit.php',
after_request_success: function(inData) {
console.log('this is executed after a request which was successful');
// note this can work great with message-handler-js plugin like so
// $('#message-handler').gs_message_handler('set', {message: inData.message, type: inData.status});
}
});A function to be executed after an ajax request which produced an error.
$("#my-form").gs_ajax_form({
trigger_el: '#btnTrigger',
target_url: 'http://host/submit.php',
after_request_error: function(inData) {
console.log('this is executed after a request which produced an error');
// note this can work great with message-handler-js plugin like so
// $('#message-handler').gs_message_handler('set', {message: inData.statusText, type: 'error'});
},
});Instruct to which url to auto redirect after an ajax request which was succesful.
$("#my-form").gs_ajax_form({
trigger_el: '#btnTrigger',
target_url: 'http://host/submit.php',
redirect_url_on_success: 'http://host/redirect'
});Instruct to which url to auto redirect on an ajax request which produced an error.
$("#my-form").gs_ajax_form({
trigger_el: '#btnTrigger',
target_url: 'http://host/submit.php',
redirect_url_on_error: 'http://host/redirect'
});The MIT License
Copyright (c) 2013-2014 Garagesocial, Inc. http://garagesocial.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.