Input
Collaborate with us
Edit this page on GitHub
Field that holds the data typed by the user.
At runtime, the value typed by the user is validated against the variable data type.
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 | ||
| Variable | Holds the value entered by the user. | Yes | ||
| Prompt | Text hint that describes the expected value for the input. Hides when the field has focus or is no longer empty. | |||
| Input Type | Input element type. Allows a better input control and extra functionality. | Yes | Text | Available types: Text, Password, Number, Time, Date, Date Time, Phone, Email, Search. |
| Max. Length | Maximum number of characters allowed. | 50 | ||
| Mandatory | Boolean literal or expression that defines if the widget is required. | Yes | False | |
| Enabled | Boolean literal or expression that defines if the widget is editable. | True | ||
| Style Classes | Specifies one or more style classes to apply to the widget. Separate multiple values with spaces. | "form-control" | ||
| 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 Change | Screen action to be executed or a screen to navigate to when the value of the element changes. | ||
| 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 | |
| Valid | False when required inputs are not present or the input value does not comply with the defined data type. You can override this property value when performing custom validations. | Boolean | ||
| ValidationMessage | Message describing the built-in validation constraints not satisfied when 'Valid' is False. You can override this property value when performing custom validations. | Text |
Additional Notes
Rendering Empty Values
If a variable associated with an Input widget doesn't have a defined value, the widget will be rendered by default with no content.
If you would like to show the default value for the associated variable type (e.g. show "0" in the widget for a variable of type Integer) when there's no defined value for the variable, add the following custom attribute to the widget in the properties editor:
- Property: show-default-value
Value: true