Number Input
The Number Input component allows users to enter numeric values. It can be used as a standalone component or in form fields. In this document, we'll go through all the configuration options for the Number Input component.
Properties​
Property | Description | Expected Value |
|---|---|---|
| Label | Text to display as the label for the field. | String (e.g., Age). |
| Placeholder | A hint displayed to guide the user on what to enter. | String (e.g., Enter quantity). |
| Default value | The default value that the component will hold when the app is loaded. | Number (e.g., 10). |
| Decimal places | Specifies the number of decimal places for numerical values. | Integer (e.g., 2). |
Events​
| Event | Description |
|---|---|
| On change | Triggers whenever the user types something in the input field. |
| On focus | Triggers whenever the user clicks inside the input field. |
| On blur | Triggers whenever the user clicks outside the input field. |
| On enter pressed | Triggers whenever the user presses the enter button on the keyboard after entering some text in the input field. |
info
Check Action Reference docs to get detailed information about all the Actions.
Component Specific Actions (CSA)​
The following actions of the component can be controlled using the component-specific actions (CSA), you can trigger it using an event or use a RunJS query.
Action | Description | How To Access |
|---|---|---|
| setText() | Sets the value of the input field. | components.numberinput1.setText(1) |
| clear() | Clears the entered text in the input field. | components.numberinput1.clear() |
| setFocus() | Sets the focus of the cursor on the input field. | components.numberinput1.setFocus() |
| setBlur() | Removes the focus of the cursor from the input field. | components.numberinput1.setBlur() |
| setVisibility() | Sets the visibility of the component. | components.numberinput1.setVisibility(false) |
| setLoading() | Sets the loading state of the component. | components.numberinput1.setLoading(true) |
| setDisable() | Disables the component. | components.numberinput1.setDisable(true) |
info
Check the component specific actions available for this component here.
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
| value | Holds the value entered by the user in the component. | {{components.numberinput1.value}} |
| label | Holds the value of the component's label. | {{components.numberinput1.label}} |
| isValid | Indicates if the input meets validation criteria. | {{components.numberinput1.isValid}} |
| isMandatory | Indicates if the field is required. | {{components.numberinput1.isMandatory}} |
| isLoading | Indicates if the component is loading. | {{components.numberinput1.isLoading}} |
| isVisible | Indicates if the component is visible. | {{components.numberinput1.isVisible}} |
| isDisabled | Indicates if the component is disabled. | {{components.numberinput1.isDisabled}} |
Validation​
Validation Option | Description | Expected Value |
|---|---|---|
| Make this field mandatory | Displays a 'Field cannot be empty' message if no value is entered. | Enable/disable the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
| Regex | Regular Expression to validate the input. | Regular Expression Pattern (e.g., ^\d{10}$). |
| Min value | Sets the minimum value allowed. | Integer (e.g., 10 for a minimum value of 10). |
| Max value | Sets the maximum value allowed. | Integer (e.g., 1000 for a maximum value of 1000). |
| Custom validation | Specifies a validation error message for specific conditions. | Logical Expression (e.g., {{components.numberinput1.value<5&&"Value needs to be at least 5"}}). |
To add regex inside Custom Validation, you can use the below format:
Format: {{(<regexPattern>.test(<value>)) ? '' : 'Error message';}}
Example: {{(/^\d{1,10}$/.test(components.numberinput1.value)) ? '' : 'Error message';}}
Additional Actions​
Action | Description | Configuration Options |
|---|---|---|
| Enable clear button | Shows a clear button inside the field while it has a value. Clicking it clears the value. The button is hidden while the component is disabled or loading. | Enable/disable the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
| Loading state | Enables a loading spinner, often used with isLoading to indicate progress. Toggle or set dynamically. | Enable/disable the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
| Visibility | Controls component visibility. Toggle or set dynamically. | Enable/disable the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
| Collapse when hidden | Collapses the component's space when it is hidden, so surrounding components fill the space. Takes effect when the app runs (preview or released app), not on the editor canvas. | Enable/disable the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
| Disable | Enables or disables the component. Toggle or set dynamically. | Enable/disable the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
| Tooltip | Provides additional information on hover. Supports Plain text, Markdown, and HTML formats. | String (e.g., Enter your age here. ). |
| Disable step controls | Hides the increment/decrement arrows and prevents the value from changing on scroll or with the up/down arrow keys. Toggle or set dynamically. | Enable/disable the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
Devices​
Property | Description | Expected Value |
|---|---|---|
| Show on desktop | Makes the component visible in desktop view. | You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
| Show on mobile | Makes the component visible in mobile view. | You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression. |
Styles​
Label​
Label Property | Description | Configuration Options |
|---|---|---|
| Text | Sets the color of the component's label. | Select the color or click on fx and input code that programmatically returns a Hex color code. |
| Size | Sets the font size of the label, in pixels. Defaults to 12. | Enter a number or click on fx and enter code that returns a number. |
| Alignment | Sets the position of the label and input field. | Click on the toggle options or click on fx to input code that programmatically returns an alignment value - side or top. |
| Direction | When alignment is set to side, places the label to the left or right of the field. | Select Left or Right using the icon toggles. |
| Width | Sets the width of the input field. | Enable Auto width to use the standard width automatically. Disable it to manually adjust the width using the slider or by entering a numeric value via fx. You can also choose whether the width is calculated relative to the Container or relative to the Field. |
Field​
Field Property | Description | Configuration Options |
|---|---|---|
| Background | Sets the background color of the component. | Select the color or click on fx and input code that programmatically returns a Hex color code. |
| Border | Sets the border color of the component. | Select the color or click on fx and input code that programmatically returns a Hex color code. |
| Accent | Sets the border color of the field while it is focused. A validation error border takes priority. | Select the color or click on fx and input code that programmatically returns a Hex color code. |
| Text | Sets the color of the number entered in the component. | Select the color or click on fx and input code that programmatically returns a Hex color code. |
| Placeholder text | Sets the color of the placeholder text displayed when the field is empty. | Select the color or click on fx and input code that programmatically returns a Hex color code. |
| Error text | Sets the text color of validation message that displays. | Select the color or click on fx and input code that programmatically returns a Hex color code. |
| Icon | Allows you to select an icon for the component. | Enable the icon visibility, select icon and icon color. Alternatively, you can programmatically set it using fx. |
| Border radius | Modifies the border radius of the component. | Enter a number or click on fx and enter a code that programmatically returns a numeric value. |
| Box shadow | Sets the box shadow properties of the component. | Select the box shadow color and adjust the related properties or programmatically set it using fx. |
Container​
Container Property | Description | Configuration Options |
|---|---|---|
| Padding | Sets the padding around the component. | Choose Default to keep the standard padding or None to remove it. |
Advanced​
Property | Description | Configuration Options |
|---|---|---|
| CSS class | Adds a custom CSS class to the component, which can be targeted using Custom Styles for advanced styling. | Enter one or more class names. |
info
The Advanced section is available only if your plan has the Custom Styles feature enabled.
Deprecated styles​
Property | Description | Configuration Options |
|---|---|---|
| Legacy input size | Keeps the canvas sizing that input components used before this setting was added. When on, a top-aligned label always adds height to the component, even when the label is empty, and the component's height doesn't change when the label alignment is set with fx. When off, a top-aligned label adds height only when the label has text. | Enable/disable the toggle button. Off for new components. Turned on for components that existed before this setting was added, including components in imported apps. |