au-widget-variant-selector/au-widget-variant-selector
Classes
AuWidgetVariantSelector
Provides methods for saving and restoring widget data.
Extends
Implements
Constructors
Constructor
new AuWidgetVariantSelector(): AuWidgetVariantSelector;
Returns
Inherited from
Properties
onDoubleClick
onDoubleClick: Function = null;
params
params: any;
Compiled widget configuration.
Inherited from
selectedVariant
selectedVariant: ProductVariantDesign;
Methods
checkInitDependenciesWidgets()
checkInitDependenciesWidgets(): string[];
Returns an array of widget names, due to which the current widget cannot receive parameters.
Returns
string[]
Inherited from
AuBaseWidget.checkInitDependenciesWidgets
exportWidgetData()
exportWidgetData(force): Promise<VariantSelectorData>;
Parameters
| Parameter | Type |
|---|---|
force | boolean |
Returns
Promise<VariantSelectorData>
Implementation of
IRestorableWidget.exportWidgetData
resetPreloaderState()
resetPreloaderState(): void;
Returns
void
Inherited from
AuBaseWidget.resetPreloaderState
restoreWidgetFromData()
restoreWidgetFromData(data, force): Promise<void>;
Parameters
| Parameter | Type |
|---|---|
data | VariantSelectorData |
force | boolean |
Returns
Promise<void>
Implementation of
IRestorableWidget.restoreWidgetFromData
showPreloader()
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
showToast()
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
References
widget
Renames and re-exports AuWidgetVariantSelector