au-widget-button/au-widget-button

Classes

AuWidgetButton

A widget that represents a button.

For details, you can refer to the Button widget topic.

The following example illustrates how you can define a button for adding logs to the console.

{
  "widgets": [
    {
      "type": "button",
      "name": "console-log",
      "params": {
        "text": "hello",
        "classStyle": "success",
        "onClick": "{{#function console.log('Hello world!');}}",
        "enabled": true,
        "visible": true
      }
    }
  ]
}

Extends

• AuBaseWidget

Constructors

Constructor

new AuWidgetButton(): AuWidgetButton;

Returns

AuWidgetButton

Inherited from

AuBaseWidget.constructor

Properties

params

params: IButtonConfig;

Button properties.

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

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

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.showToast

References

widget

Renames and re-exports AuWidgetButton