au-widget-checkbox/au-widget-checkbox

Classes

AuWidgetCheckbox

A widget that adds a checkbox.

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

{
  "widgets": [
    {
      "name": "agree-checkbox",
      "type": "checkbox",
      "params": {
        "prompt": "I approve the design.",
        "autoReset": true,
        "value": true
      }
    }
  ]
}

Extends

• AuBaseSelectorWidget

Implements

• IRestorableWidget

Constructors

Constructor

new AuWidgetCheckbox(): AuWidgetCheckbox;

Returns

AuWidgetCheckbox

Inherited from

AuBaseSelectorWidget.constructor

Properties

params

params: ICheckboxConfig;

Properties of the widget.

Overrides

AuBaseSelectorWidget.params

value

value: boolean = false;

Accessors

_

Get Signature

get _(): boolean;

Returns the checkbox value.

Returns

boolean

Overrides

AuBaseSelectorWidget._

Methods

checkInitDependenciesWidgets()

checkInitDependenciesWidgets(): string[];

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

Returns

string[]

Inherited from

AuBaseSelectorWidget.checkInitDependenciesWidgets

clearSelection()

clearSelection(): void;

Sets the checkbox value to false.

Returns

void

Overrides

AuBaseSelectorWidget.clearSelection

exportWidgetData()

exportWidgetData(force): Promise<CheckboxData>;

Parameters

Parameter	Type
force	boolean

Returns

Promise<CheckboxData>

Implementation of

IRestorableWidget.exportWidgetData

resetPreloaderState()

resetPreloaderState(): void;

Returns

void

Inherited from

AuBaseSelectorWidget.resetPreloaderState

restoreWidgetFromData()

restoreWidgetFromData(widgetData, force): Promise<void>;

Parameters

Parameter	Type
widgetData	CheckboxData
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

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

AuBaseSelectorWidget.showToast

References

widget

Renames and re-exports AuWidgetCheckbox