Number Component

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

Select the settings tab below to see the settings category.

Display Pane

Field Text

Setting	Description
Label Text	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.

Default State Options

Setting	Description
Hide Label	Setting the Hide Label to (ON) hides Label Text from displaying in Express View. Your Label Text still displays in the Module Builder. By default, this setting is set to (OFF).
Disable User Input	When set to (ON), end-users cannot 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, Disable User Input is set to (OFF).
Hide Field	Displays or hides the component from view. Setting Hide Field to (ON) hides the component in Express View. Setting it to (OFF) displays the component. The component is always visible in the Module Builder. By default, Hide Field 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).
Disable Browser Autocomplete	Prevents the browser from auto-completing the number field with the end-user's previously used values.

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.

When set to (ON), a comma displays when the end-user enters any number above 999.

This setting does not affect how the number stores in the database.

By default, Show Thousands Separator is set to (OFF).

Currency

Use this setting to format the value as currency, applying the Prefix, Suffix, and Thousands Separator settings.

By default, Format as Currency is set to (OFF).

This setting only supports currency formats with comma separators after every three digits.

Currency Type

Displays as a drop-down list of the world's three-letter ISO 4217 currencies.

By default, Currency Type is set to USD.

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.

Inline image showing a selected radio button. 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 to (ON) limits input to integers only. By default, the setting 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.

Inline image showing a selected radio button. 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. Setting Hide Minimum and Maximum Value to (ON) hides both these values. By default, Hide Minimum and Maximum Value 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. Setting Hide Selected Value Label to (ON) hides the selected value. By default, Hide Selected Value Label 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 value is set at two.
Don't Allow Decimals	Setting to (ON) limits input to integers only. By default, the setting 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.

Inline image showing a selected radio button. 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. Setting Hide Minimum and Maximum Values to (ON) hides the selected value. By default, Hide Minimum and Maximum Values 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 value set at two.
Don't Allow Decimals	Setting to (ON) limits input to integers only. By default, the setting 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.

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

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

When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional.

By default, Required 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.

Advanced Panel

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.

Additional Styling

Setting	Description
Custom CSS Class	Enter a Custom CSS Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules. Updated CSS styling applies to all components that reference this custom class name.

Setting

Description

Custom CSS Class

Enter a Custom CSS Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules.

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

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.

In the Property ID field, enter salary.

In the Label Text field, enter What is your salary requirement?

Set the Currency toggle to

(ON).

In the Decimal Places field, enter 2.

Click Save Component.

Save your module.

Preview your module in Express View. You'll see the following functionality:

Number Component

Overview

What You'll Learn

About the Configuration Window