Class: RoboWizard<Values>
robo-wizard.RoboWizard
typeparam Generic type for the configured state machine, based on the Machine type from robot
Type parameters
| Name | Type | Description |
|---|---|---|
Values | extends object = BaseValues | Generic type for object of values being gathered through the wizard steps This class is the return value from createWizard and the only way to be instantiated. |
Accessors
currentStep
• get currentStep(): any
Returns the current step of the wizard
Returns
any
Defined in
currentValues
• get currentValues(): Values
Returns the current state of values been gathered through the wizard
Returns
Values
Defined in
Methods
goToNextStep
▸ goToNextStep(event?): void
Parameters
| Name | Type | Description |
|---|---|---|
event | Partial<UpdateEvent<Values>> | Optional object with a values field to described what Values should be updated, see [[UpdateEvent]] Progress to the next step in the wizard |
Returns
void
Defined in
goToPreviousStep
▸ goToPreviousStep(event?): void
Parameters
| Name | Type | Description |
|---|---|---|
event | Partial<UpdateEvent<Values>> | Optional object with a values field to described what Values should be updated, see [[UpdateEvent]] Progress to the previous step in the wizard |
Returns
void
Defined in
start
▸ start(onChange, values?): void
Parameters
| Name | Type | Description |
|---|---|---|
onChange | ChangeHandler<Values> | [[ChangeHandler]] for reacting when the wizard updates, this will be called immediately |
values? | Values | Optional object of initial values to use when creating the wizard This should be called before trying to access any other methods or properties, otherwise an Error will be thrown |
Returns
void
Defined in
sync
▸ sync(event): void
Parameters
| Name | Type | Description |
|---|---|---|
event | Object | Optional object with a step field to described what the current step should be Sync the external updated step with internal service |
event.step | string | - |
Returns
void