← API Index · How to use components

progressbar component #oo-pb / .oo-progress

Shows the progress of large downloads the toolkit performs (e.g. preloading the item data). For every request that reports progress, the template inside the component is cloned, filled and shown; when the request is done its bar is hidden again. While the size is still unknown the bar idles and the value shows "…".

The progress bars are controlled independently from the loading indicator, but are typically placed inside that element.

How components are mounted, how switch values are resolved and how debug output is enabled is described in the use-js-components skill.

<div class="oo-loading">Loading…
  <div id="oo-pb">
    <div id="oo-pb-tpl" class="oo-pb-bar">
      <progress class="oo-pb-bar-pb" max="100"></progress>
      <span class="oo-pb-bar-value"></span> / <span class="oo-pb-bar-total"></span>
      = <span class="oo-pb-bar-percent"></span> %
      <span class="oo-pb-bar-url"></span>
    </div>
  </div>
</div>
Placeholder Description
#oo-pb-tpl Template cloned per request.
.oo-pb-bar-pb A <progress> element; max and value are set.
.oo-pb-bar-value, .oo-pb-bar-total, .oo-pb-bar-percent Bytes loaded, total bytes, percentage.
.oo-pb-bar-url The address being loaded.

component switches

This component has no switches.

debug options

The component has no debug terms; progress values are visible in the bars themselves.