Vega Search Select Component
Overview
The Search Select component is a Primary Fields component that lets end-users End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. 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. |
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. |
|
Render Select Menu as Portal |
When set to (ON), in Express View Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View., the search select field is rendered in the HTML body of the DOM The Document Object Model (DOM) is the data representation of objects that form the structure and content of a document on the web. The DOM represents the page.. 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:
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. |
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.
| 1. | In the Module Builder, drag and drop a Search Select component onto the canvas. |
| 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 catType. |
| 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 favorite cat breed?. |
| 4. | Navigate to the component's Data settings. |
| 5. | In the Values table, enter the following: |
|
Label |
Value |
|
|---|---|---|
|
1 |
Bengal |
bengal |
|
2 |
Sphynx |
sphynx |
|
3 |
Tabby |
tabby |
|
4 |
Maine Coon |
maineCoon |
|
5 |
Rag Doll |
ragDoll |
|
6 |
British Shorthair |
britishShorthair |
|
7 |
American Shorthair |
americanShorthair |
|
8 |
Exotic Shorthair |
exoticShorthair |
| 6. | Click Save Component. |
| 7. | Save your module. |
Your Search Select component looks like the following in Express View Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module 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 The DevTools Console helps you securely store, build, test, and deploy your software. 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 The DevTools Console helps you securely store, build, test, and deploy your software.:
Overview
The Search Select component is a Primary Fields component that lets end-users End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. 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 Panel
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. |
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. |
|
Render Select Menu as Portal |
When set to (ON), in Express View Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View., the search select field is rendered in the HTML body of the DOM The Document Object Model (DOM) is the data representation of objects that form the structure and content of a document on the web. The DOM represents the page.. When set to (OFF), the Search Select field nests in its parent container. By default this setting is (ON). |
Data Panel
Data Source Type
Values
Selecting Values displays a table where you can enter each option and its value.
|
Setting |
Description |
|---|---|
|
Key |
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. |
|
Option Label |
Enter the text that displays to the end-user. When an end-user clicks the text, the Action setting fires. |
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:
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. |
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.
| 1. | In the Module Builder, drag and drop a Search Select component onto the canvas. |
| 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 catType. |
| 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 favorite cat breed?. |
| 4. | In the component's configuration menu, click  Data. |
| 5. | 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 |
| 6. | Click Save & Close. |
| 7. | Save your module. |
Your Search Select component looks like the following in Express View Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module 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 The DevTools Console helps you securely store, build, test, and deploy your software. 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 The DevTools Console helps you securely store, build, test, and deploy your software.:
Resources
