- Description:
Contain the logic for the loading icon.
- Source:
- Copyright:
- 2019 Andrew Nicols
- 2019 Andrew Nicols
- License:
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Contain the logic for the loading icon.
Methods
(inner) addIconToContainer(container, optionsopt) → {Promise}
- Description:
Add a loading icon to the end of the specified container and return an unresolved promise.
Resolution of the returned promise causes the icon to be faded out and removed.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
container |
jQuery | HTMLElement | The element to add the spinner to |
|
options |
Object |
<optional> |
Options for the icon. |
Returns:
The Promise used to create the icon.
- Type
- Promise
(inner) addIconToContainerWithPromise(container, loadingIconPromise, optionsopt) → {jQuery}
- Description:
Add a loading icon to the end of the specified container and return an unresolved promise.
Resolution of the returned promise causes the icon to be faded out and removed.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
container |
jQuery | HTMLElement | The element to add the spinner to |
|
loadingIconPromise |
Promise | The jQuery Promise which determines the removal of the icon |
|
options |
Object |
<optional> |
Options for the icon. |
Returns:
The Promise used to create and then remove the icon.
- Type
- jQuery
(inner) addIconToContainerWithPromise(container, optionsopt) → {Promise}
- Description:
Add a loading icon to the end of the specified container and return an unresolved promise.
Resolution of the returned promise causes the icon to be faded out and removed.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
container |
jQuery | HTMLElement | The element to add the spinner to |
|
options |
Object |
<optional> |
Options for the icon. |
Returns:
A jQuery Promise to resolve when ready
- Type
- Promise
(inner) getIcon(optionsopt) → {Promise}
- Description:
Get the loading icon template.
- Source:
Parameters:
| Name | Type | Attributes | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
<optional> |
Options for the icon. Properties
|
Returns:
The Promise used to create the icon.
- Type
- Promise