Field Group Component
Estimated Reading Time: 6 minutes
The Field Group component lets you organize fields and components together in one group. Field Group components are like Panel components, but you won't use Field Group components for navigation. You can also apply a CSS style to a Field Group component to call the group out to your end-user End-Users are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.. Here are some real-world examples of when you might use a Field Group component:
-
A stylized section of a page asking for personal information.
-
A boxed-in group of optional survey questions at the end of an application.
-
Grouped and hidden follow-up questions that appear when an end-user selects a specific answer.
-
Disabling or hiding all fields in a group.
It’s best practice to only use Panel components for navigation. So, if you want the fields to display on their own page, you'll use a Panel component. Use the Field Group component if you want a stylized group of fields as part of a larger page.
You'll find the Field Group component under the Display & Layout group to the left of the Module Builder.
What You'll Learn
After completing this article, you’ll know when to use a Field Group component, how to configure its settings, and how to use it in an Unqork application.
About the Configuration Window
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. |
|
Select this tab to manage your component's display settings. |
|
Select this tab to manage your component's advanced settings. |
|
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. |
|
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. |
|
Select this tab to open the list of supported keyboard shortcuts you can use in the component settings modal. Keyboard shortcuts include:
Additional keyboard shortcuts:
|
|
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
Field Text
Setting |
Description |
---|---|
Canvas 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. |
Default State Options
Setting |
Description |
---|---|
Disable All Nested Fields |
When set to By default, the Disable All Nested Fields toggle is set to |
Hide All Nested Fields |
When set to By default, the Hide All Nested Fields toggle is set to |
Advanced Panel
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. |
Adding a Field Group Component
In this example, you'll use a Field Group component to group fields that gather personal information. These instructions assume that you have an open module saved with a title.
What You Need
For this configuration, you'll need the following components:
-
1 Field Group component
-
4 Text Field components
Configure the Field Group Component
First, add the Field Group component to your canvas. This component holds personal information questions.
1. | In the Module Builder, drag and drop a ![]() |
3. | Click Save & Close. |
Configure the Text Field Components
Next, you'll use four Text Field components to hold your personal information questions. You'll place each component inside the Field Group component.
1. | Drag and drop four ![]() ![]() |
Property ID |
Label Text |
---|---|
firstName |
First Name |
lastName |
Last Name |
companyName |
Company Name |
jobTitle |
Job Title |
3. | Save & Close each component as you add it. |
4. | Save your module. |
Your completed configuration looks like the following:
Resources