1. Support
2. The Multistep Editor
3. UI Framework Reference

UI Framework Reference › IWidget

Interface: IWidget

Provides basic properties for all widgets.

{
  "widgets": [{
    "type": "option",
    "title": "Choose size",
    "name": "size-selector",
    "params": {
      "id": 0
    }
 }]
}

Hierarchy

• IWidget

Implemented by

• AuBaseSelectorWidget
• AuBaseWidget
• AuCanvas
• AuDesignEditor
• AuWidget3DViewer
• AuWidgetAjax
• AuWidgetButton
• AuWidgetCanvas
• AuWidgetCart
• AuWidgetCheckbox
• AuWidgetColorPicker
• AuWidgetDataSheet
• AuWidgetDesignAtoms
• AuWidgetDesignEditor
• AuWidgetDndController
• AuWidgetFinishButton
• AuWidgetGallery
• AuWidgetGroup
• AuWidgetHelp
• AuWidgetHtml
• AuWidgetImageCarousel
• AuWidgetInputText
• AuWidgetOption
• AuWidgetOrder
• AuWidgetPreflight
• AuWidgetSlider
• AuWidgetStaticText
• AuWidgetSteps
• AuWidgetUploader

Index

Properties

• driver
• language
• name
• title
• type

Properties

driver

• driver: IDriver

Defined in src/widgets/widget/interface/IWidget.ts:31

An e-commerce driver. For details, see Working with e-commerce drivers.

---

language

• language: string

Defined in src/widgets/widget/interface/IWidget.ts:35

The localization language (like en, fr, de, nl, ru, etc.).

---

name

• name: string

Defined in src/widgets/widget/interface/IWidget.ts:23

A unique machine-readable name.

---

title

• title: string

Defined in src/widgets/widget/interface/IWidget.ts:27

A widget title that appears in the user interface.

---

Optional type

• type? : string

Defined in src/widgets/widget/interface/IWidget.ts:39

A widget type.