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

Package: ui-framework

Properties

classStyle

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

Declaration

classStyle: string

Property Value

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

enabled

Defines whether the button is clickable, true or false.

Declaration

enabled: boolean

Property Value

Type	Description
boolean	Defines whether the button is clickable, true or false.

icon

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

Declaration

icon: string

Property Value

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

iconPosition

Position of icon image

Declaration

iconPosition: IconPosition

Property Value

Type	Description
IconPosition	Position of icon image

image

URL to the button image.

Declaration

image: string

Property Value

Type	Description
string	URL to the button image.

onClick

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

Declaration

onClick: Function | Array<Function>

Property Value

Type	Description
Function | Array<Function>	A single function or an array of functions that will be executed when the button is clicked.

text

The button caption.

Declaration

text: string

Property Value

Type	Description
string	The button caption.

type

The button type: text or image.

Declaration

type: string

Property Value

Type	Description
string	The button type: text or image.

visible

Defines whether the button is visible, true or false.

Declaration

visible: boolean

Property Value

Type	Description
boolean	Defines whether the button is visible, true or false.