au-widget-steps/IWidgetStepsConfig

Enumerations

NavigationMode

Navigation modes.

Enumeration Members

Enumeration Member	Value	Description
all	2	All steps are available.
previous	0	The user can visit only the next step and all previous steps.
visited	1	The user can visit the next step and all previously visited steps.

Classes

StepConditionConfig

Constructors

Constructor

new StepConditionConfig(): StepConditionConfig;

Returns

StepConditionConfig

Properties

description?

optional description?: string;

Tooltip text that will be displayed on the Next button, showing why it is impossible to go to the next step

disabled?

optional disabled?: boolean;

Disables a step.

enabled?

optional enabled?: boolean;

Enables a step.

hidden?

optional hidden?: boolean;

Makes step hidden.

Interfaces

IBackToProductButton

Properties

onClick

onClick: Function | Function[];

title

title: string;

url

url: string;

visible

visible: boolean;

---

IStepData

Provides the title and index for manipulating steps.

Properties

index

index: number;

name

name: string;

title

title: string;

---

IWidgetStepsConfig

Provides properties for the steps widget.

You can use these properties in params of the AuWidgetSteps class.

{
  "widgets": [
    {
      "name": "steps",
      "type": "steps",
      "params": {
        "availabilityMode": "visited",
        "steps": {
          "Step 3": {
            "enabled": "{{$['confirmation-checkbox']._}}"
          }
        }
      }
    }
  ]
}

Properties

availabilityMode

availabilityMode: NavigationMode;

Defines what steps are available to users.

backToProductButton

backToProductButton: IBackToProductButton;

Allows you to enable and configure backToProduct button.

finishButton

finishButton: IFinishButtonConfig;

steps

steps: object;

Allows you to override the availability mode of a particular step.

Index Signature

[key: string]: StepConditionConfig