UI Framework ReferenceIButtonConfig

Interface: IButtonConfig

Provides button properties.

The following example illustrates how you can define a button that navigates to the next step in the editor.

{
  "widgets": [
   {
     "type": "button",
     "name": "next-btn",
     "params": {
       "text": "Next",
       "onClick": "{{#function main.nextStep()}}",
       "classStyle": "primary"
     }
   }
 ]
}

Hierarchy

  • IButtonConfig

Index

Properties

Properties

classStyle

classStyle: string

Defined in src/widgets/au-widget-button/IButtonConfig.ts:25

The button style. The following styles are available: primary, success, warning, and danger.


enabled

enabled: boolean

Defined in src/widgets/au-widget-button/IButtonConfig.ts:29

Defines whether the button is clickable, true or false.


onClick

onClick: Function | Array‹Function›

Defined in src/widgets/au-widget-button/IButtonConfig.ts:27

A single function or an array of functions that will be executed when the button is clicked.


text

text: string

Defined in src/widgets/au-widget-button/IButtonConfig.ts:23

The button caption.


visible

visible: boolean

Defined in src/widgets/au-widget-button/IButtonConfig.ts:31

Defines whether the button is visible, true or false.