Home Docs

Progress
ProgressIndicator
ProgressBar

BitProgress is used to show the completion status of an operation.

Usage

Basic
Example description
<BitProgress Label="Basic Progress"
             Description="Example description"
             Percent="42" />
Circular
Example description
<BitProgress Circular
             Label="Basic Circular Progress"
             Description="Example description"
             Percent="42" />
ShowPercentNumber
86 %

85.69 %


86 %

85.69 %
<BitProgress Label="Show Percent Number"
             Percent="85.69"
             ShowPercentNumber />
<BitProgress Label="Percent Number Format"
             Percent="85.69"
             PercentNumberFormat="{0:F2} %"
             ShowPercentNumber />

<BitProgress Circular
             Label="Show Percent Number"
             Percent="85.69"
             ShowPercentNumber />
<BitProgress Circular
             Label="Percent Number Format"
             Percent="85.69"
             PercentNumberFormat="{0:F2} %"
             ShowPercentNumber />
Thickness


69 %

69 %
<BitSlider @bind-Value="barThickness" Max="50" />

<BitProgress ShowPercentNumber Percent="69" Thickness="(int)barThickness" />

<BitProgress Circular ShowPercentNumber Percent="69" Thickness="(int)barThickness" />
@code {
    private double barThickness = 10;
}
Indeterminate

<BitProgress Indeterminate />

<BitProgress Circular Indeterminate />
Color




<BitProgress Color="#c10606" Percent="69" />
<BitProgress Color="#ffba17" Indeterminate />

<BitProgress Color="#c10606" Circular Percent="69" />
<BitProgress Color="#ffba17" Circular Indeterminate />
Style & Class
Component's Style & Class:








Styles & Classes:





<style>
    .custom-class {
        padding: 0.2rem;
        margin-bottom: 1rem;
        border-radius: 0.5rem;
        background-color: darkred;
    }

    .custom-track {
        background-color: #ff6a00;
    }

    .custom-bar {
        background-color: #ff2700;
    }

    .custom-circle-track {
        stroke: #ff6a00;
    }

    .custom-circle-bar {
        stroke: #ff2700;
    }
</style>


<BitProgress Indeterminate Style="background-color: #e687dc; border-radius: 0.5rem; padding: 0.2rem;" Height="10" />

<BitProgress Class="custom-class"
             Percent="69"
             Height="10" />


<BitProgress Circular Indeterminate Style="background-color: #e687dc; border-radius: 0.5rem; padding: 0.2rem;" Height="10" />

<BitProgress Circular
             Class="custom-class"
             Percent="69"
             Height="10" 

<BitProgress Indeterminate
             Height="10"
             Styles="@(new() { Bar = "background: linear-gradient(to right, green 0%, yellow 50%, green 100%);",
                                Track = "background-color: green;" })" />

<BitProgress Classes="@(new() { Bar = "custom-bar",
                                 Track = "custom-tracker"})"
             Percent="69"
             Height="10" />


<BitProgress Circular Indeterminate
             Height="10"
             Styles="@(new() { Bar = "stroke: greenyellow;",
                               Track = "stroke: green;" })" />

<BitProgress Circular
             Percent="69"
             Height="10"
             Classes="@(new() { Bar = "custom-circle-bar",
                                Track = "custom-circle-tracker"})" />
RTL

69 %
توضیحات تست



69 %
توضیحات تست
<BitProgress Dir="BitDir.Rtl"
             Height="10"
             Indeterminate />

<BitProgress Label="لیبل تست"
             Description="توضیحات تست"
             Dir="BitDir.Rtl"
             Percent="69"
             Height="10"
             ShowPercent />

API

BitProgress parameters
Name
Type
Default value
Description
AriaValueText string? null Text alternative of the progress status, used by screen readers for reading the value of the progress.
Classes BitProgressClassStyles? null Custom CSS classes for different parts of the BitProgress.
Color string? null Color of the BitProgress.
Circular bool false Circular mode of the BitProgress.
Description string? null Text describing or supplementing the operation.
DescriptionTemplate RenderFragment? null Custom template for describing or supplementing the operation.
Indeterminate bool false Whether or not to show indeterminate progress animation.
Label string? null Label to display above the BitProgress.
LabelTemplate RenderFragment? null Custom label template to display above the BitProgress.
Percent double 0 Percentage of the operation's completeness, numerically between 0 and 100.
PercentNumberFormat string {0:F0} The format of the percent in percentage display.
Radius int 6 The radius of the circular progress.
ShowPercentNumber bool false Whether or not to percentage display.
Styles BitProgressClassStyles? null Custom CSS Styles for different parts of the BitProgress.
Thickness int 2 Thickness of the BitProgress.
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.
Dir BitDir? null Determines the component direction.
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.
BitProgressClassStyles properties
Name
Type
Default value
Description
Root string? null Custom CSS classes/styles for the root element of the BitProgress.
Label string? null Custom CSS classes/styles for the label of the BitProgress.
PercentNumber string? null Custom CSS classes/styles for the percent number of the BitProgress.
BarContainer string? null Custom CSS classes/styles for the bar container of the BitProgress.
Track string? null Custom CSS classes/styles for the track of the BitProgress.
Bar string? null Custom CSS classes/styles for the bar of the BitProgress.
Description string? null Custom CSS classes/styles for the description of the BitProgress.
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).
BitDir enum
Name
Value
Description
Ltr 0 Ltr (left to right) is to be used for languages that are written from the left to the right (like English).
Rtl 1 Rtl (right to left) is to be used for languages that are written from the right to the left (like Arabic).
Auto 2 Auto lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then applies that directionality to the whole element.

Feedback

You can give us your feedback through our GitHub repo by filing a new Issue or starting a new Discussion.

Or you can review / edit this page on GitHub.

Or you can review / edit this component on GitHub.
  • On this page