Class kartik\spinner\Spinner

All Classes | Properties | Methods | Events | Constants

Inheritance	kartik\spinner\Spinner » kartik\base\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implements	kartik\base\BootstrapInterface, yii\base\Configurable, yii\base\ViewContextInterface
Uses Traits	kartik\base\BootstrapTrait, kartik\base\TranslationTrait, kartik\base\WidgetTrait
Subclasses	kartik\widgets\Spinner

Spinner widget enables you to render configurable animated loading spinners styled using CSS. It is a wrapper for the spin.js library that enables an animated CSS3 spinner with VML fallback for IE.

For example,

use kartik\spinner\Spinner;

echo Spinner::widget([
    'preset' => Spinner::LARGE,
    'color' => 'blue',
    'align' => 'left'
]);

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$align	string	Alignment of the spinner with respect to the parent, defaults to center.	kartik\spinner\Spinner
$autoIdPrefix	string	The prefix to the automatically generated widget IDs.	yii\base\Widget
$baseSourcePath	string\|false	Get parsed base source path based on $sourcePath setting. If $sourcePath is not set, it will return the current working directory of this widget class.	kartik\base\WidgetTrait
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component.	yii\base\Component
$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.	kartik\base\BootstrapTrait
$bsCssMap	array	CSS conversion mappings across bootstrap library versions.	kartik\base\BootstrapTrait
$bsExtBasename	integer	The yii2 bootstrap extension base name (readonly property available via getter method getBsExtBasename())	kartik\base\BootstrapTrait
$bsVer	integer	Bootstrap version number currently set (readonly property available via getter method getBsVer())	kartik\base\BootstrapTrait
$bsVersion	integer\|string	The bootstrap library version that you wish to use for this specific extension / widget.	kartik\base\BootstrapTrait
$caption	string	Caption embedded inside the spinner.	kartik\spinner\Spinner
$captionOptions	array	HTML options for the caption container.	kartik\spinner\Spinner
$color	string	The color (hex/name) to apply to the spinner.	kartik\spinner\Spinner
$counter	integer	A counter used to generate $id for widgets.	yii\base\Widget
$defaultBtnCss	string	Default bootstrap button CSS (readonly property available via getter method getDefaultBtnCss())	kartik\base\BootstrapTrait
$defaultIconPrefix	string	Default icon prefix (readonly property available via getter method getDefaultIconPrefix())	kartik\base\BootstrapTrait
$defaultOptions	array	Default HTML attributes or other settings for widgets.	kartik\base\WidgetTrait
$defaultPluginOptions	array	Default plugin options for the widget	kartik\base\WidgetTrait
$dropdownClass	string	Bootstrap dropdown class name based on currently configured bootstrap version (readonly property available via getter method getDropdownClass())	kartik\base\BootstrapTrait
$hashVarLoadPosition	integer	The position where the client JS hash variables for the input widget will be loaded.	kartik\base\WidgetTrait
$hidden	boolean	Is the spinner hidden by default.	kartik\spinner\Spinner
$i18n	array	The the internalization configuration for this widget.	kartik\base\TranslationTrait
$id	string\|null	ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details.	yii\base\Widget
$moduleId	string	The module identifier if this widget is part of a module.	kartik\base\WidgetTrait
$options	array	The HTML attributes for the combined container enclosing the spinner and caption.	kartik\spinner\Spinner
$pjaxContainerId	string	The identifier for the PJAX widget container if the widget is to be rendered inside a PJAX container.	kartik\base\WidgetTrait
$pjaxDuplicationFix	boolean	Prevent duplication of pjax containers when browser back & forward buttons are pressed.	kartik\base\WidgetTrait
$pluginDestroyJs	string	The javascript that will be used to destroy the jQuery plugin	kartik\base\WidgetTrait
$pluginEvents	array	Widget JQuery events.	kartik\base\WidgetTrait
$pluginName	string	The plugin name	kartik\base\WidgetTrait
$pluginOptions	array	Widget plugin options.	kartik\base\WidgetTrait
$preset	string	The spinner preset to apply.	kartik\spinner\Spinner
$sourcePath	string	Directory path to the original widget source.	kartik\base\WidgetTrait
$spinOptions	array	The HTML attributes for the spinner container.	kartik\spinner\Spinner
$stack	yii\base\Widget[]	The widgets that are currently being rendered (not ended).	yii\base\Widget
$view	yii\web\View	The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details.	yii\base\Widget
$viewPath	string	The directory containing the view files for this widget.	yii\base\Widget

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
$_bsVer	integer	Current bootstrap version number	kartik\base\BootstrapTrait
$_dataVar	string	The HTML5 data variable name that will be used to store the Json encoded pluginOptions within the element on which the jQuery plugin will be initialized.	kartik\base\WidgetTrait
$_defaultBtnCss	string	Default bootstrap button CSS	kartik\base\BootstrapTrait
$_defaultIconPrefix	string	Default icon CSS prefix	kartik\base\BootstrapTrait
$_encOptions	string	The JSON encoded plugin options.	kartik\base\WidgetTrait
$_hashVar	string	The generated hashed variable name that will store the JSON encoded pluginOptions in yii\web\View::POS_HEAD.	kartik\base\WidgetTrait
$_isBs4	boolean	Flag to detect whether bootstrap 4.	kartik\base\BootstrapTrait
$_msgCat	string	Translation message file category name for i18n.	kartik\base\TranslationTrait

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
addCssClass()	Adds bootstrap CSS class to options by parsing the bootstrap version for the specified Bootstrap CSS type.	kartik\base\BootstrapTrait
afterRun()	This method is invoked right after a widget is executed.	yii\base\Widget
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
beforeRun()	This method is invoked right before the widget is executed.	yii\base\Widget
begin()	Begins a widget.	yii\base\Widget
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
end()	Ends a widget.	yii\base\Widget
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
getBSClass()	Gets the respective Bootstrap class based on currently configured bootstrap version.	kartik\base\BootstrapTrait
getBaseSourcePath()	Get parsed base source path based on $sourcePath setting. If $sourcePath is not set, it will return the current working directory of this widget class.	kartik\base\WidgetTrait
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getBsVer()	Gets the current set bootstrap version number.	kartik\base\BootstrapTrait
getCssClass()	Gets bootstrap css class by parsing the bootstrap version for the specified BS CSS type.	kartik\base\BootstrapTrait
getDefaultBtnCss()	Gets the default button CSS	kartik\base\BootstrapTrait
getDefaultIconPrefix()	Gets the default icon css prefix	kartik\base\BootstrapTrait
getDropdownClass()	Gets the respective bootstrap dropdown class name based on currently configured bootstrap version.	kartik\base\BootstrapTrait
getId()	Returns the ID of the widget.	yii\base\Widget
getView()		kartik\base\WidgetTrait
getViewPath()	Returns the directory containing the view files for this widget.	yii\base\Widget
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes the object.	kartik\base\Widget
initI18N()	Yii i18n messages configuration for generating translations	kartik\base\TranslationTrait
isBs()	Validate Bootstrap version	kartik\base\BootstrapTrait
isBs4()	Validate if Bootstrap 4.x version.	kartik\base\BootstrapTrait
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
registerAssets()	Registers the client assets for the kartik\spinner\Spinner widget.	kartik\spinner\Spinner
registerWidgetJs()	Registers a JS code block for the widget.	kartik\base\WidgetTrait
removeCssClass()	Removes bootstrap CSS class from options by parsing the bootstrap version for the specified Bootstrap CSS type.	kartik\base\BootstrapTrait
render()	Renders a view.	yii\base\Widget
renderFile()	Renders a view file.	yii\base\Widget
run()	Executes the widget.	kartik\spinner\Spinner
setId()	Sets the ID of the widget.	yii\base\Widget
setView()	Sets the view object to be used by this widget.	yii\base\Widget
trigger()	Triggers an event.	yii\base\Component
widget()	Creates a widget instance and runs it.	yii\base\Widget

Protected Methods

Hide inherited methods

Method	Description	Defined By
addAsset()	Adds an asset to the view.	kartik\base\WidgetTrait
configureBsVersion()	Configures the bootstrap version settings	kartik\base\BootstrapTrait
fixPjaxDuplication()	Fix for weird PJAX container duplication behavior on pressing browser back and forward buttons.	kartik\base\WidgetTrait
getBsExtBasename()	The yii2-bootstrap extension base name.	kartik\base\BootstrapTrait
getPluginScript()	Returns the plugin registration script.	kartik\base\WidgetTrait
hashPluginOptions()	Generates a hashed variable to store the pluginOptions.	kartik\base\WidgetTrait
initBsVersion()	Initializes bootstrap versions for the widgets and asset bundles.	kartik\base\BootstrapTrait
initDestroyJs()	Generates the `pluginDestroyJs` script if it is not set.	kartik\base\WidgetTrait
isSameVersion()	Compares two versions and checks if they are of the same major BS version.	kartik\base\BootstrapTrait
mergeDefaultOptions()	Merge default options	kartik\base\WidgetTrait
parseVer()	Parses and returns the major BS version	kartik\base\BootstrapTrait
registerPlugin()	Registers a specific plugin and the related events	kartik\base\WidgetTrait
registerPluginOptions()	Registers plugin options by storing within a uniquely generated javascript variable.	kartik\base\WidgetTrait
setDataVar()	Sets a HTML5 data variable.	kartik\base\WidgetTrait

Events

Hide inherited events

Event	Type	Description	Defined By
EVENT_AFTER_RUN	yii\base\WidgetEvent	An event raised right after executing a widget. (available since version 2.0.11)	yii\base\Widget
EVENT_BEFORE_RUN	yii\base\WidgetEvent	An event raised right before executing a widget. (available since version 2.0.11)	yii\base\Widget
EVENT_INIT	yii\base\Event	An event that is triggered when the widget is initialized via init(). (available since version 2.0.11)	yii\base\Widget

Constants

Hide inherited constants

Constant	Value	Defined By
LARGE	'large'	kartik\spinner\Spinner
MEDIUM	'medium'	kartik\spinner\Spinner
SMALL	'small'	kartik\spinner\Spinner
TINY	'tiny'	kartik\spinner\Spinner

Property Details

$align public property

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.

public string $align = 'center'

$caption public property

Caption embedded inside the spinner. This is not HTML encoded. If you set it to an empty string, this will not be displayed.

public string $caption = ''

$captionOptions public property

HTML options for the caption container. The following additional attributes can be set:

tag: string the tag for rendering the container. Defaults to span,

public array $captionOptions = []

$color public property

The color (hex/name) to apply to the spinner. If not specified it will inherit the spinner container color

public string $color = null

$hidden public property

Is the spinner hidden by default. Defaults to false.

public boolean $hidden = false

$options public property

The HTML attributes for the combined container enclosing the spinner and caption. The following additional attributes can be set:

tag: string the tag for rendering the container. Defaults to div,

public array $options = []

$preset public property

The spinner preset to apply.

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
- if pluginOptions is also set, then it will create a preset with this name for the client session and apply the settings
- if pluginOptions is not set, an InvalidConfigException will be raised
if 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.

public string $preset = null

$spinOptions public property

The HTML attributes for the spinner container. The following additional attributes can be set:

tag: string the tag for rendering the container. Defaults to div,

public array $spinOptions = []

Method Details

registerAssets() public method

Registers the client assets for the kartik\spinner\Spinner widget.

public void registerAssets ( )

run() public method

Executes the widget.

public string\|void run ( )
return	string\|void	The rendering result may be directly "echoed" or returned as a string