Class 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
      }
    }
  ]
}

Package: ui-framework

Properties

params

Properties of the widget.

Declaration

params: ICheckboxConfig

Property Value

Type	Description
ICheckboxConfig	Properties of the widget.

value

Declaration

value: boolean = false

Property Value

Type	Description
boolean

Methods

checkInitDependenciesWidgets()

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

Declaration

function checkInitDependenciesWidgets()

Returns

Type	Description
string[]

clearSelection()

Sets the checkbox value to false.

Declaration

function clearSelection()

exportWidgetData(boolean)

Declaration

function exportWidgetData(force: boolean)

Parameters

Type	Name	Description
boolean	force

Returns

Type	Description
Promise<CheckboxData>

resetPreloaderState()

Declaration

function resetPreloaderState()

restoreWidgetFromData(CheckboxData, boolean)

Declaration

function restoreWidgetFromData(widgetData: CheckboxData, force: boolean)

Parameters

Type	Name	Description
CheckboxData	widgetData
boolean	force

Returns

Type	Description
Promise<void>

showPreloader(boolean, string | string[], number)

Shows a preloader.

"onClick": [
  "{{#function main.showPreloader(true, 'Creating print files...')}}",
  "{{#function $['editor'].getHiResImages(800,800)}}",
  "{{#function main.showPreloader(false)}}"
]

Declaration

function showPreloader(isPreload: boolean, message: string | string[], timeout: number)

Parameters

Type	Name	Description
boolean	isPreload	If true, enables the preloader.
string | string[]	message	A text message that appears next to the preloader.
number	timeout

showToast(string, number)

Shows a toast.

return editor.loadUserInfo(data)
    .catch(err => {
        this.widget.showToast("Error: Invalid data");
        console.log(err);
    });

Declaration

function showToast(data?: string, duration?: number)

Parameters

Type	Name	Description
string	data	A string message to display in the toast.
number	duration	Defines how long to show the toast for.