Skip to main content

au-widget-dnd-controller/au-widget-dnd-controller

Classes

AuWidgetDndController

The base class for widgets.

Extends

Constructors

Constructor
new AuWidgetDndController(): AuWidgetDndController;
Returns

AuWidgetDndController

Inherited from

AuBaseWidget.constructor

Properties

params
params: IDndControllerConfig;

Properties of the widget.

Overrides

AuBaseWidget.params

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

resetPreloaderState()
resetPreloaderState(): void;
Returns

void

Inherited from

AuBaseWidget.resetPreloaderState

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
ParameterTypeDefault valueDescription
isPreloadbooleanundefinedIf true, enables the preloader.
messagestring | string[]...A text message that appears next to the preloader.
timeoutnumber5-
Returns

void

Inherited from

AuBaseWidget.showPreloader

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

Shows a toast.

return editor.loadUserInfo(data)
.catch(err => {
this.widget.showToast("Error: Invalid data");
console.log(err);
});
Parameters
ParameterTypeDescription
data?stringA string message to display in the toast.
duration?numberDefines how long to show the toast for.
Returns

void

Inherited from

AuBaseWidget.showToast

References

widget

Renames and re-exports AuWidgetDndController

Was this page helpful?