---
title: "Address Component"
slug: "address-component"
tags: ["module-builder"]
updated: 2026-10-05T15:54:35Z
published: 2026-10-05T15:54:35Z
canonical: "docs.unqork.io/address-component"
stale: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unqork.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Address Component

> For new modules, use the [Address Search Component](/unqorkai/docs/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.

> [!NOTE]
> The Build Agent does not create new instances of this component. The Build Agent uses the Address V2 component instead.

> **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 - Legacy**: Makes the field non-editable using the legacy implementation. End-users can view, select, and copy the content.
> - **Read - 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 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. |

> [!NOTE]
> 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. |

---

**Changelog**

| Date | Change |
| --- | --- |
| 2026-10-02 | Added Build Agent notice — the Build Agent does not create new instances of this component (EN-8141). |
| — | Initial publication. |

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.

A Property ID is the unique field ID used by Unqork to track and link components in your module.

Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.

HTML (Hyper Text Markup Language) is the standard markup language for for achieving font, color, graphic, and hyperlink effects when creating web pages.

Assistive technology that reads digital text aloud for users with visual impairments or reading disabilities.

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.

A key-value pair is a fundamental data structure where a unique "key" is associated with a specific "value," used for organizing and retrieving data efficiently, like in dictionaries or databases.

A zip file is a file format that can contain multiple files combined and compressed into one file. Since it's a type of compressed file, a zip file can be smaller in size than the files it contains.

Cascading Style Sheets (CSS) is a style sheet language used for presenting how a HTML or XML document looks to end-users.