Button UI Element
Description
Displays a button.
May be used by
Properties
Label (
label) Description
Label for the button. The UI treats it as a key to translate. If there is no translation, the configured value is what is shown in the UI.
Attributes
String
Mandatory
Validation RegEx: [a-zA-Z0-9]+((\.|-)[a-zA-Z0-9]+)*
Disabled On Validation Errors (
disabledOnValidationErrors) Description
If checked, the button is not clickable if the form that contains the button has validation errors. The setting is ignored if the button is not part of a form.
Attributes
Boolean
Optional
Default value
true
Disabled With No Changes (
disabledWithNoChanges) Description
If checked, the button is not clickable if the form's content did not change. The setting is ignored if the button is not part of a form.
Attributes
Boolean
Optional
Default value
true
Alignment (
alignment) Description
Defines the button's alignment.
Attributes
Enum
Optional
Default value
RIGHT
Submit (
submit) Description
If checked, the button is of type 'submit', otherwise the type is 'button'.
Attributes
Boolean
Optional
Default value
false
On Click (
onClick) Description
The REST API calls to execute in sequence when clicking the button.
Attributes
Plugin-List
Optional
Assignable plugins
HTML ID (
htmlId) Description
The ID of the element in the HTML.
Attributes
String
Optional
Validation RegEx: [a-zA-Z0-9_]+
YAML Template (with default values)
type: ConfigurableUiButton
id: ConfigurableUiButton-xxxxxx
displayName:
comment:
properties:
alignment: RIGHT
disabledOnValidationErrors: true
disabledWithNoChanges: true
htmlId:
label:
onClick:
submit: false