RayCraftDocs
v1.0.3 raycraft.dev
On this page

Wizard

Free

A guided flow in steps. Each step can validate before the user moves on, a step can be optional, finished steps can be reopened, and the result can show a page of its own.

Example

Wizard control

Parameters

Wizard

ParameterTypeDescription
ActiveIndexintIndex of the open step. Use with @bind-ActiveIndex.
ChildContentRenderFragmentContent rendered inside the component.
ClassstringExtra CSS classes added to the root element.
CompletedContentRenderFragmentContent shown instead of the wizard after it was finished.
FinishTextstringText of the button on the last step.
LinearboolThe header opens only steps that were already reached.
ShowProgressboolShows a progress bar above the steps.
StylestringInline style added to the root element.
VerticalboolPuts the step list at the side.

WizardStep

ParameterTypeDescription
ChildContentRenderFragmentContent rendered inside the component.
DescriptionstringShort text under the title.
DisabledboolThe step cannot be opened.
ErrorboolMarks the step as having a problem.
IconIconName?Icon in the marker instead of the number.
OptionalboolThe step can be skipped.
TitlestringName of the step in the header.
ValidateFunc<Task<bool>>Returns false to keep the user on the step.

Events

Wizard

EventTypeDescription
ActiveIndexChangedEventCallback<int>Raised when another tab is selected.
OnCancelEventCallbackShows a Cancel button and raises this when it is used.
OnFinishEventCallbackRaised when the last step is finished.
OnStepChangingEventCallback<WizardStepChange>Raised before the step changes; set Cancel on the argument to stay.

Package

Wizard is part of RayCraft Free. Package: RayCraft.Blazor. It comes from nuget.org. See Getting started.