Wallogit.com
2017 © Pedro Peláez
yii2-extension jquery-webserver-bg
jquery plugin for operate with long-time webserver background processes
iluhansk/jquery-webserver-bg
jquery plugin for operate with long-time webserver background processes
- Sunday, October 8, 2017
- by iluhansk
- Repository
- 1 Watchers
- 0 Stars
- 0 Installations
- JavaScript
- 0 Dependents
- 0 Suggesters
- 0 Forks
- 0 Open issues
- 1 Versions
- 0 % Grown
The README.md
jquery-webserver-bg
jquery plugin for operate with long-time webserver background processes, (*1)
Installation
The preferred way to install this extension is through composer., (*2)
Either run, (*3)
php composer.phar require --prefer-dist iluhansk/jquery-webserver-bg "*"
or add, (*4)
"iluhansk/jquery-webserver-bg": "*"
to the require section of your composer.json file., (*5)
Usage
First of all, add jquery.js and jquery.webserver-bg.js to source files of html page:, (*6)
<script src="path/to/jquery.js"></script> <script src="path/to/jquery.webserver-bg.js"></script>
Init plugin via javascript:, (*7)
$('.myForm').webserverBackground(options);, (*8)
Options
| option | description |
|---|---|
| start | options of starting background process |
| start.ajax | ajax options (see jQuery.ajax() options) |
| start.getData | A function generating data option of ajax settings |
| check | options of checking process status |
| check.ajax | ajax options (see jQuery.ajax() options) |
| check.delay | Count seconds between check requests |
| error | options of error processing |
| error.container | Error container jquery selector |
| error.template | Error container template |
| error.print | A function that print error |
| error.clear | A function that clear error |
| success | A function to be called if the process succeeds |
| complete | A function to be called when the process finishes (after success and error callbacks are executed) |
| progress | options of displaying process progress |
| progress.container | progress container jquery selector |
| progress.template | progress container template |
| progress.print | A function that print progress |
| json | settings of http json response |
| json.fields | json fields |
| json.statuses | statuses of process |
Methods
call methods like this:, (*9)
$('.myForm').webserverBackground(method, options);
| method | description |
|---|---|
| init | initialize plugin (default method) |
| destroy | destroy plugin |
| start | start background process and checking workflow |
| block | disable form elements |
| unblock | enable form elements |