Class: AuWidgetInputText

A widget representing a text input field.

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

{
  "widgets": [
    {
      {
        "name": "quantity-selector",
        "type": "input-text",
        "title": "How many cards?",
        "params": {
          "prompt": "Select quantity",
          "defaultValue": "{{ Math.max(order.quantity, 25) }}",
          "type": "number",
          "min": 25
        }
      }
    }
  ]
}

Hierarchy

↳ AuBaseSelectorWidget

↳ AuWidgetInputText

Implements

Index

Properties

Accessors

_
invalid

Methods

Properties

defaultValue

• defaultValue: string | number

The default value.

params

• params: IInputTextConfig

Overrides AuBaseWidget.params

Properties of the widget.

paramsRaw

• paramsRaw: any

Inherited from AuBaseWidget.paramsRaw

Uncompiled widget configuration.

value

• value: string | number

The current value.

Accessors

_

• get _(): string | number

Overrides AuBaseSelectorWidget._

Returns:string | number

invalid

• get invalid(): any

Returns:any

Methods

addCustomStyles

▸ addCustomStyles(params: any): void

Inherited from AuBaseWidget.addCustomStyles

Applies new styles to a widget.

Parameters:

Name	Type
`params`	any

Returns:void

clearSelection

▸ clearSelection(): void

Overrides AuBaseSelectorWidget.clearSelection

Returns:void

compile

▸ compile(additionalParam: any): Promise‹any›

Inherited from AuBaseWidget.compile

Compiles the widget config.

"steps": [{
  "name": "card-size",
  "title": "Step 1. Card Options",
  "description": "Choose a card size.",
  "toolPanel": {
    "name": "options"
  },
  "onActivate": [
    "{{#function $['logo'].compile() }}"
  ]
},
...

Parameters:

Name	Type	Default	Description
`additionalParam`	any		Parameters for widget config compilation.

Returns:Promise‹any›

The compiled widget configuration.

emitChange

▸ emitChange(data: any, forceRecompile: boolean): void

Inherited from AuBaseWidget.emitChange

Sends a message about the widget state changes.

"steps": [{
  "name": "card-size",
  "title": "Step 1. Card Options",
  "description": "Choose a card size.",
  "toolPanel": {
    "name": "options"
  },
  "onActivate": [
    "{{#function $['options'].emitChange()}}"
  ]
},
...

Parameters:

Name	Type	Default	Description
`data`	any		Data for updating the widget.
`forceRecompile`	boolean	false	If `true`, runs widget recompilation to apply the updated parameters.

Returns:void

exportWidgetData

▸ exportWidgetData(force: boolean): Promise‹InputTextData›

Implementation of IRestorableWidget

Parameters:

Name	Type
`force`	boolean

Returns:Promise‹InputTextData›

restoreWidgetFromData

▸ restoreWidgetFromData(widgetData: InputTextData, force: boolean): Promise‹void›

Parameters:

Name	Type
`widgetData`	InputTextData
`force`	boolean

Returns:Promise‹void›

showPreloader

▸ showPreloader(isPreload: boolean, message: string): void

Inherited from AuBaseWidget.showPreloader

Shows a preloader.

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

Parameters:

Name	Type	Default	Description
`isPreload`	boolean	-	If `true`, enables the preloader.
`message`	string	undefined	A text message that appears next to the preloader.

Returns:void

showToast

▸ showToast(data?: string, duration?: number): void

Inherited from AuBaseWidget.showToast

Shows a toast.

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

Parameters:

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

Returns:void