UK Address Field

Structured address input for collecting UK postal addresses.

Preview

What is your address?

What is your address?

UPRN (optional)

Address line 1

Address line 2 (optional)

Town or city

County (optional)

Postcode

{
  "type": "UkAddressField",
  "name": "fieldName",
  "title": "Question title",
  "hint": "",
  "shortDescription": "",
  "options": {}
}

Property	Type	Required	Description
`hint`	`string`	No	Hint text displayed below the field label to help the user answer the question.
`shortDescription`	`string`	No	A short description of the field used in the check-your-answers summary.

Property	Type	Required	Description
`classes`	`string`	No	Additional CSS classes applied to the component.
`customValidationMessages`	`object`	No	A map of Joi error codes to custom error messages.
`hideTitle`	`boolean`	No	When `true`, hides the component or section title.
`instructionText`	`string`	No	Alternative text read by screen readers in place of the field title.
`optionalText`	`boolean`	No	When `true`, appends '(optional)' to the field label.
`required`	`boolean`	No	Whether the field must be filled in. Defaults to `true`.
`usePostcodeLookup`	`boolean`	No	When `true`, enables a postcode lookup integration.