Address Search Component

The Address Search component captures a structured address from end-users using autocomplete powered by a configurable geocoding service (Google Places or Canada Post). Individual address fields—street, city, state, zip, country—are configurable as sub-fields.

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	`addressSearch`	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 to guide end-users on what to enter.

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.
Display as Text	`readOnlyView`	Toggle	OFF	Displays the stored value as plain text without the input element. Shows `None` when empty.

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.

Formatting

Each address sub-field can be shown or hidden individually. When enabled, a custom label can be configured for each field.

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`.
No Matching Results Text	`noOptionsMessage`	Text input	—	Custom message shown when no address results match the end-user's search.
Loading Results Text	`loadingLabel`	Text input	`Loading...`	Text shown while address suggestions are being fetched.
Hide Search	`hideSearch`	Toggle	OFF	Hides the address search autocomplete input, showing only the configured sub-fields.

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
Place Service	`serviceType`	Choice chip	Google Places	Sets the geocoding service used for address autocomplete.

When Place Service is Google Places

Setting	Field	Type	Default	Description
Select API	`service`	Service selector	—	The configured Google Places service to use for address lookup.
Multi Country Filter	`map.components`	Text input	—	Restricts results to specified countries (for example, `country:US
Region Bias Location	`location`	Text input	—	Latitude/longitude bias point for search results (for example, `37.76999,-122.44696`).
Region Bias Radius	`radius`	Text input	—	The radius in meters around the bias location to prioritize results (for example, `500`).
Show Address Data in Short Format	`isShortFormatAddress`	Toggle	ON	Stores abbreviated address values (for example, `NY` instead of `New York`).

When Place Service is Canada Post

Setting	Field	Type	Default	Description
Select API	`canadaPostService`	Service selector	—	The configured Canada Post service to use for address lookup.
Default Country	`countryISO`	Country selector	`CA`	The default country for address searches.
Show Country Option	`showCountryOption`	Toggle	OFF	Displays a country selector so end-users can change the search country.
↳ Country Option Label Text	`countryOptionLabelText`	Text input	—	Custom label displayed above the country selector. Visible when Show Country Option is ON.

Actions Settings

Triggers

Setting	Field	Type	Default	Description
Trigger	`listener`	Property ID	—	Triggers another component when the end-user selects an address.
On Keypress	`listener2`	Property ID	—	Triggers another component as the end-user types in the search field.

Validation Settings

User Input

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

Advanced Settings

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