Skip to main content

Ideal Postcodes Gutenberg Forms Integration

This guide outlines how to attach address autocompletion to your WordPress Gutenberg Forms pages.

This integration works by hooking into Gutenberg Forms' custom HTML field.

Features#

  • Bind address autocompletion to your address fields

Screenshots#

Address Finder#

Activate Address Finder on your address collection forms-screenshot

Support#

If you need support, you can either reach out to us on our support page or drop by our developer chat page.

Installation#

This integration works by hooking into Gutenberg Forms' custom HTML fields. Below are the instructions to add Postcode Lookup or Address Finder.

Create Address Inputs#

Add address input fields to your form. These should be created using Text blocks.

A basic address form to capture a correct UK address requires the following fields:

  • Address line one
  • Address line two
  • Address line three
  • Post town
  • Postcode

Create address fields-screenshot

You can optionally include additional fields, which are documented in our PAF data page.

Note the field labels associated with each Text block. In the above example, some of these are Address Search, Address Line One, Post Town, etc. You will need this to initialise address validation.

Add Address Finder#

Install Plugin#

Add a HTML block at the bottom of your form.

Create HTML block-screenshot

Now add the Autocomplete Plugin script tag.

<script   src="https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled@2/dist/address-finder.js"></script>

Add the Autocomplete Plugin-screenshot

Initialise Autocomplete#

In the same HTML block, add the Autocomplete initialisation code.

<script   src="https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled@2/dist/address-finder.js"></script>
<script>IdealPostcodes.AddressFinder.setup({  inputField: 'input[aria-label="Address Line One"]',  apiKey: 'iddqd',  injectStyle: true,  outputFields: {    line_1: 'input[aria-label="Address Line One"]',    line_2: 'input[aria-label="Address Line Two"]',    line_3: 'input[aria-label="Address Line Three"]',    post_town: 'input[aria-label="Post Town"]',    postcode: 'input[aria-label="Postcode"]',  }});</script>

Configure autocomplete fields-screenshot

You can optionally override CSS styles in the same HTML field. E.g.

<style>  @media only screen and (min-width: 641px) {    ul.idpc_ul {       min-width: 0 !important;      width: calc(50% - 8px);    }  }</style>

Take special care to:

  1. Insert your API Key in the apiKey field
  2. Update the names of your target fields. These should match the label names on your form. If your first address line is Address Line One, then line_1 should read 'input[aria-label="Address Line One"]'. Do this for all the address fields you wish to include
  3. Ensure inputField points to the same field as line_1

If you wish to add an additional field, include the parameter name from our documentation. For instance, adding a county field with Field ID abcde will look like:

outputFields: {  line_1: 'input[aria-label="Address Line One"]',  line_2: 'input[aria-label="Address Line Two"]',  line_3: 'input[aria-label="Address Line Three"]',  post_town: 'input[aria-label="Post Town"]',  county: 'input[aria-label="County"]',  postcode: 'input[aria-label="Postcode"]'}

Configuration#

See our Address Finder Plugin Documentation if you wish to customise Address Finder.

See our Postcode Lookup Plugin Documentation if you wish to customise Postcode Lookup.