Vega Search Select Component

UDesigner

Classic Designer

Overview

The Search Select component is a Primary Fields component that lets end-users search for, or select, one or more options from a drop-down list. Unlike the Simple Select component, end-users can enter a value into the field and the drop-down list filters options to match that value. End-users then use the arrow keys or their mouse to select an option from the filtered list.

By default, the Search Select component remains collapsed until the end-user clicks it. After making a selection, the list closes again.

You'll find the Search Select component in the Primary Fields group to the left of the Module Builder.

About the Configuration Window

To learn more about general component settings and those that display when a component is associated with Data Models, view our General Component Settings article.

Display

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.

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.

Formatting

Setting	Description
Allow Multiple Selections	When set to (ON), end-users can select multiple options from the drop-down. Each time the end-user clicks an option, its added to the field.
Allow Option Creation	When set to (ON), end-users can manually add option values in Express View. End-users enter text in the component's value field to create a new option from the list. End-users then submit this new option by pressing Enter (Return) on their keyboard. This setting applies even if Allow Multiple Selections is set to (ON) Consider the following limitations: End-users might submit duplicate values. Enabling the setting using the Operations Builder does not update the options.
Render Select Menu as Portal	When set to (ON), in Express View, the search select field is rendered in the HTML body of the DOM. When set to (OFF), the Search Select field nests in its parent container. By default this setting is (ON).

Setting

Description

Allow Multiple Selections

When set to (ON), end-users can select multiple options from the drop-down. Each time the end-user clicks an option, its added to the field.

Allow Option Creation

When set to (ON), end-users can manually add option values in Express View. End-users enter text in the component's value field to create a new option from the list. End-users then submit this new option by pressing Enter (Return) on their keyboard.

This setting applies even if Allow Multiple Selections is set to (ON)

Consider the following limitations:

End-users might submit duplicate values.
Enabling the setting using the Operations Builder does not update the options.

Render Select Menu as Portal

When set to (ON), in Express View, the search select field is rendered in the HTML body of the DOM. When set to (OFF), the Search Select field nests in its parent container.

By default this setting is (ON).

Data

Store Data in Database

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.

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.

Data Source Type

Values

Selecting Values displays a table where you can enter each option and its value.

Setting	Description
Label	Enter the text that displays to the end-user. When an end-user clicks the text, the Action setting fires.
Value	Create a key value for targeting the option. For example, if you have three options in your menu, you could assign the following keys: `menu1`, `menu2`, `menu3`.

Setting

Description

Label

Enter the text that displays to the end-user. When an end-user clicks the text, the Action setting fires.

Value

Create a key value for targeting the option. For example, if you have three options in your menu, you could assign the following keys: menu1, menu2, menu3.

Adding a Search Select Component

You'll configure a Search Select component to collect an end-user's cat type preference. You'll configure eight options for end-users to select.

These instructions assume that you have an open module saved with a title.

In the Module Builder, drag and drop a Search Select component onto the canvas.
In the Property ID field, enter catType.
In the Label Text field, enter What is your favorite cat breed?.
In the component's configuration menu, click Data.
In the Values table, enter the following:
Key
Option Label
1
bengal
Bengal
2
sphynx
Sphynx
3
tabby
Tabby
4
maineCoon
Maine Coon
5
ragDoll
Rag Doll
6
britishShorthair
British Shorthair
7
americanShorthair
American Shorthair
8
exoticShorthair
Exotic Shorthair
Click Save & Close.
Save your module.

	Key	Option Label
1	bengal	Bengal
2	sphynx	Sphynx
3	tabby	Tabby
4	maineCoon	Maine Coon
5	ragDoll	Rag Doll
6	britishShorthair	British Shorthair
7	americanShorthair	American Shorthair
8	exoticShorthair	Exotic Shorthair

Your Search Select component looks like the following in Express View:

Structure of a Search Select Component's Data

Using the above example, execute the Vega Console command UNQENG.tools.getComponentState('catType') in the DevTools Console to display the component's data structure.

Here's how the above example looks after selecting an option in Express View:

Here's how the same component looks in the DevTools Console:

Overview

By default, the Search Select component remains collapsed until the end-user clicks it. After making a selection, the list closes again.

You'll find the Search Select component in the Primary Fields group to the left of the Module Builder.

About the Configuration Window

To learn more about general component settings and those that display when a component is associated with Data Models, view our General Component Settings article.