Button
Collaborate with us
Edit this page on GitHub
Provides a button that users can click or tap to trigger an action, submit data or navigate to another screen.
If the button belongs to a form with some input fields, the button submits the information if you set Is Form Default property to Yes in the Button Widget. This is useful when you have several buttons in your form.
Properties
| Name | Description | Mandatory | Default value | Observations |
|---|---|---|---|---|
| Name | Identifies an element in the scope where it is defined, like a screen, action, or module. | Yes | ||
| Confirmation Message | Text literal or expression to define the confirmation message displayed after clicking this widget. | |||
| Enabled | Boolean literal or expression that defines if the widget is editable. | True | ||
| Is Form Default | Boolean to specify if the button should submit form that is enclosed in. | No | The entry will redirect to the screen it points to. | |
| Visible | Boolean literal or expression that defines if the widget is displayed. | Yes | True | |
| Style Classes | Specifies one or more style classes to apply to the widget. Separate multiple values with spaces. | "btn" | The first button dragged to the screen or to the form will have an additional style class 'btn-primary'. | |
| Attributes | ||||
| Property | Name of an attribute to add to the HTML translation for this element. | You can pick a property from the drop-down list or type a free text. The name of the property will not be validated by the platform. Duplicated properties are not allowed. Spaces, " or ' are also not allowed. |
||
| Value | Value of the attribute. | You can type the value directly or write expressions using the Expression Editor. If the Value is empty, the corresponding HTML tag is created as property="property". For example, the nowrap property does not require a value, therefore nowrap="nowrap" is added. |
||
Events
| Name | Description | Mandatory | Observations |
|---|---|---|---|
| On Click | Screen action to be executed or a screen to navigate to when the widget is clicked. | Yes | |
| Built-in Validations | Set to Yes to enable built-in validations for widgets that share the same form or screen with this widget. | ||
| Transition | Transition effect applied when navigating to another screen. | By default defined at module level. | |
| Event | JavaScript or custom event to be handled. | ||
| Handler | JavaScript event handler. |
Runtime Properties
| Name | Description | Read Only | Type | Observations |
|---|---|---|---|---|
| Id | Identifies the widget instance at runtime (HTML 'id' attribute). You can use it in JavaScript and Extended Properties. | Yes | Text |