Skip to main content

FormFieldTextAddressInput

Stentor API Reference

Stentor API Reference / stentor-models/src / FormFieldTextAddressInput

Interface: FormFieldTextAddressInput

Defined in: packages/stentor-models/src/Form/FormField.ts:125

Specialized text input for address entry with autocomplete functionality.

Extends FormTextInput to provide Google Maps Places Autocomplete integration for address suggestions.

Extends​

Properties​

name​

name: string

Defined in: packages/stentor-models/src/Form/FormField.ts:79

Name of the form input, this is not human readable and is used to identify the field.

For example: "SERVICE" or "FULL_NAME"

Inherited from​

FormTextInput.name

title?​

optional title?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:83

Optional title used to display on the input

Inherited from​

FormTextInput.title

type​

type: "CARD" | "TEXT" | "DROPDOWN" | "CHECK" | "CHIPS" | "DATE" | "DATERANGE"

Defined in: packages/stentor-models/src/Form/FormField.ts:87

Type of the input

Inherited from​

FormTextInput.type

shape?​

optional shape?: "ROUND" | "SQUARE"

Defined in: packages/stentor-models/src/Form/FormField.ts:91

Optional, used to shape the input. Not applicable to all inputs.

Inherited from​

FormTextInput.shape

condition?​

optional condition?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:98

A condition that must be met for the field to be shown.

For example: "issue === 'service_repair'" - issue is a field name in this example

Inherited from​

FormTextInput.condition

mandatory?​

optional mandatory?: boolean

Defined in: packages/stentor-models/src/Form/FormField.ts:102

Is the field required.

Inherited from​

FormTextInput.mandatory

mandatoryError?​

optional mandatoryError?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:106

Error message to show when the field is required but not filled out.

Inherited from​

FormTextInput.mandatoryError

mandatoryGroup?​

optional mandatoryGroup?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:110

Group fields together where one of the fields in the group is required.

Inherited from​

FormTextInput.mandatoryGroup

style?​

optional style?: object

Defined in: packages/stentor-models/src/Form/FormField.ts:116

React.CSSProperties style object to apply to the field.

For example: {{ width: '300px', height: '150px' }}

Inherited from​

FormTextInput.style

format​

format: "ADDRESS"

Defined in: packages/stentor-models/src/Form/FormField.ts:126

Format validation to apply to the input. Default is free text with no validation.

Overrides​

FormTextInput.format

mapsBaseUrl?​

optional mapsBaseUrl?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:133

Base URL of an endpoint that adheres to the Google Maps Location Autocomplete API.

This can be either the official Google Maps API endpoint or a custom proxy endpoint that implements the same interface.

mapsUrlQueryParams?​

optional mapsUrlQueryParams?: AddressAutocompleteParameters

Defined in: packages/stentor-models/src/Form/FormField.ts:139

Optional query parameters to help limit the results returned by the Google Maps Autocomplete API.

Use these parameters to restrict results by country, location, or other criteria.

googleMapsApiKey?​

optional googleMapsApiKey?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:145

Required when you are using the official Google Maps Autocomplete API.

Not needed if using a custom proxy endpoint that handles authentication.

requireSelection?​

optional requireSelection?: boolean

Defined in: packages/stentor-models/src/Form/FormField.ts:150

When true, the user must select an address from the autocomplete suggestions. Free-text entry is not allowed. Defaults to false (free-text allowed).

multiline?​

optional multiline?: boolean

Defined in: packages/stentor-models/src/Form/FormField.ts:163

When true, renders as a textarea instead of a single-line input

Inherited from​

FormTextInput.multiline

placeholder?​

optional placeholder?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:171

Placeholder text shown when the input is empty

Inherited from​

FormTextInput.placeholder

label?​

optional label?: string

Defined in: packages/stentor-models/src/Form/FormField.ts:175

Accessible label for the input field

Inherited from​

FormTextInput.label

rows?​

optional rows?: number

Defined in: packages/stentor-models/src/Form/FormField.ts:179

Number of rows for textarea (only applicable when multiline is true)

Inherited from​

FormTextInput.rows

rowsMax?​

optional rowsMax?: number

Defined in: packages/stentor-models/src/Form/FormField.ts:183

Maximum number of rows for textarea (only applicable when multiline is true)

Inherited from​

FormTextInput.rowsMax

maxLength?​

optional maxLength?: number

Defined in: packages/stentor-models/src/Form/FormField.ts:187

Maximum character length allowed for the input

Inherited from​

FormTextInput.maxLength