new SpinnerClass(context, opaque, callback)
Instantiates a controller for a new loading spinner overlay within desired context element.
Parameters:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
context |
String | Element | jQuery |
<optional> |
'body' | Container reference or query selector to create spinner within. |
opaque |
Boolean |
<optional> |
false | Whether to completely obscure content behind spinner. |
callback |
function |
<optional> |
Function to call after spinner completely fades in. |
- Source:
Members
-
<readonly> $context :jQuery
-
Element containing spinner layer.
Type:
- jQuery
- Source:
- See:
-
<readonly> $element :jQuery
-
Layer containing spinner graphic.
Type:
- jQuery
- Source:
- See:
-
<readonly> opaque :Boolean
-
Whether SpinnerClass#$element completely obscures content behind it.
Type:
- Source:
- See:
Methods
-
hide(callback)
-
Conceals spinner layer.
Parameters:
Name Type Description callbackfunction Function to call after layer is concealed.
- Source:
-
remove()
-
Destroys spinner layer.
- Source:
- To Do:
-
- SpinnerClass#hide already removes, so this is redundant.
-
show(callback)
-
Reveals spinner layer.
Parameters:
Name Type Description callbackfunction Function to call after layer is revealed.
- Source: