GuideWorkflow<O, E, S>
Extends
BaseObserver<GuideWorkflowListener>
Type Parameters
| Type Parameter | Default type |
|---|---|
O extends GuideWorkflowOptions | GuideWorkflowOptions |
E extends ReactorComponentSelections | ReactorComponentSelections |
S extends any | any |
Constructors
Constructor
new GuideWorkflow<O, E, S>(options): GuideWorkflow<O, E, S>;
Parameters
| Parameter | Type |
|---|---|
options | O |
Returns
GuideWorkflow<O, E, S>
Overrides
BaseObserver<GuideWorkflowListener>.constructor
Properties
| Property | Type |
|---|---|
guideStore | GuideStore |
listener | any |
options | O |
state | Partial<S> |
steps | GuideStep<ReactorComponentSelections, GuideStepOptions<ReactorComponentSelections>>[] |
Accessors
ready
system
Methods
activate()
activate(step?, state?): void;
Parameters
| Parameter | Type | Default value |
|---|---|---|
step | number | 0 |
state | Partial<S> | {} |
Returns
void
activateStep()
activateStep(step): void;
Parameters
| Parameter | Type |
|---|---|
step | GuideStep |
Returns
void
canGoNext()
canGoNext(): boolean;
Returns
boolean
complete()
complete(): void;
Returns
void
currentStep()
currentStep(): GuideStep<ReactorComponentSelections, GuideStepOptions<ReactorComponentSelections>>;
Returns
GuideStep<ReactorComponentSelections, GuideStepOptions<ReactorComponentSelections>>
currentStepIndex()
currentStepIndex(): number;
Returns
number
exit()
exit(): void;
Returns
void
generateSelectionEvent()
generateSelectionEvent(step): E;
Parameters
| Parameter | Type |
|---|---|
step | GuideStep |
Returns
E
getEventGenerators()
getEventGenerators(): ComponentSelectorGenerator[];
Returns
next()
next(s?): void;
Parameters
| Parameter | Type |
|---|---|
s | Partial<S> |
Returns
void
registerStep()
registerStep(step): void;
Parameters
| Parameter | Type |
|---|---|
step | GuideStep |
Returns
void
setGuideStore()
setGuideStore(store): void;
Parameters
| Parameter | Type |
|---|---|
store | GuideStore |
Returns
void
setState()
setState(s): void;
Parameters
| Parameter | Type |
|---|---|
s | Partial<S> |
Returns
void