Skip to main content

How it Works

Address Lookup can be attached to any form with pre-existing address inputs.

When initialized it will:

  1. Identify the primary input to bind the Address Lookup drop down. This defaults to outputFields.line_1 but you can separately specify inputField to indicate where you want the dropdown to bind.
  2. Pipe address results to the fields defined in outputFields.
  3. Perform a key check to determine whether it is usable. If the check fails, initialisation is aborted. Use the onCheckFailed callback to update your page for manual address entry.

Address Lookup will mutate the DOM slightly for accessibility reasons. For more iformation see DOM Changes