Address Component

For new modules, use the Address Search Component, which provides an improved configuration experience and additional features.

The Address component captures an address from end-users using a Google Maps-powered autocomplete search. Individual address sub-fields (street, city, state, zip, country) are configurable in the Advanced settings.

How to read settings tables
The tables below describe each configurable option as it displays in the UnqorkAI platform. Values are formatted as follows: inline code — a value to type exactly as shown | Bold — a value selected from a drop-down, radio button, tab, or choice chip | ON/OFF — toggle state | ✓ — checkbox checked | ☐ — checkbox unchecked

General Settings

Setting	Field	Type	Default	Description
Property ID	`key`	Text input	`address`	The unique identifier for this component instance.

Display Settings

Field Text

Setting	Field	Type	Default	Description
Label Text	`label`	Text input	—	Identifies the component on the canvas and informs end-users what information is requested.
Placeholder Text	`placeholder`	Text input	—	Hint text displayed inside the address search input.

Contextual Help

Setting	Field	Type	Default	Description
Tooltip	`tooltip`	Text input	—	A brief description that displays when a cursor is positioned over the tooltip icon.

Default State Options

Setting	Field	Type	Default	Description
Hide Field	`hidden`	Toggle	OFF	Hides the component from end-users but always displays in the Module Builder.

Formatting

Setting	Field	Type	Default	Description
Hide Search	`hideSearch`	Toggle	OFF	Hides the address autocomplete search input.

Input Behavior

Setting	Field	Type	Default	Description
Behavior	—	Drop-down	Enable User Input	Sets how end-users can interact with the field.

Enable User Input: End-users can type in the address search field and select from autocomplete suggestions.
Disable User Input: Prevents end-users from editing the field. The field displays with an altered appearance to indicate it is not editable.
Read Only - Legacy: Makes the field non-editable using the legacy implementation. End-users can view, select, and copy the content.
Read Only - Accessible: Makes the field non-editable using the HTML <input readonly> attribute, which is recognized by screen readers and assistive technologies.

Data Settings

Data Storage

Setting	Field	Type	Default	Description
Store Data in Database	`persistent`	Toggle	ON	When set to ON, this setting this setting stores field values to the database when the module saves, end-users navigate between Panel components, or end-users navigate between workflow screens. Set to OFF to exclude this field from server-side submissions.

Fields with Store Data in Database set to OFF are excluded from Plug-In component's API responses and Unqork's built-in tracker. When using a Plug-In component to remote-execute a module, any component whose value must be included in the API response requires Store Data in Database set to ON.

Data Source

Setting	Field	Type	Default	Description
Google Maps API Key	`map.key`	Text input	—	The API key for Google Maps. Required to enable address autocomplete.
Region Bias	`map.region`	Text input	—	A CCTLD country code to bias search results toward a specific region (for example, `ca` for Canada).
Component Filter	`map.components`	Text input	—	Restricts search results to specific geographic components (for example, `country:US

Validation Settings

User Input

Setting	Field	Type	Default	Description
Required	`validate.required`	Toggle	OFF	Requires an address to be entered before the module can be submitted.
Required Error Message	`errors.required`	Text input	`is required`	Displays when the required field has no value.

Advanced Settings

Additional Display Options

Each address sub-field can be enabled individually. When enabled, a custom label can be configured.

Setting	Field	Type	Default	Description
Show Street	`street`	Toggle	OFF	Displays the street address sub-field. Default label: `Street Address`.
Show Street 2	`street2`	Toggle	OFF	Displays the secondary street address sub-field. Default label: `Street Address 2`.
Show City	`city`	Toggle	OFF	Displays the city sub-field. Default label: `City`.
Show State	`state`	Toggle	OFF	Displays the state sub-field. Default label: `State`.
Show ZIP	`zip`	Toggle	OFF	Displays the zip code sub-field. Default label: `ZIP`.
Show Country	`country`	Toggle	OFF	Displays the country sub-field. Default label: `Country`.

Additional Styling

Setting	Field	Type	Default	Description
Custom CSS Class	`customClass`	Text input	—	A CSS class applied to the component for custom styling.