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 Builder.

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 Builder 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.
Display	Select this tab to manage your component's display settings.
Data	Select this tab to manage your component's data settings.
Actions	Select this tab to manage your component's actions settings.
Validation	Select this tab to manage your component's validation settings.
Advanced	Select this tab to manage your component's advanced settings.
Permissions	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.
Field Tags	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.
Shortcuts	Select this tab to open the list of supported keyboard shortcuts you can use in the component settings modal. Keyboard shortcuts include: Cmd + S (Mac) / Ctrl + S (PC): Save and close the component settings modal. Cmd + G (Mac) / Ctrl + G (PC): Opens a search window to find specific fields and settings in the component settings modal. Tab: Tab to the next field or setting in the component settings modal. This keyboard shortcut tabs left to right and top to bottom. Shift + Tab: Tab to the previous field or setting in the component settings modal. The keyboard shortcut tabs from right to left and bottom to top. Enter (Return): When tabbing to a (tooltip), press Enter (Return) to display the field or setting tooltip. Press Enter (Return) again to hide the tooltip. Additional keyboard shortcuts: Drop-down menus: When you Tab to a settings drop-down, use the keyboard's (up)/ (down) arrows to make a selection. Then, press Enter (Return) to confirm the selection.
Documentation	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

(click to expand image)

Field Text

Setting	Description
Label Text	Canvas Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.
Placeholder Text	A short prompt telling end-users the expected value of an input field. For example: Enter your Social Security Number. Placeholder Text displays inside the input field until the end-user begins an entry.
Prefix	Alphanumeric characters append to the start of the value entered in the field. If called by another component, the prefix stores with the value.
Suffix	Alphanumeric characters that append to the end of the value entered in the field. If called by another component, the suffix stores with the value.

Contextual Help

Setting	Description
Tooltip	A short hint that displays when an end-user positions their cursor over the (Tooltip) icon. Tooltips can display across more than one line.
Helper Text	A quick tip describing the expected value of an input field. Unlike a Tooltip, Helper Text stays visible under the input field and displays on a single line.

Formatting

Setting	Description
Show Thousands Separator	The thousands separator is the comma used wherever numbers go above 999. Adding the thousands separator improves readability. It's the difference between reading 1000 and reading 1,000. By setting this toggle to (ON), a comma displays when the end-user enters any number above 999. NOTE This setting doesn't affect how the number stores in the database. By default, the Show Thousands Separator toggle is set to (OFF).
Disable Browser Autofill	Prevents the browser from autofilling the number field with the end-user's previously used values.
Currency	Use this toggle to format the value as currency, applying the Prefix, Suffix, and Thousands Separator settings. By default, the Format as Currency toggle is set to (OFF).
Currency	Displays as a drop-down list of the world's 3-letter ISO 4217 ISO 4217 defines alpha codes and numeric codes for the representation of currencies. currencies. By default, the Currency Type is set to USD.

Default State Options

Setting	Description
Hide Label	Setting the Hide Label toggle to (ON) stops Label Text from displaying in Express View. Your Label Text still displays in the Module Builder. By default, the Hide Label toggle is set to (OFF).
Disable User Input	When set to (ON), end-users can’t interact with or edit the Express View's input field or element. When end-users hover over the field, their cursor changes to alert them to the status change. By default, the Disable User Input toggle is set to (OFF).
Hide Field	Shows or hides the component from view. Setting the Hide Field toggle to (ON) hides the component in Express View. Setting the toggle to (OFF) shows the component. The component is always visible in the Module Builder. By default, the Hide Field toggle is set to (OFF).
Hide Helper Text	Stops Helper Text from displaying in Express View. By default, the Hide Helper Text toggle is set to (OFF).

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 three customization settings:

Setting	Description
Default Value	Sets the starting value for the field. By default, the value starts at 0.
Don't Allow Decimals	Setting the toggle to (ON) limits input to integers only. By default, the toggle is set to (OFF).
Decimal Places	If you allow decimal places, use this setting to limit the number of decimal places the end-user can enter.

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 six customization settings:

Setting	Description
Hide Minimum and Maximum Values	Range Sliders show the minimum value at the bottom left and the maximum value at the bottom right. Switching the Hide Minimum and Maximum Value toggle to (ON) hides both these values. By default, the Hide Minimum and Maximum Value toggle is set to (OFF).
Hide Selected Value Label	The selected value displays in the top left of the Range Slider. As the end-user moves the slider, the value counts up or down. Switching the Hide Selected Value Label toggle to (ON) hides the selected value. By default, the Hide Selected Value Label toggle is set to (OFF).
Default Value	Sets the starting value for the field. By default, the value starts at 0.
Step Increments	The Range Slider counts up or down using a scale. By default, the Step Increments are set at two.
Don't Allow Decimals	Setting the toggle to (ON) limits input to integers only. By default, the toggle is set to (OFF).
Decimal Places	If you allow decimal places, use this setting to limit the number of decimal places the end-user can enter.

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 five customization settings:

Setting	Description
Hide Minimum and Maximum Values	The selected value displays in the top left of the Stepper. As the end-user moves the slider, the value counts up or down. Switching the Hide Minimum and Maximum Values toggle to (ON) hides the selected value. By default, the Hide Minimum and Maximum Values toggle is set to (OFF).
Default Value	Sets the starting value for the field. By default, the value starts at 0.
Step Increments	The Stepper counts up or down using a scale. By default, the Step Increments are set at two.
Don't Allow Decimals	Setting the toggle to (ON) limits input to integers only. By default, the toggle is set to (OFF).
Decimal Places	If you allow decimal places, use this setting to limit the number of decimal places the end-user can enter.

Data Panel

(click to expand image)

Data Storage

Setting	Description
Store Data in Database	The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios: Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database. Triggering a module save event using a Button component with an Action Type of Save. Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database. 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 (OFF) when you don’t want to store the values from this field in the database. 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 (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.

Setting

Description

Store Data in Database

The Store Data in Database setting affects how data persists through your application. When set to Toggle On Icon (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios:

Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database.
Triggering a module save event using a Button component with an Action Type of Save.
Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database.

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 Toggle Off icon (OFF) when you don’t want to store the values from this field in the database.

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 Toggle On Icon (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.

Actions Panel

(click to expand image)

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

(click to expand image)

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 (ON), the end user must enter a value in the component's visible fields. Set the toggle to (OFF) when an entry is optional. By default, the Required toggle is set to (OFF).
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.

Setting

Description

Required Error Message

When set to Toggle On Icon (ON), the end user must enter a value in the component's visible fields. Set the toggle to Toggle Off icon (OFF) when an entry is optional.

By default, the Required toggle is set to Toggle Off icon (OFF).

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

(click to expand image)

Additional Styling

Setting

Description

Custom CSS Class

Enter a Custom CSS Cascading Style Sheets (CSS) is a style sheet language used for presenting how a HTML or XML document looks to end-users. Class to apply to your component. Use custom CSS to maintain a consistent look and feel if the field or element is part of a template or more than one module.

Updated CSS styling applies to all components that reference this custom class name.

Additional Validation Options

Setting	Description
Set Minimum/Maximum Number	Sets the lowest and/or highest value that the end-user can enter into the Number field.
Minimum/Maximum Number Error Message	An error message that displays if the end-user's input is outside of the minimum or maximum values set.

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.

Drag and drop a

Number component onto your canvas.