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

# au-widget-option/AuAbsrtactOption

> Declares methods used to retrieve the selected value in a widget and clear the selection.

## Classes

### AuAbstractOption

#### Extends

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

#### Extended by

- [`AuWidgetOption`](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-option.au-widget-option.md#auwidgetoption)

#### Constructors

##### Constructor

```ts
new AuAbstractOption(): AuAbstractOption;
```

###### Returns

[`AuAbstractOption`](#auabstractoption)

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

##### \_definitionPromise

```ts
_definitionPromise: Promise<any>;
```

##### \_firstTimeInit

```ts
_firstTimeInit: boolean = true;
```

##### \_onChange

```ts
_onChange: Function;
```

##### element

```ts
element: AuOptionBase;
```

An option obtained from the e-commerce driver.

##### order

```ts
order: IOrder;
```

An order obtained from the e-commerce driver.

##### params

```ts
params: any;
```

Compiled widget configuration.

###### Inherited from

[`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)

##### placeholderText

```ts
placeholderText: string;
```

#### Accessors

##### \_

###### Get Signature

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

Returns the selected value.

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

##### selected

###### Get Signature

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

Returns the selected value.

###### Returns

`any`

#### Methods

##### \_manageEmptyValuesText()

```ts
_manageEmptyValuesText(applyEmptyValues): void;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `applyEmptyValues` | `boolean` |

###### Returns

`void`

##### 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 value of the option to `null`.

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

## Interfaces

### IWidgetOptionValue

Provides a property to handle an option selection.

#### Extends

- `unknown`

#### Properties

##### onSelect

```ts
onSelect: Function;
```

A single function that will be executed when the user selects a value.

## References

### default

Renames and re-exports [AuAbstractOption](#auabstractoption)