Table of Contents

Class TwProgress<T>

Namespace
TwBlazor.Components
Assembly
TwBlazor.dll

Represents a generic progress bar that displays completion of a task towards a maximum value.

public class TwProgress<T> : TwBlazorInputComponentBase, IComponent, IHandleEvent, IHandleAfterRender, ITwComponent, ITwInputComponent

Type Parameters

T

The type of the value represented by the progress bar. Must support conversion to double for percentage calculation.

Inheritance
TwProgress<T>
Implements
Inherited Members

Constructors

TwProgress() 

public TwProgress()

Properties

AriaBusy

Gets or sets whether the progress bar's region is announced as busy to assistive technology.

[Parameter]
public bool? AriaBusy { get; set; }

Property Value

bool?

Remarks

If not set, defaults to Indeterminate so an indeterminate progress bar is announced as busy while a determinate one (even at 0%) is not.

AriaDescribedBy

Gets or sets the id(s) of element(s) that describe the progress bar for assistive technology, in addition to any error message id.

[Parameter]
public string AriaDescribedBy { get; set; }

Property Value

string

Color

Gets or sets the color of the progress bar's filled portion.

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

Property Value

Color?

Remarks

If not set, defaults to blue.

Indeterminate

Gets or sets whether the progress bar shows an indeterminate (unknown-duration) animation instead of a specific Value.

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

Property Value

bool

Remarks

When true, the value attribute is omitted from the rendered <progress> element, which is how the HTML spec distinguishes an indeterminate progress bar from one that is determinately at 0%.

Max

Gets or sets the value that represents 100% completion.

[Parameter]
public required T Max { get; set; }

Property Value

T

Size

Gets or sets the size (thickness) of the progress bar.

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

Property Value

ProgressSize

Value

Gets or sets the current value of the progress bar.

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

Property Value

T

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied RenderTreeBuilder.

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder
Edit this page