Office UI Fabric JS

Microsoft no longer supports this content and will not be responding to bugs or issues. We recommend using the newer version Office UI Fabric React as your front-end framework.

ProgressIndicator

Overview

Progress Indicators are used to show the completion status of an operation lasting more than 2 seconds. If the state of progress cannot be determined, use a Spinner instead. Progress Indicators can appear in a new panel, a flyout, under the UI initiating the operation, or even replacing the initiating UI, as long as the UI can return if the operation is canceled or is stopped.

Progress Indicators feature a bar showing total units to completion, and total units finished. The description of the operation appears above the bar, and the status in text appears below. The description should tell someone exactly what the operation is doing. Examples of formatting include:

[Object] is being [operation name], or
[Object] is being [operation name] to [destination name] or
[Object] is being [operation name] from [source name] to [destination name]

Status text is generally in units elapsed and total units. If the operation can be canceled, an “X” glyph is used and should be placed in the upper right, aligned with the baseline of the operation name. When an error occurs, replace the status text with the error description using ms-fontColor-redDark.

Real-world examples include copying files to a storage location, saving edits to a file, and more. Use units that are informative and relevant to give the best idea to users of how long the operation will take to complete. Avoid time units as they arerarely accurate enough to be trustworthy. Also combine steps of a complex operation into one total bar to avoid “rewinding” the bar. Instead change the operation description to reflect the change if necessary. Bars moving backwards reduce confidence in the service.

Using this Component

Confirm that you have references to Fabric's CSS and JavaScript on your page:

					<link rel="stylesheet" href="fabric.min.css" />
<link rel="stylesheet" href="fabric.components.min.css" />
<script src="fabric.min.js"></script>
		
	

Copy the HTML from one of the samples below into your page. For example:

<div class="ms-ProgressIndicator">
  <div class="ms-ProgressIndicator-itemName">Example.jpg</div>
  <div class="ms-ProgressIndicator-itemProgress">
    <div class="ms-ProgressIndicator-progressTrack"></div>
    <div class="ms-ProgressIndicator-progressBar"></div>
  </div>
  <div class="ms-ProgressIndicator-itemDescription">Example.jpg</div>
</div>

Add the following <script> tag to your page, below the references to Fabric's JS, to instantiate all ProgressIndicator components on the page:

<script type="text/javascript">
  var ProgressIndicatorElements = document.querySelectorAll(".ms-ProgressIndicator");
  for (var i = 0; i < ProgressIndicatorElements.length; i++) {
    let ProgressIndicator = new fabric['ProgressIndicator'](ProgressIndicatorElements[i]);
    setTimeout(function() {
      ProgressIndicator.setProgressPercent(1);
    }, 2000);
  }
</script>

Replace the sample HTML content with your content.

Variants

Default ProgressIndicator

<div class="ms-ProgressIndicator">
  <div class="ms-ProgressIndicator-itemName">Example.jpg</div>
  <div class="ms-ProgressIndicator-itemProgress">
    <div class="ms-ProgressIndicator-progressTrack"></div>
    <div class="ms-ProgressIndicator-progressBar"></div>
  </div>
  <div class="ms-ProgressIndicator-itemDescription">Example.jpg</div>
</div>

<script type="text/javascript">
  var ProgressIndicatorElements = document.querySelectorAll(".ms-ProgressIndicator");
  for (var i = 0; i < ProgressIndicatorElements.length; i++) {
    let ProgressIndicator = new fabric['ProgressIndicator'](ProgressIndicatorElements[i]);
    setTimeout(function() {
      ProgressIndicator.setProgressPercent(1);
    }, 2000);
  }
</script>

Example.jpg

Methods

Name	Parameters	Description
`setProgressPercent(percent)`	percent: {Number} Floating point number from 0 to 1	Starts or restarts the animation sequence.
`setProgress(progress)`	progress: {Number} Sets the progress, must be between 0 and total	Sets the progress for a determinate operation. Use this in combination with setTotal.
`setTotal(total)`	total: {Number} Total size of component progress	Sets the total file size, etc. for a determinate operation. Use this in combination with setProgress.
`setName(name)`	name: {String} Name of title or label	Sets the text for the title or label.
`setDescription(description)`	description: {String} Text for description	Sets the text for the description.
`cacheDOM()`	None	Caches elements and values of the component.