1. Support
  2. The Multistep Editor
  3. UI Framework Reference

UI Framework Reference › IWidgetStepsConfig

Interface: 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']._}}"
          }
        }
      }
    }
  ]
}

Hierarchy

  • IWidgetStepsConfig

Index

Properties

Properties

availabilityMode

• availabilityMode: NavigationMode

Defined in src/widgets/au-widget-steps/IWidgetStepsConfig.ts:40

Defines what steps are available to users.

steps

• steps: object

Defined in src/widgets/au-widget-steps/IWidgetStepsConfig.ts:42

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

Type declaration: