Number Component
Estimated Reading Time: 6 minutes
Overview
The Number component is part of our core range of input components. Number fields can collect number values such as integers, decimals, or percentages. Unlike Text Field components, an end-user End-Users are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. can only input numbers into this field.
Number components offers these interaction types:
-
Field: A simple text box.
-
Range Slider: A horizontal slider.
-
Stepper: Uses +/- symbols to scroll through number values.
You can also format your Number component for a specific currency. The full list of world currencies is available from the component's configuration window.
You'll find the Number component in the Primary Fields group to the left of the Module Editor.
What You'll Learn
After completing this article, you’ll know when to use a Number component, how to configure its settings, and how to use it in an Unqork application.
About the Configuration Window
Once you drop a component onto the Module Editor canvas, the following settings windows display:
General
Setting |
Description |
---|---|
Property ID |
A Property ID is the unique field ID used by Unqork to track and link components in your module. The Property ID is how the software identifies your component. Using Property IDs lets you link components, creating logic-based configurations and API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. calls. Property IDs must use camel case A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. (stylized as camelCase) without spaces or punctuation. |
Notes |
Select this tab to display the component's Notes area. You can use notes to keep your teammates informed. The Notes editor offers a semi-WYSIWYG (What You See is What You Get) content editor. Built to look like a word processor, this editor lets you create, edit, and format your notes. Notes save when saving the component. |
|
Select this tab to manage your component's display settings. |
|
Select this tab to manage your component's data settings. |
|
Select this tab to manage your component's actions settings. |
|
Select this tab to manage your component's validation settings. |
|
Select this tab to manage your component's advanced settings. |
|
Select this tab to see the RBAC RBAC (Role-Based Access Control) is a method to control system access for authorized users. The role in RBAC refers to the levels of access employees have to a network. (role-based access control) settings of the component. |
|
Assign components one-word labels to help organize, identify, and group the components in your application. Consider an example from the API Specification Snippet: Field Tags are applied to Hidden components in the panelRequest and panelResponse Panels. The Field Tags identify the data type of parameters included in the API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. request and response. The API Docs Dashboard tool populates with information about each parameter’s data type, identified by the Field Tag. Field Tags act as a type of Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. group and let you group components for configuration purposes. Field Tags let you target two or more components using a simple logic component. For example, add the Field Tag tagForDecision to multiple components in your module. Open the Inputs table of a Decisions component and reference the tagForDecision Field Tag as the input of the Decisions component. The output of the Decisions component then affects all components with the tagForDecision Field Tag. Save your Field Tags by pressing Enter (Return) or adding a comma after each entry. |
|
Select this tab to open the list of supported keyboard shortcuts you can use in the component settings modal. Keyboard shortcuts include:
Additional keyboard shortcuts:
|
|
Select this tab to access the component documentation in Unqork's In-Product Help. |
Cancel |
Click this button to undo any unsaved configuration changes and return to the canvas. |
Save & Close |
Click this button to save all settings as configured and return to the canvas. |
Display Panel
Field Text
|
Contextual Help
Formatting
|
Default State Options
Setting |
Description |
---|---|
Hide Label |
Setting the Hide Label toggle to By default, the Hide Label toggle is set to |
Disable User Input |
When set to By default, the Disable User Input toggle is set to |
Hide Field |
Shows or hides the component from view. Setting the Hide Field toggle to By default, the Hide Field toggle is set to |
Hide Helper Text |
Stops Helper Text from displaying in Express View. By default, the Hide Helper Text toggle is set to |
Interaction Type
Sets the styling that the end-user sees applied to the Number field. Number components can have Field, Range Slider, or Stepper styling applied.
By default, the Interaction Type is set to Field.
Type |
Description |
||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Field |
The Field Interaction Type displays the field as a simple text box. The end-user enters the value directly into the field. The Field Interaction Type has 3 customization settings:
|
||||||||||||||
Range Slider |
The Range Slider Interaction Type displays the field as a horizontal slider. The end-user moves the slider to the left or to the right to set its value. The selected value shows at the top left of the Range Slider. The Range Slider has 6 customization settings:
|
||||||||||||||
Stepper |
The Stepper Interaction Type displays the field as a value with a plus (+) and minus (-) button on either side. The end-user clicks the plus or minus to select their value. The selected value displays in the center of the field. The Stepper has 5 customization settings:
|
Data Panel
Data Storage
Setting |
Description |
---|---|
Store Data in Database |
The Store Data in Database setting affects how data persists through your application. When set to
NOTE By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission. Set the toggle to NOTE When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response. To learn more about Store Data in Database in the context of API modules, see the panelResponse Panel section of the API Specification Snippet article in our In-Product Help. TIP Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to |
Actions Panel
Triggers
Setting |
Description |
---|---|
Trigger |
To set up a trigger, enter the Property ID of your chosen logic component into this field. When the end-user performs an action on the current component, the triggered component fires. |
Validation Panel
Valid Number
Setting |
Description |
---|---|
Number Error Message |
The error message that displays when an end-user enters a value that isn't a number. |
User Input
Setting |
Description |
---|---|
Required Error Message |
When set to By default, the Required toggle is set to |
Required Error Message |
A custom error message that displays below a required field. The error message displays when the end-user tries to save or submit the module without completing the required field. |
Advanced Panel
Additional Styling
|
Additional Validation Options
|
Adding a Number Component
As an example, you'll configure a Number component to ask a question about salary requirements. The component uses a currency format. Additionally, it limits the number of decimals the end-user can enter to two. These instructions assume that you have an open module saved with a title.
1. | Drag and drop a ![]() |
2. | In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter salary. |
3. | In the Label Text Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. field, enter What is your salary requirement? |
4. | Set the Currency Formats the value as currency, applying the Prefix, Suffix, and Thousands Separator settings. toggle to ![]() |
5. | In the Decimal Places If you allow decimal places, use this setting to limit the number of decimal places the end-user can enter. field, enter 2. |
6. | Click Save & Close. |
7. | Save your module. |
Preview your module in Express View Express View is how your end-user views you application. Express View also lets you preview your applications to test your configuration and view the styling. After configuring a module, click Preview in the Module Editor to interact with the module in Express View. You'll see the following functionality:
Resources