ProgressIndicator
BitProgressIndicators 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. ProgressIndicators 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. 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 are rarely 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.
Usage
BitProgressIndicator
Example title
Push button to start!
Indeterminate Progress Indicator
Example title
Example description
Implementation
BitProgressIndicator parameters
Name |
Type |
Default value |
Description |
|---|---|---|---|
| AriaValueText | string | string.Empty | Text alternative of the progress status, used by screen readers for reading the value of the progress. |
| BarHeight | int | 2 | Height of the ProgressIndicator. |
| Description | string | string.Empty | Text describing or supplementing the operation. |
| DescriptionTemplate | RenderFragment? | null | Custom template for describing or supplementing the operation. |
| IsProgressHidden | bool | false | Whether or not to hide the progress state. |
| Label | string | string.Empty | Label to display above the component. |
| LabelTemplate | RenderFragment? | null | Custom label template to display above the component. |
| PercentComplete | double? | null | Percentage of the operation's completeness, numerically between 0 and 100. If this is not set, the indeterminate progress animation will be shown instead. |
| ProgressTemplate | RenderFragment<BitProgressIndicator>? | null | A custom template for progress track. |
BitComponentBase parameters
Name |
Type |
Default value |
Description |
|---|---|---|---|
| AriaLabel | string? | null | The aria-label of the control for the benefit of screen readers. |
| Class | string? | null | Custom CSS class for the root element of the component. |
| HtmlAttributes | Dictionary<string, object> | new Dictionary<string, object>() | Capture and render additional attributes in addition to the component's parameters. |
| Id | string? | null | Custom id attribute for the root element. if null the UniqueId will be used instead. |
| IsEnabled | bool | true | Whether or not the component is enabled. |
| Style | string? | null | Custom CSS style for the root element of the component. |
| Visibility | BitVisibility | BitVisibility.Visible | Whether the component is visible, hidden or collapsed. |
BitComponentBase public members
Name |
Type |
Default value |
Description |
|---|---|---|---|
| UniqueId | Guid | Guid.NewGuid() | The readonly unique id of the root element. it will be assigned to a new Guid at component instance construction. |
| RootElement | ElementReference | The ElementReference of the root element. |
BitVisibility enum
Name |
Value |
Description |
|---|---|---|
| Visible | 0 | The content of the component is visible. |
| Hidden | 1 | The content of the component is hidden, but the space it takes on the page remains (visibility:hidden). |
| Collapsed | 2 | The component is hidden (display:none). |