Class IgbStepper

IgxStepper provides a wizard-like workflow by dividing content into logical steps. @remarks The stepper component allows the user to navigate between multiple steps. It supports horizontal and vertical orientation as well as keyboard navigation and provides API methods to control the active step.

Inheritance
System.Object
BaseRendererControl
IgbStepper
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbStepper : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbStepper()

Declaration
public IgbStepper()

Properties

ActiveStepChanged

Declaration
public EventCallback<IgbActiveStepChangedEventArgs> ActiveStepChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbActiveStepChangedEventArgs>

ActiveStepChangedScript

Declaration
public string ActiveStepChangedScript { get; set; }
Property Value
Type Description
System.String

ActiveStepChanging

Declaration
public EventCallback<IgbActiveStepChangingEventArgs> ActiveStepChanging { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbActiveStepChangingEventArgs>

ActiveStepChangingScript

Declaration
public string ActiveStepChangingScript { get; set; }
Property Value
Type Description
System.String

AnimationDuration

The animation duration in either vertical or horizontal mode.

Declaration
public double AnimationDuration { get; set; }
Property Value
Type Description
System.Double

ContentTop

Get/Set whether the content is displayed above the steps. @remarks Default value is false and the content is below the steps.

Declaration
public bool ContentTop { get; set; }
Property Value
Type Description
System.Boolean

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides

DirectRenderElementName

Declaration
protected override string DirectRenderElementName { get; }
Property Value
Type Description
System.String
Overrides

HorizontalAnimation

The animation type when in horizontal mode.

Declaration
public HorizontalTransitionAnimation HorizontalAnimation { get; set; }
Property Value
Type Description
HorizontalTransitionAnimation

Linear

Get/Set whether the stepper is linear. @remarks If the stepper is in linear mode and if the active step is valid only then the user is able to move forward.

Declaration
public bool Linear { get; set; }
Property Value
Type Description
System.Boolean

Orientation

Gets/Sets the orientation of the stepper. @remarks Default value is horizontal.

Declaration
public StepperOrientation Orientation { get; set; }
Property Value
Type Description
StepperOrientation

Steps

Returns all of the stepper's steps.

Declaration
public IgbStep[] Steps { get; set; }
Property Value
Type Description
IgbStep[]

StepType

Get/Set the type of the steps. @remarks Default value is full.

Declaration
public StepperStepType StepType { get; set; }
Property Value
Type Description
StepperStepType

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

TitlePosition

Get/Set the position of the steps title. @remarks The default value is auto. When the stepper is horizontally orientated the title is positioned below the indicator. When the stepper is horizontally orientated the title is positioned on the right side of the indicator.

Declaration
public StepperTitlePosition TitlePosition { get; set; }
Property Value
Type Description
StepperTitlePosition

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UseDirectRender

Declaration
protected override bool UseDirectRender { get; }
Property Value
Type Description
System.Boolean
Overrides

VerticalAnimation

The animation type when in vertical mode.

Declaration
public StepperVerticalAnimation VerticalAnimation { get; set; }
Property Value
Type Description
StepperVerticalAnimation

Methods

ConnectedCallback()

Declaration
public void ConnectedCallback()

ConnectedCallbackAsync()

Declaration
public Task ConnectedCallbackAsync()
Returns
Type Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

NavigateTo(Double)

Declaration
public void NavigateTo(double index)
Parameters
Type Name Description
System.Double index

NavigateToAsync(Double)

Activates the step at a given index.

Declaration
public Task NavigateToAsync(double index)
Parameters
Type Name Description
System.Double index
Returns
Type Description
System.Threading.Tasks.Task

Next()

Declaration
public void Next()

NextAsync()

Activates the next enabled step.

Declaration
public Task NextAsync()
Returns
Type Description
System.Threading.Tasks.Task

Prev()

Declaration
public void Prev()

PrevAsync()

Activates the previous enabled step.

Declaration
public Task PrevAsync()
Returns
Type Description
System.Threading.Tasks.Task

Reset()

Declaration
public void Reset()

ResetAsync()

Resets the stepper to its initial state i.e. activates the first step. @remarks The steps' content will not be automatically reset.

Declaration
public Task ResetAsync()
Returns
Type Description
System.Threading.Tasks.Task

ResolveDisplay()

Declaration
protected override string ResolveDisplay()
Returns
Type Description
System.String
Overrides

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable