Separate Input Field
inputField if you want Address Lookup to render on an input field which is not your first address line.
CSS selector or HTML Element which specifies the
<input> field which the Address Lookup interface should bind.
outputFields.line_1 (the first address line).
Disable Key Check
Enabled by default. This causes Address Lookup to check if the key is in a usable state before initialising itself.
The check can fail if:
- Your key has no remaining lookups
- Your key has run into its lookup limit for the day
- Your key is requested from a URL which is not on your whitelist
- The user seeking to use the key has exceeded their limit for the day
If the check fails, the plugin will not initialise. You can use the
onFailedCheck callback to customise your response to a failed check.
Uppercase Post Town
An optional field to convert the case of the Post Town from upper case into title case. E.g.
"NEW YORK" becomes
Apply a query, like a filter or bias, to your suggestion queries. A complete list of query parameters are available in the Autocomplete API Reference.
To apply new parameters after the Controller has been instantiated, use
setQueryOptions. Do not mutate
Remove Organization from Address Line
If set to
true, organization name will be removed from the address.
Disable Chrome Autofill
autocomplete= attribute of the input element. Setting this attribute aims to prevent some browsers (particularly Chrome) from providing a clashing autofill overlay.
The best practice for this attribute breaks over time (see https://stackoverflow.com/questions/15738259/disabling-chrome-autofill) and is specific to different forms. If you are observing Chrome's autofill clashing on your form, update this attribute to the best practice du jour.
Hide Address Fields
Accepts an array of HTMLElements or CSS selectors. E.g.
When enabled, the HTMLElements supplied in
hide are hidden with
display: none; when Address Lookup initialises and attaches to the DOM. These elements will be subsequently unhidden if an address is selected or the user opts to manually input an address.
Enabling this feature will also create a clickable element in the Address Lookup, which provides users the option to manually input an address. You may provide your own clickable element with
unhide or customise the clickable element with
Custom Unhide Element
Specify a query selector (
string) or (
HTMLElement) as a custom clickable element to unhide and form fields configured with
hide. This will prevent the default unhide element from being rendered.