Multi-Select Dropdown Component

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

Property IDs must use camel case (stylized as camelCase) without spaces or punctuation.

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.

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.

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

Input Behavior                                                                            

Controls how end-users interact with the component. Choose from the following options:

• Enable User Input: Allow end-users to view and enter data in this field.

• Disable User Input: Prevents end-users from entering data in the field, but lets them view it. In the Module Builder, the field’s background displays as gray. In Express View, when end-users hover over the field, their cursor displays with a prohibited symbol.

• Read Only - Legacy: Prevents end-users from entering data and replaces the field with the component’s data value. If no value is provided, the component displays None.

• Read Only - Accessible: Makes the field non-editable and applies the readonly HTML attribute, which notifies screen readers that the field cannot be modified.

Allow Multiple Selections

When set to (ON), your end-user can make multiple selections from the drop-down. Set to (OFF) if you only use the component for its custom styling.

By default, Allow Multiple Selections is set to (OFF).

Auto-Select Highlighted Option When Clicking Outside

When an end-user selects the drop-down, one of the options is automatically highlighted. When set to (ON), the first highlighted option will be selected when the end-user clicks outside of the drop-down.

By default, this setting is set to (ON).

Set Dropdown Menu Height                                                                            

Sets the number of search result rows the component displays when filtered by an end-user. If there are more options than the number entered, your end-user can scroll to view them all. Or, they can enter a value to navigate to relevant results.

Show Clear Button                                                                            

When set to (ON), a Clear button displays after an end-user selects one or more options. The Clear button removes whatever selection(s) your end-user made.

By default, the Show Clear Button toggle is set to (OFF).

Hide Chevron                                                                            

When set to (ON), the arrow (chevron) to the right of the component is hidden.

By default, Hide Chevron is set to (OFF).

Item Template                                                                            

Lets you choose which column of data you want to display as the label for the drop-down options. Replace the word label with your chosen attribute in the following string format: <span>{{ item.label }}</span>.

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.

Option Label                                                                            

Each option needs an end-user-facing label describing the choice that it represents. Enter your Option Labels using this column.

After you create an option, another row displays for you to create the next option.

Data Source Values                                                                            

Each option needs an associated value to store in the submission data. Enter the values to store in the submission data using this column.

By default, the value is a camelCase version of the Option Label. You can also assign a numeric value to each option for logic-based configurations.

Request Header                                                                            

Enter the information to display in the drop-down selections. These are your end-user's options. For external APIs, you'll find this information in the API documentation. To pull data from a Data Collection, enter the column header you want to use.

Header Values                                                                            

Each option needs an associated value to store in the submission data. Enter the values to store in the submission data using this column. If you want the value to be the same as the label, enter the same information you put in the Request Header.

By default, the value is a camelCase version of the Request Header. You can also assign a numeric value to each option for logic-based configurations.

Service                                                                            

Select an external service configured through Unqork's Services Administration. This auto-populates the other required fields, including the Data Source URL.

Data Source URL                                                                            

For an API to retrieve data, you need the API's URL information. In this field, enter the API information as obtained from the API documentation. Add additional filters at the end of the URL if you want to drill down to a specific type of data.

Value Property                                                                            

If a data set includes a column for values, enter the column's name here.

If not specified, the application uses the option label.

Data Path                                                                            

If using an API call to populate the component, enter a specific data property to reference here. This is useful if you want to show one piece of a larger data set in your Multi-Select Dropdown component.

Label Path                                                                            

This field refers to the option labels you want to pull. Enter the option label's column header in this field.

Filter Query                                                                            

Provide additional filtering using query parameters. Parameters append to the end of the Data Source URL. Query parameters can be static or dynamic. For example, name={{data.groupName}}.

Search Query Name                                                                            

The name of the search query string parameter used when sending a request to filter results. The server at the specified URL must support this query parameter.

Refresh On                                                                            

This field displays a list of the other components in your module. You can select a component here to refresh your Multi-Select Dropdown. When your end-user interacts with the selected component, the Multi-Select Dropdown resets.

You can also select Any Change. This refreshes the Multi-Select Dropdown if your end-user interacts with any of your components.

This setting watches other components in your module. The more components the component watches, the more performance issues can occur. It’s also important to note that processes large amounts of data on the client side will also impact performance.

Refresh Delay                                                                            

Works with the Refresh On setting to set the number of milliseconds that pass before refresh. Once typing has finished, the delay begins.

The component has a minimum Refresh Delay of 250 ms, which is the default for this field.

Limit Number of Items                                                                            

Limits the number of matching responses when working with large data sets. For example, an API might return more responses than you want to display, even when your end-user starts typing. Here, you can set a limit on how many results display.

Disable Limiting Response                                                                            

When set to (ON), the request won't include the limit and skip options in the query string.

By default, this setting is (OFF).

Search Parameters are Required                                                                            

When set to (ON), search parameters must be present to execute the search.

By default, this setting is (OFF).

Clear Value on Refresh                                                                            

When set to (ON), the selected value is cleared after the Refresh On setting triggers.

By default, this setting is (OFF).

Authenticate                                                                            

When set to (ON), authentication headers from the application are sent to the Data Source URL destination.

By default, this setting is (OFF).

Disable Filter Application                                                                            

When set to (ON), filter parameters are not applied.

By default, this setting is (OFF).

Data Reference Key                                                                            

Enter the Property ID of the component whose data you're referencing.

Limit Number of Items                                                                            

Limits the number of matching responses when working with large data sets. For example, an API might return more responses than you want to show. Here, you can set a limit on how many results display.

Refresh On                                                                            

This field displays a list of the other components in your module. You can select a component here to cause your Dropdown to refresh. When your end-user interacts with the selected component, the Dropdown resets.

Here, you can also select Any Change. This refreshes the Dropdown if your end-user interacts with any of your components.

This setting watches other components in your module. The more components the component watches, the more performance issues can occur. It’s also important to note that processes large amounts of data on the client side will also impact performance.

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.

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.

Require Unique Submission Data                                                                        

When set to (ON), the data submitted for this field must be unique and not submitted before.

By default, the Require Unique Submission Data toggle is set to (OFF).

Don't Allow Unique Values                                                                        

When set to (OFF), the component does not display a validation error when values not included in the drop-down options are injected into the value for the Multi Select Component. For example, if the options for the drop-down includes A, B, C, and a logic component gives a value of Z, the drop-down does not display an error when validated.

When set to (ON), the component displays a validation error when values not included in the drop-down's options are injected into the value for the Multi Select Component. For example, if the options for the drop-down are A, B, C,  and a logic component provides a value of Z, the drop-down displays an error when validated.

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.