au-widget-group/au-widget-group

Classes

AuWidgetGroup

A widget that is used to group multiple widgets together.

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

{
  "widgets": [
    {
      "name": "option-list",
      "type": "group",
      "params": {
        "type": "noncollapsible",
        "tabs": [
          {
            "widgets": [
              {
                "title": "Corner Type",
                "name": "corners",
                "type": "option",
                "params": { ... }
              },
              {
                "title": "Lamination",
                "name": "lamination",
                "type": "option",
                "params": { ... }
              }
            ]
          }
        ]
      }
    }
  ]
}

Extends

• AuBaseSelectorWidget

Constructors

Constructor

new AuWidgetGroup(): AuWidgetGroup;

Returns

AuWidgetGroup

Inherited from

AuBaseSelectorWidget.constructor

Properties

params

params: AuWidgetGroupParam;

Properties of the widget.

Overrides

AuBaseSelectorWidget.params

scrollable

scrollable: boolean;

selectedIndex

selectedIndex: number = 0;

The index of the selected item.

selectedTitle

selectedTitle: string = "";

The title of the selected item.

showCustomScroll

showCustomScroll: boolean = true;

Accessors

_

Get Signature

get _(): any;

Returns the selected item.

Returns

any

Overrides

AuBaseSelectorWidget._

Methods

_getStylesByType()

_getStylesByType(type): "" | "--au-widget-height: 100%;";

Parameters

Parameter	Type
type	string

Returns

"" | "--au-widget-height: 100%;"

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 selected index to -1.

Returns

void

Overrides

AuBaseSelectorWidget.clearSelection

resetPreloaderState()

resetPreloaderState(): void;

Returns

void

Inherited from

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

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

updateVisibleParams()

updateVisibleParams(): void;

Returns

void

References

widget

Renames and re-exports AuWidgetGroup