---
title: "au-widget-help/IAuWidgetHelpParams | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-help.IAuWidgetHelpParams/"
---

# au-widget-help/IAuWidgetHelpParams

> Provides properties of the `help` widget.

## Interfaces

### IAuWidgetHelpParams

You can use these properties in **params** of the `AuWidgetHelp` class.
```json
{
  "widgets": [
    {
      "name": "help",
      "type": "help",
      "params": {
        "steps": {
          "0": {
            "type": "modal",
            "content": "faq"
          },
          "1": {
            "type": "page",
            "content": "http://customerscanvas.com"
          }
        }
      }
    }
  ]
}
```

#### Properties

##### base

```ts
base: StepHelpConfig;
```

##### steps

```ts
steps: object;
```

A list of steps included in the help.

###### Index Signature

```ts
[key: string]: StepHelpConfig
```

***

### StepHelpConfig

Provides properties for steps included in the `IAuWidgetHelpParams`.

#### Properties

##### content

```ts
content: string;
```

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

##### type

```ts
type: HelpType;
```

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

## Type Aliases

### HelpType

```ts
type HelpType = "modal" | "page";
```

A help style.

#### Modal

Represents a modal window.

#### Page

Represents a web page.