Preloader add-on.
Provides API to create various types of standard preloaders.
Summary
Methods
Detailed Description
Methods
create_advanced_preloader(options)
Create an advanced preloader.
Parameters:
| Name |
Type |
Description |
options |
Object
|
Initialization options.
Properties
| Name |
Type |
Description |
canvas_container_id |
string
|
Canvas container ID. |
background_container_id |
string
|
Background container ID. |
preloader_bar_id |
string
|
Preloader bar ID. |
fill_band_id |
string
|
Preloader band ID. |
preloader_caption_id |
string
|
Preloader caption ID. |
preloader_container_id |
string
|
Preloader container ID. |
img_width |
number
|
Device image width. |
preloader_width |
number
|
Preloader width. |
|
- Deprecated
- Source:
create_preloader(options)
Create a preloader.
Parameters:
| Name |
Type |
Description |
options |
Object
|
Initialization options.
Properties
| Name |
Type |
Attributes |
Description |
container_color |
string
|
<optional>
|
The CSS background color of the preloader container. |
bar_color |
string
|
<optional>
|
The CSS background color of the preloader bar. |
frame_color |
string
|
<optional>
|
The CSS color of the preloader frame border. |
font_color |
string
|
<optional>
|
The CSS color of the preloader font. |
|
- Source:
create_rotation_preloader(options)
Create a rotation preloader.
Parameters:
| Name |
Type |
Description |
options |
Object
|
Initialization options.
Properties
| Name |
Type |
Attributes |
Description |
canvas_container_id |
string
|
|
Canvas container ID. |
background_container_id |
string
|
<optional>
|
Background container ID. |
bg_color |
string
|
<optional>
|
Background color. |
frame_bg_color |
string
|
<optional>
|
Frame background color. |
frame_class |
string
|
<optional>
|
CSS frame class. |
anim_elem_class |
string
|
<optional>
|
Animated element class. |
|
- Deprecated
- Source:
create_simple_preloader(options)
Create a simple preloader.
Parameters:
| Name |
Type |
Description |
options |
Object
|
Initialization options.
Properties
| Name |
Type |
Attributes |
Description |
canvas_container_id |
string
|
|
Canvas container ID. |
background_container_id |
string
|
<optional>
|
Background container ID. |
bg_color |
string
|
<optional>
|
Background color. |
bar_color |
string
|
<optional>
|
Load bar color. |
|
- Deprecated
- Source:
update_preloader(percentage)
Update the preloader bar status.
Parameters:
| Name |
Type |
Description |
percentage |
number
|
The new preloader bar percentage |
- Source: