Description ¶
SimpleLoading is a simple way to show a loading screen in your views
Requirements ¶
- Yii Version 2.0.0 or later
Installation ¶
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist edwinhaq/yii2-simple-loading "*"
or add
"edwinhaq/yii2-simple-loading": "*"
to the require section of your composer.json
file.
Usage ¶
Once the extension is installed, simply use it in your PHP code:
// ...
use edwinhaq\simpleloading;
// ...
SimpleLoading::widget();
// ...
In javascript call start and stop to control the loading widget
[javascript]
/*
* start(image type)
* Allows to start the loading image and select the image to show
* options: box,clock,default,gears,hourglass,magnify,reload,ring-alt,ring,ripple,rolling
*/
SimpleLoading.start('gears'); // Load gears.gif
SimpleLoading.start('default'); // Load default.gif
SimpleLoading.start(); // Load default.gif
/*
*
* Allows to stop the loading image
*/
SimpleLoading.stop();
// Example:
$.ajax(
{
'type':'POST',
'dataType':'json',
'url':'index.php?r=controller/action',
'beforeSend':function(json)
{
SimpleLoading.start('gears');
},
'success':function(json){/* ... */},
'error':function(json,status,errorThrown ){/* ... */},
'complete':function(json)
{
SimpleLoading.stop();
},
'cache':false,
'data':jQuery(this).parents("form").serialize()
}
);
Attention:
This is not correct.
use edwinhaq\simpleloading;
-> use this:
use edwinhaq\simpleloading\SimpleLoading;
Like mentioned on the GitHub page.
Thank you so much for this extension!
Just one question: is there any way to change the color of the spinner images?
If you have any questions, please ask in the forum instead.
Signup or Login in order to comment.