The Spinner widget is a wrapper for the spin.js plugin. It enables you to add an animated CSS3 loading spinner which allows VML fallback for IE. Since, it is not image based (relies on pure CSS), it allows you to configure the spinner style, size, color, and other CSS attributes. The major advantage of using the CSS3 based spinner, is that the animation can be made visible to user for non-ajax based scenarios on most modern browsers. For example, on events like window.load or window.unload (thereby enabling you to show a page loading progress without using ajax).
\kartik\widgets namespace, this widget can be also installed from the yii2-widget-spinner repository
and can also be accessed via \kartik\spinner\Spinner namespace.
Not seeing the updated content on this page! Hard refresh your browser to clean cache for this page (e.g. SHIFT-F5 on Windows Chrome)
Spinner supports configuration of the bootstrap library version so that you can use this either with any Bootstrap version 3.x and above. For setting up the bootstrap version for your extension, you can configure the Spinner::bsVersion property to one of the following.
To use with bootstrap 3 library - you can set Spinner::bsVersion property to any string starting with 3 (e.g. 3 or 3.3.7 or 3.x)
To use with bootstrap 4 library - you can set Spinner::bsVersion property to any string starting with 4 (e.g. 4 or 4.6.0 or 4.x)
To use with bootstrap 5 library - you can set Spinner::bsVersion property to any string starting with 5 (e.g. 5 or 5.1.0 or 5.x)
Generally, you may also want to set a default version globally for all Krajee Extensions (instead of setting it for each widget or extension separately). In order to do this, you can setup the bsVersion property within Yii 2 application params (i.e. Yii::$app->params['bsVersion']). To set this up, add this section of code to your application params configuration file (e.g. config/params.php):
'params' => [
'bsVersion' => '5.x', // this will set globally `bsVersion` to Bootstrap 5.x for all Krajee Extensions
// other settings
// 'adminEmail' => 'admin@example.com'
]
If Spinner::bsVersion property is set, in addition to Yii::$app->params['bsVersion'], the extension level setting (Spinner::bsVersion property) will override the Yii::$app->params['bsVersion']. If Spinner::bsVersion property is not set, and Yii::$app->params['bsVersion'] is also not set, Spinner::bsVersion property will default to 3.x (i.e. Bootstrap 3.x version will be assumed as default).
You need to install one of yiisoft/yii2-bootstrap or yiisoft/yii2-bootstrap4 or yiisoft/yii2-bootstrap5 extensions manually in your application to enable Bootstrap 3.x or 4.x or 5.x functionality respectively. This dependency has not been pre-built into the composer configuration for Krajee extensions, to allow better control to the developers in configuring their bootstrap library version. If bsVersion is set to 5.x and yiisoft/yii2-bootstrap5 is not installed, then an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap5 extension. If bsVersion is set to 4.x and yiisoft/yii2-bootstrap4 is not installed, then an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap4 extension. Similarly, if bsVersion is set to 3.x and yiisoft/yii2-bootstrap is not installed, an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap extension.
To install yiisoft/yii2-bootstrap5, add the repo to the require section of your application's composer.json.
"yiisoft/yii2-bootstrap5": "@dev"
To install yiisoft/yii2-bootstrap4, add the repo to the require section of your application's composer.json.
"yiisoft/yii2-bootstrap4": "@dev"
To install yiisoft/yii2-bootstrap, add the repo to the require section of your application's composer.json.
"yiisoft/yii2-bootstrap": "@dev"
The Krajee extension asset bundle(s) by default depend on one of the following asset bundles to load the Bootstrap CSS and JS:
yii\bootstrap\BootstrapAsset and/or yii\bootstrap\BootstrapPluginAsset for bootstrap 3.x (bsVersion = 3 setting)
yii\bootstrap4\BootstrapAsset and/or yii\bootstrap4\BootstrapPluginAsset for bootstrap 4.x ( bsVersion = 4 setting)
yii\bootstrap5\BootstrapAsset and/or yii\bootstrap5\BootstrapPluginAsset for bootstrap 5.x (bsVersion = 5 setting)
This is controlled by the property bsDependencyEnabled within the asset bundle (which defaults to true). One can override this and prevent the default yii2 bootstrap assets (CSS & JS) from loading by doing one or all of the following:
Global Override: Set Yii::$app->params['bsDependencyEnabled'] to false in your Yii 2 application config params.php. This setting will be applied for all Krajee Extension Asset Bundles that depend on Bootstrap assets.
'params' => [
'bsDependencyEnabled' => false, // this will not load Bootstrap CSS and JS for all Krajee extensions
// you need to ensure you load the Bootstrap CSS/JS manually in your view layout before Krajee CSS/JS assets
//
// other params settings below
// 'bsVersion' => '5.x',
// 'adminEmail' => 'admin@example.com'
]
Asset Bundle Specific Override: Set bsDependencyEnabled to false for the specific asset bundle within Yii2 Asset Manager component in your Yii 2 application config file.
// ...
'components' => [
'assetManager' => [
'bundles' => [
'kartik\form\ActiveFormAsset' => [
'bsDependencyEnabled' => false // do not load bootstrap assets for a specific asset bundle
],
],
],
],
When setting bsDependencyEnabled to false, you need to ensure that your app code/view layout loads the Bootstrap CSS and JS on your view before the Krajee CSS/JS are loaded to ensure that the Krajee extension JS plugins and CSS styles do not get broken.
Bootstrap 5.x / 4.x does not include glyphicons or any other icons framework bundled with the library. Krajee extensions therefore will use Font Awesome 5.x icons instead of glyphicons when working with Bootstrap 5.x / 4.x. You can download Font Awesome 5.x icons from the icons website. Alternatively, you can load the free version of Font Awesome from their CDN.
For Krajee extensions and demos, the Font Awesome Free version is used and loaded as the Icons Display Package on all the Yii2 demo layouts. To include font awesome assets on your page, include the following markup on the HEAD section of your view layout file, when bsVersion is set to 4.x or 5.x.
Option 1: Font CSS version of Font Awesome:
<!-- on your view layout file HEAD section --> <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css">
Option 2: SVG / JS version of Font Awesome (recommended for cleaner scaling vector icons and features like icon layers):
<!-- on your view layout file HEAD section --> <script defer src="https://use.fontawesome.com/releases/v5.3.1/js/all.js" crossorigin="anonymous"></script>
Alternatively, you can use the FontAwesomeAsset from the kartik-v/yii2-icons package to load the SVG/JS version.
// on your view layout file use kartik\icons\FontAwesomeAsset; FontAwesomeAsset::register($this);
The yii2-widget-spinner extension can be installed automatically or manually using one of these options:
Installation via Composer is the recommended and most easy option to install Krajee Yii2 extensions. You can install yii2-widget-spinner via composer package manager. Either run:
$ php composer.phar require kartik-v/yii2-widget-spinner "dev-master"
or add:
"kartik-v/yii2-widget-spinner": "dev-master"
to your application's composer.json file.
You may also manually install the extension to your project (in case your composer install does not work). Just download the source ZIP or TAR ball and extract the extension asset files and folders into your project. You may need to install dependencies manually and also set the namespaces to the extensions in your Yii2 extensions configurations manually.
bsVersion:
string | int, the bootstrap library version to be used for the extension. Refer the Bootstrap Info section for details and pre-requisites on setting this property.
To use with Bootstrap library - you can set this to any string starting with
3 (e.g. 3 or 3.3.7 or 4.x / 3.x)
To use with bootstrap 4 - you can set this to any string starting with
4 (e.g. 4 or 4.6.0 or 4.x)
To use with bootstrap 5 - you can set this to any string starting with
4 (e.g. 5 or 5.1.0 or 5.x)
bsColCssPrefixes:
array, the bootstrap grid column css prefixes mapping, the key is the bootstrap versions, and the value is an array containing the sizes and their corresponding grid column css prefixes. The class using this trait, must implement kartik\base\BootstrapInterface. If not set will default to:.
[
3 => [
self::SIZE_X_SMALL => 'col-xs-',
self::SIZE_SMALL => 'col-sm-',
self::SIZE_MEDIUM => 'col-md-',
self::SIZE_LARGE => 'col-lg-',
self::SIZE_X_LARGE => 'col-lg-',
self::SIZE_XX_LARGE => 'col-lg-',
],
4 => [
self::SIZE_X_SMALL => 'col-',
self::SIZE_SMALL => 'col-sm-',
self::SIZE_MEDIUM => 'col-md-',
self::SIZE_LARGE => 'col-lg-',
self::SIZE_X_LARGE => 'col-xl-',
self::SIZE_XX_LARGE => 'col-xl-',
],
5 => [
self::SIZE_X_SMALL => 'col-',
self::SIZE_SMALL => 'col-sm-',
self::SIZE_MEDIUM => 'col-md-',
self::SIZE_LARGE => 'col-lg-',
self::SIZE_X_LARGE => 'col-xl-',
self::SIZE_XX_LARGE => 'col-xxl-',
],
];
preset: string|boolean the spinner preset to apply. This can be set to one of the following:
Spinner::TINY or 'tiny'
Spinner::SMALL or 'small'
Spinner::MEDIUM or 'medium'
Spinner::LARGE or 'large'
if this is set to one of 'tiny', 'small', or 'large', it will override any other settings in pluginOptions
if this is set to a string other than the defined presets
pluginOptions is also set, then it will create a preset with this name for the client session and apply the settingspluginOptions is not set, an InvalidConfigException will be raisedif this is set to false, the spinner will be stopped and removed.
if this is not set or is null, the settings in pluginOptions will be used.
color: string the color (hex/name) to apply to the spinner. If not specified, it will inherit the spinner container color.
hidden: boolean boolean is the spinner hidden by default. Defaults to false.
align: string alignment of the spinner with respect to the parent, defaults to 'center'. If set to 'left' or 'right', this will wrap it in a container with the respective floats. By default, the spinner will be aligned 'center' and 'top' of the parent element.
caption: string caption embedded inside the spinner. This is not HTML encoded. If you set it to an empty string, this will not be displayed..
captionOptions: array the HTML attributes for the caption container. The following additional attributes can be set:
tag: string the tag for rendering the container. Defaults to span.
spinOptions: array the HTML attributes for the spinner container. The following additional attributes can be set:
tag: string the tag for rendering the container. Defaults to span.
options: array the HTML attributes for the combined spinner + caption container. The following additional attributes can be set:
tag: string the tag for rendering the container. Defaults to span.
pluginOptions: array the plugin settings/options for the plugin. There are a quite a few options you can set in this plugin. Refer the plugin documentation for details.
Large spinner aligned left with inherited color from parent container (inside a div element)
Medium spinner aligned center with blue color (inside a div element)
Small spinner aligned right with hex color (inside a div element)
Tiny spinner aligned left with caption text (inside a button)
use kartik\spinner\Spinner
// Large spinner aligned left with inherited color from parent container (inside a div element)
echo '<div class="border border-secondary p-3 rounded">';
echo Spinner::widget(['preset' => 'large', 'align' => 'left']);
echo '<div class="clearfix"></div>';
echo '</div>';
// Medium spinner aligned center with blue color (inside a div element)
echo '<div class="border border-secondary p-3 rounded">';
echo Spinner::widget(['preset' => 'medium', 'align' => 'center', 'color' => 'blue']);
echo '<div class="clearfix"></div>';
echo '</div>';
// Small spinner aligned right with hex color (inside a div element)
echo '<div class="border border-secondary p-3 rounded">';
echo Spinner::widget(['preset' => 'small', 'align' => 'right', 'color' => '#5CB85C']);
echo '<div class="clearfix"></div>';
echo '</div>';
// Small spinner aligned left with caption text (inside a button element)
echo '<button class="btn btn-primary btn-sm">';
echo Spinner::widget(['preset' => 'tiny', 'align' => 'left', 'caption' => 'Loading …']);
echo '</button>';
Comments & Discussion
Note
You can now visit the Krajee Webtips Q & A forum for searching OR asking questions OR helping programmers with answers on these extensions and plugins. For asking a question click here. Select the appropriate question category (i.e. Krajee Plugins) and choose this current page plugin in the question related to field.
The comments and discussion section below are intended for generic discussions or feedback for this plugin. Developers may not be able to search or lookup here specific questions or tips on usage for this plugin.