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

# au-widget-design-editor/AuDesignEditor

> The base class for the [`DesignEditor`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-design-editor.au-widget-design-editor.md#auwidgetdesigneditor) widget.

## Classes

### `abstract` AuDesignEditor

#### Extends

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

#### Extended by

- [`AuWidgetDesignEditor`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-design-editor.au-widget-design-editor.md#auwidgetdesigneditor)

#### Constructors

##### Constructor

```ts
new AuDesignEditor(): AuDesignEditor;
```

###### Returns

[`AuDesignEditor`](#abstract-audesigneditor)

###### Inherited from

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

#### Properties

##### params

```ts
params: any;
```

Compiled widget configuration.

###### Inherited from

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

#### Methods

##### checkInitDependenciesWidgets()

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

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

###### Returns

`string`[]

###### Inherited from

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

##### colorToHex()

```ts
colorToHex(color): Promise<string>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `color` | `Color` |

###### Returns

`Promise`\<`string`\>

##### getDesignEditorItemModel()

```ts
getDesignEditorItemModel(item): Promise<DesignEditorItemChanges>;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `item` | `any` |

###### Returns

`Promise`\<`DesignEditorItemChanges`\>

##### getEditor()

```ts
getEditor(): Promise<Editor>;
```

Returns a promise with an instance of the `DesignEditor`.

###### Returns

`Promise`\<`Editor`\>

##### getProduct()

```ts
getProduct(): Promise<Product>;
```

Returns a promise with the product opened in the `DesignEditor`.

###### Returns

`Promise`\<`Product`\>

##### resetPreloaderState()

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

###### Returns

`void`

###### Inherited from

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

##### 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

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

##### 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

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