au-widget-button/IButtonConfig

Interfaces

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

Properties

classStyle

classStyle: string;

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

enabled

enabled: boolean;

Defines whether the button is clickable, true or false.

icon

icon: string;

The ID of an SVG icon defined in the UI theme.

iconPosition

iconPosition: IconPosition;

Position of icon image

image

image: string;

URL to the button image.

onClick

onClick: Function | Function[];

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

text

text: string;

The button caption.

type

type: string;

The button type: text or image.

visible

visible: boolean;

Defines whether the button is visible, true or false.

Type Aliases

IconPosition

type IconPosition = "left" | "right";