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

Usage


Basic

<BitProgress Label="Basic Progress"
             Description="Example description"
             Percent="42" />
Example description

Circular

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

ShowPercentNumber

<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 />
86 %

85.69 %


86 %

85.69 %

Thickness

<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;
}
                    


69 %

69 %

Indeterminate

<BitProgress Indeterminate />

<BitProgress Circular Indeterminate />

Color

<BitProgress Color="BitColor.Primary" Percent="69" />
<BitProgress Color="BitColor.Secondary" Percent="69" />
<BitProgress Color="BitColor.Tertiary" Percent="69" />
<BitProgress Color="BitColor.Info" Percent="69" />
<BitProgress Color="BitColor.Success" Percent="69" />
<BitProgress Color="BitColor.Warning" Percent="69" />
<BitProgress Color="BitColor.SevereWarning" Percent="69" />
<BitProgress Color="BitColor.Error" Percent="69" />

<BitProgress Color="BitColor.Primary" Circular Percent="69" />
<BitProgress Color="BitColor.Secondary" Circular Percent="69" />
<BitProgress Color="BitColor.Tertiary" Circular Percent="69" />
<BitProgress Color="BitColor.Info" Circular Percent="69" />
<BitProgress Color="BitColor.Success" Circular Percent="69" />
<BitProgress Color="BitColor.Warning" Circular Percent="69" />
<BitProgress Color="BitColor.SevereWarning" Circular Percent="69" />
<BitProgress Color="BitColor.Error" Circular Percent="69" />

Size

<BitProgress Size="BitSize.Small" Label="Small" Percent="69" ShowPercentNumber />
<BitProgress Size="BitSize.Medium" Label="Medium" Percent="69" ShowPercentNumber />
<BitProgress Size="BitSize.Large" Label="Large" Percent="69" ShowPercentNumber />

<BitProgress Size="BitSize.Small" Circular Percent="69" ShowPercentNumber />
<BitProgress Size="BitSize.Medium" Circular Percent="69" ShowPercentNumber />
<BitProgress Size="BitSize.Large" Circular Percent="69" ShowPercentNumber />
69 %

69 %

69 %


69 %
69 %
69 %

Spinner

<BitProgress Circular Indeterminate Size="BitSize.Small" />
<BitProgress Circular Indeterminate Size="BitSize.Medium" />
<BitProgress Circular Indeterminate Size="BitSize.Large" />

<BitProgress Circular Indeterminate Color="BitColor.Success" />
<BitProgress Circular Indeterminate Color="BitColor.Warning" />
<BitProgress Circular Indeterminate Color="BitColor.Error" />

Style & Class

<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;" Thickness="10" />

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


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

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


<BitProgress Indeterminate
             Thickness="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"
             Thickness="10" />


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

<BitProgress Circular
             Percent="69"
             Thickness="10"
             Classes="@(new() { Bar = "custom-circle-bar",
                                Track = "custom-circle-tracker"})" />
Component's Style & Class:








Styles & Classes:





RTL

<BitProgress Dir="BitDir.Rtl"
             Thickness="10"
             Indeterminate />

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

<BitProgress Circular
             Dir="BitDir.Rtl"
             Thickness="10"
             Indeterminate />

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

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



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

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 BitColor? null The general 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 number in percentage display.
Radius int 6 The radius of the circular progress.
ShowPercentNumber bool false Whether or not to percentage display.
Size BitSize? null The size of the BitProgress.
Styles BitProgressClassStyles? null Custom CSS Styles for different parts of the BitProgress.
Thickness int? null Thickness of the BitProgress. When not set, the value is determined by the Size parameter.

BitComponentBase parameters

Name Type Default value Description
AriaLabel string? null Gets or sets the accessible label for the component, used by assistive technologies.
Class string? null Gets or sets the CSS class name(s) to apply to the rendered element.
Dir BitDir? null Gets or sets the text directionality for the component's content.
ForceAnimation bool false Gets or sets a value indicating whether the component's animations play at their full duration even when reduced motion is requested.
HtmlAttributes Dictionary<string, object> new Dictionary<string, object>() Captures additional HTML attributes to be applied to the rendered element, in addition to the component's parameters.
Id string? null Gets or sets the unique identifier for the component's root element.
IsEnabled bool true Gets or sets a value indicating whether the component is enabled and can respond to user interaction.
Style string? null Gets or sets the CSS style string to apply to the rendered element.
TabIndex string? null Gets or sets the tab order index for the component when navigating with the keyboard.
Visibility BitVisibility BitVisibility.Visible Gets or sets the visibility state (visible, hidden, or collapsed) of the component.

BitComponentBase public members

Name Type Default value Description
UniqueId Guid Guid.NewGuid() Gets the readonly unique identifier for the component's root element, assigned when the component instance is constructed.
RootElement ElementReference Gets the reference to the root HTML element associated with this component.

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.

BitColor enum

Name Value Description
Primary 0 Primary general color.
Secondary 1 Secondary general color.
Tertiary 2 Tertiary general color.
Info 3 Info general color.
Success 4 Success general color.
Warning 5 Warning general color.
SevereWarning 6 SevereWarning general color.
Error 7 Error general color.
PrimaryBackground 8 Primary background color.
SecondaryBackground 9 Secondary background color.
TertiaryBackground 10 Tertiary background color.
PrimaryForeground 11 Primary foreground color.
SecondaryForeground 12 Secondary foreground color.
TertiaryForeground 13 Tertiary foreground color.
PrimaryBorder 14 Primary border color.
SecondaryBorder 15 Secondary border color.
TertiaryBorder 16 Tertiary border color.

BitSize enum

Name Value Description
Small 0 The small size.
Medium 1 The medium size.
Large 2 The large size.

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.