Skip to content

jQuery plugin used in GestiXi websites to handle form submission

License

Notifications You must be signed in to change notification settings

gestixi/form-submitter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Form Submitter

This plugin make it easy to submit form in GestiXi generated websites.


Installation

form-submitter depends on jQuery. To use it, include this in your page :

<script src="jquery.js" type="text/javascript"></script>
<script src="form-submitter.js" type="text/javascript"></script>

Usage

To use Form Submitter, you just need to do this:

$(function() {
  $(".form-container").formSubmitter({
    // options if needed
  });
});

The receiver can be either a form or a DOM element containing a form.

Your server will have to respond a JSON encoded object with the following optionnals parameters :

  • notification: an HTML Bootstrap alerts.
  • helpInline: a JSON encoded object with the name of the input field as a key and the error as a value.
  • redirectUrl: on URL to redirect the page to.

If this is too opinionated for you, feel free to fork it and adapte it to your use case.


Options

willSend {function}

Delegate called before form submission.

Return false to prevent form submitting.

Example:

$('form').formSubmitter({ 
  willSend: function() {
    return true;
  }
});

formSettings {function}

Delegate called to get the form data.

Example:

$('form').formSubmitter({ 
  formSettings: function(evt) {
    var $form = this.$form;

    return {
      method: $form.attr("method"),
      url: $form.attr("action"), 
      data: $form.serialize()
    };
  }
});

didSend {function}

Delegate called after form submission.

willReceive {function}

Delegate called before the response handling.

didReceive {function}

Delegate called after the response handling.

notificationDelay {number}

Duration of the notifications in milliseconds.

Default: 8000

notificationLayout {string}

Layout of the notifications.

Default: 'position:fixed;top:10px;left:10px;width:350px;z-index:1000;'


Properties

element

The DOM element.

Example:

$('form').formSubmitter({ 
  didSend: function(evt) {
    console.log(this.element);
  }
});

$form

The jQuery form element.

Example:

$('form').formSubmitter({ 
  didSend: function(evt) {
    console.log(this.$form);
  }
});

options

The options object.


Author

Nicolas Badia


Copyright and license

Copyright 2013-2016 GestiXi under The MIT License (MIT).

About

jQuery plugin used in GestiXi websites to handle form submission

Resources

License

Stars

Watchers

Forks

Packages

No packages published