Class BOBProgressBar

Namespace

BlazOrbit.Components

Assembly

BlazOrbit.dll

[GenerateComponentInfo]
public class BOBProgressBar : BOBComponentBase, IHasSize, IHasColor

Inheritance

object

ComponentBase

BOBComponentBase

BOBProgressBar

Implements

IHasSize

IHasColor

Inherited Members

BOBComponentBase.OnInitialized()

BOBComponentBase.OnAfterRenderAsync(bool)

BOBComponentBase.DisposeAsync()

BOBComponentBase.AdditionalAttributes

BOBComponentBase.ComputedAttributes

BOBComponentBase.IsDisposed

Constructors

BOBProgressBar()

public BOBProgressBar()

Properties

AriaLabel

Aria-label fallback when Label is empty.

[Parameter]
public string? AriaLabel { get; set; }

Property Value

string

Color

Fill color. Accepts any valid CSS color value, PaletteColor or BOBColor.

[Parameter]
public string? Color { get; set; }

Property Value

string

Indeterminate

When true, render an indeterminate animation instead of the value bar.

[Parameter]
public bool Indeterminate { get; set; }

Property Value

bool

Label

Optional label shown above the bar.

[Parameter]
public string? Label { get; set; }

Property Value

string

Max

Maximum value (default 100).

[Parameter]
public double Max { get; set; }

Property Value

double

Min

Minimum value (default 0).

[Parameter]
public double Min { get; set; }

Property Value

double

Segments

Number of equal-width segments. 1 = continuous bar (default). Ignored in indeterminate mode.

[Parameter]
public int Segments { get; set; }

Property Value

int

ShowPercentage

When true, render a "NN%" label on the right of the head row.

[Parameter]
public bool ShowPercentage { get; set; }

Property Value

bool

Size

Visual size of the bar.

[Parameter]
public BOBSize Size { get; set; }

Property Value

BOBSize

Value

Current progress value, in Min–Max. Ignored when Indeterminate.

[Parameter]
public double Value { get; set; }

Property Value

double

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder.

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

OnParametersSet()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

protected override void OnParametersSet()