Difference between revisions of "Loading Bar"
(Created page with "The <code>iv-loading-bar</code> is a non-reactive that takes in a number and display the number through its percentage width. == Usage == <div class="res-img"> File:Loading...") |
|||
Line 1: | Line 1: | ||
This page is a child of the [[Loading tools]] page. | |||
The loading bar component appears as a grey rectangle that fills up and serves to display the loading progress of a visualisation. It is particularly useful when a long loading time is inevitable as it assures the user that loading is happening. The benefit of this component over the [https://wiki.impvis.co.uk/index.php/Loading_spinner loading spinner] component is this component allows the user to anticipate the loading time. This component can be called using the <code>iv-loading-bar</code> tag. | |||
<div class="res-img"> | |||
[[File:LoadingBarMidProgress.png]] | |||
</div> | |||
== Technical information == | |||
The <code>iv-loading-bar</code> is a non-reactive that takes in a number and display the number through its percentage width. | The <code>iv-loading-bar</code> is a non-reactive that takes in a number and display the number through its percentage width. | ||
== Usage == | === Props === | ||
Name: loadingProgress | |||
Type: Number | |||
Default: 0 | |||
Description: The number that is taken in and turned into percentage width of the blue progress bar. | |||
=== Usage === | |||
To display the loading progress of a visualisation, bind a number, which must have a range of only 0 to 100, that reflects the loading. | |||
<div class="res-img"> | <div class="res-img"> | ||
[[File:LoadingBar1.png|alt=Picture of the loading bar at 0% completeness.]] | [[File:LoadingBar1.png|alt=Picture of the loading bar at 0% completeness.]] | ||
Line 14: | Line 35: | ||
<br clear=all> | <br clear=all> | ||
== | == Design choice == | ||
The blue progress bar is chosen to fit in the general ImpVis blue while the grey background gives a sense of incomplete or inactive. | |||
[[Category:ImpVis Components]] | |||
Revision as of 09:07, 28 June 2021
This page is a child of the Loading tools page.
The loading bar component appears as a grey rectangle that fills up and serves to display the loading progress of a visualisation. It is particularly useful when a long loading time is inevitable as it assures the user that loading is happening. The benefit of this component over the loading spinner component is this component allows the user to anticipate the loading time. This component can be called using the iv-loading-bar
tag.
Technical information
The iv-loading-bar
is a non-reactive that takes in a number and display the number through its percentage width.
Props
Name: loadingProgress
Type: Number
Default: 0
Description: The number that is taken in and turned into percentage width of the blue progress bar.
Usage
To display the loading progress of a visualisation, bind a number, which must have a range of only 0 to 100, that reflects the loading.
Design choice
The blue progress bar is chosen to fit in the general ImpVis blue while the grey background gives a sense of incomplete or inactive.