Skip to main content

au-widget-help/IAuWidgetHelpParams

Interfaces​

IAuWidgetHelpParams​

Provides properties of the help widget.

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

{
  "widgets": [
    {
      "name": "help",
      "type": "help",
      "params": {
        "steps": {
          "0": {
            "type": "modal",
            "content": "faq"
          },
          "1": {
            "type": "page",
            "content": "http://customerscanvas.com"
          }
        }
      }
    }
  ]
}

Properties​

base​
base: StepHelpConfig;
steps​
steps: object;

A list of steps included in the help.

Index Signature​
[key: string]: StepHelpConfig

StepHelpConfig​

Provides properties for steps included in the IAuWidgetHelpParams.

Properties​

content​
content: string;

Either the name of a modal window or a link to open in this step.

type​
type: HelpType;

A type of the content displayed in the help step, either modal or page.

Type Aliases​

HelpType​

type HelpType = "modal" | "page";

A help style.

Represents a modal window.

Page​

Represents a web page.

Was this page helpful?