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

# au-widget-group/au-widget-group

> A widget that is used to group multiple widgets together.

## Classes

### AuWidgetGroup

For details, you can refer to the [Group widget](https://customerscanvas.com/dev/ui-framework/widgets/group.html) topic.

```json
{
  "widgets": [
    {
      "name": "option-list",
      "type": "group",
      "params": {
        "type": "noncollapsible",
        "tabs": [
          {
            "widgets": [
              {
                "title": "Corner Type",
                "name": "corners",
                "type": "option",
                "params": { ... }
              },
              {
                "title": "Lamination",
                "name": "lamination",
                "type": "option",
                "params": { ... }
              }
            ]
          }
        ]
      }
    }
  ]
}
```

#### Extends

- [`AuBaseSelectorWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubaseselectorwidget)

#### Constructors

##### Constructor

```ts
new AuWidgetGroup(): AuWidgetGroup;
```

###### Returns

[`AuWidgetGroup`](#auwidgetgroup)

###### Inherited from

[`AuBaseSelectorWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubaseselectorwidget).[`constructor`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#constructor)

#### Properties

##### params

```ts
params: AuWidgetGroupParam;
```

Properties of the widget.

###### Overrides

[`AuBaseSelectorWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubaseselectorwidget).[`params`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#params)

##### scrollable

```ts
scrollable: boolean;
```

##### selectedIndex

```ts
selectedIndex: number = 0;
```

The index of the selected item.

##### selectedTitle

```ts
selectedTitle: string = "";
```

The title of the selected item.

##### showCustomScroll

```ts
showCustomScroll: boolean = true;
```

#### Accessors

##### \_

###### Get Signature

```ts
get _(): any;
```

Returns the selected item.

###### Returns

`any`

###### Overrides

[`AuBaseSelectorWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubaseselectorwidget).[`_`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#_)

#### Methods

##### \_getStylesByType()

```ts
_getStylesByType(type): "" | "--au-widget-height: 100%;";
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `type` | `string` |

###### Returns

`""` \| `"--au-widget-height: 100%;"`

##### checkInitDependenciesWidgets()

```ts
checkInitDependenciesWidgets(): string[];
```

Returns an array of widget names, due to which the current widget cannot receive parameters.

###### Returns

`string`[]

###### Inherited from

[`AuBaseSelectorWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubaseselectorwidget).[`checkInitDependenciesWidgets`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#checkinitdependencieswidgets)

##### clearSelection()

```ts
clearSelection(): void;
```

Sets the selected index to `-1`.

###### Returns

`void`

###### Overrides

[`AuBaseSelectorWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubaseselectorwidget).[`clearSelection`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#clearselection)

##### resetPreloaderState()

```ts
resetPreloaderState(): void;
```

###### Returns

`void`

###### Inherited from

[`AuBaseSelectorWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubaseselectorwidget).[`resetPreloaderState`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#resetpreloaderstate)

##### showPreloader()

```ts
showPreloader(
   isPreload, 
   message?, 
   timeout?): void;
```

Shows a preloader.

```
"onClick": [
  "{{#function main.showPreloader(true, 'Creating print files...')}}",
  "{{#function $['editor'].getHiResImages(800,800)}}",
  "{{#function main.showPreloader(false)}}"
]
```

###### Parameters

| Parameter | Type | Default value | Description |
| ------ | ------ | ------ | ------ |
| `isPreload` | `boolean` | `undefined` | If `true`, enables the preloader. |
| `message` | `string` \| `string`[] | `...` | A text message that appears next to the preloader. |
| `timeout` | `number` | `5` | - |

###### Returns

`void`

###### Inherited from

[`AuBaseSelectorWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubaseselectorwidget).[`showPreloader`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#showpreloader)

##### showToast()

```ts
showToast(data?, duration?): void;
```

Shows a toast.

```
return editor.loadUserInfo(data)
    .catch(err => {
        this.widget.showToast("Error: Invalid data");
        console.log(err);
    });
```

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `data?` | `string` | A string message to display in the toast. |
| `duration?` | `number` | Defines how long to show the toast for. |

###### Returns

`void`

###### Inherited from

[`AuBaseSelectorWidget`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#abstract-aubaseselectorwidget).[`showToast`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/widget.AuBaseWidget.md#showtoast)

##### updateVisibleParams()

```ts
updateVisibleParams(): void;
```

###### Returns

`void`

## References

### widget

Renames and re-exports [AuWidgetGroup](#auwidgetgroup)