Class BOBProgressRing

Namespace

BlazOrbit.Components

Assembly

BlazOrbit.dll

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

Inheritance

object

ComponentBase

BOBComponentBase

BOBProgressRing

Implements

IHasSize

IHasColor

Inherited Members

BOBComponentBase.OnInitialized()

BOBComponentBase.OnParametersSet()

BOBComponentBase.OnAfterRenderAsync(bool)

BOBComponentBase.DisposeAsync()

BOBComponentBase.AdditionalAttributes

BOBComponentBase.ComputedAttributes

BOBComponentBase.IsDisposed

Constructors

BOBProgressRing()

public BOBProgressRing()

Properties

AriaLabel

Aria-label for assistive tech.

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

Property Value

string

Color

Stroke 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 spinner.

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

Property Value

bool

Label

Center label rendered when ShowPercentage is false.

[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

ShowPercentage

When true, render the "NN%" string in the center.

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

Property Value

bool

Size

Visual size of the ring.

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

Property Value

BOBSize

Value

Current progress value, in Min–Max.

[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