Class BOBStepper

Namespace

BlazOrbit.Components

Assembly

BlazOrbit.dll

[GenerateComponentInfo]
public class BOBStepper : BOBComponentBase, IHasSize

Inheritance

object

ComponentBase

BOBComponentBase

BOBStepper

Implements

IHasSize

Inherited Members

BOBComponentBase.OnInitialized()

BOBComponentBase.OnParametersSet()

BOBComponentBase.OnAfterRenderAsync(bool)

BOBComponentBase.AdditionalAttributes

BOBComponentBase.ComputedAttributes

BOBComponentBase.IsDisposed

Constructors

BOBStepper()

public BOBStepper()

Properties

AllowSkip

When true, clicking any step jumps to it. When false (default), only completed steps are reachable; pending steps are non-interactive until the user advances through NextAsync() or MoveToAsync(int).

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

Property Value

bool

ChildContent

Markup that emits the <BOBStep> children describing each step.

[Parameter]
public RenderFragment? ChildContent { get; set; }

Property Value

RenderFragment

CurrentStep

Index of the active step (zero-based). Two-way bound.

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

Property Value

int

CurrentStepChanged

Companion event for CurrentStep.

[Parameter]
public EventCallback<int> CurrentStepChanged { get; set; }

Property Value

EventCallback<int>

OnStepChange

Cancellable hook invoked before applying a step transition. Set Cancel to keep the active step at From.

[Parameter]
public EventCallback<BOBStepChangeEventArgs> OnStepChange { get; set; }

Property Value

EventCallback<BOBStepChangeEventArgs>

Orientation

Layout direction. Defaults to Horizontal.

[Parameter]
public BOBStepperOrientation Orientation { get; set; }

Property Value

BOBStepperOrientation

Size

Visual size of step markers + icons.

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

Property Value

BOBSize

StepCount

Total number of registered steps.

public int StepCount { get; }

Property Value

int

Methods

BuildRenderTree(RenderTreeBuilder)

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

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

DisposeAsync()

Tears down the JS-side behavior associated with this component.

public override ValueTask DisposeAsync()

Returns

ValueTask

MoveToAsync(int)

Move to an arbitrary step index. Honours OnStepChange cancellation.

public Task MoveToAsync(int target)

Parameters

target int

Returns

Task

NextAsync()

Move to the next step (clamped to the last index).

public Task NextAsync()

Returns

Task

PreviousAsync()

Move to the previous step (clamped to 0).

public Task PreviousAsync()

Returns

Task