GOV.UK country and territory autocomplete - what it is and how to use it
The GOV.UK country and territory autocomplete is a simple UI widget that allows end users to find and select a location. It includes auto-complete functionality to make it faster and easier for users to find a location. For example, to select their country of birth or their current location.
The autocomplete uses data from the UK government's country and territory registers. To configure the data used in the autocomplete to suit the specific needs of your product or service, please contact the registers team.
The autocomplete itself follows the common look and feel of GOV.UK in line with the design principles.
This guide will show you how to:
- populate the autocomplete field
- use the autocomplete's data file
Contact the registers team if you have any problems or questions that are not covered in this guide.
Before you start
This guide assumes you have a service that outputs HTML. It makes some choices for you with respect to which data is passed back and persisted to your service. Please contact the registers team to discuss your requirements.
To integrate an application with the autocomplete, you'll need to:
- use the data from the country and territory registers
- create an accessible autocomplete widget
- keep the data up to date
Add location data from country and territory registers
To use register data in the autocomplete, you will need two files:
- location-autocomplete-canonical-list.json - a list of every canonical country and territory
- location-autocomplete-graph.json - a directed acyclic graph mapping canonical locations to abbreviations, synonyms, endonyms, and typos
location-autocomplete-graph.json file only contains examples of synonyms, abbreviations, endonyms and typos you might want to consider. It is not a comprehensive list. You may wish to add or remove items based on your own user research.
Copy both files to your application. The
location-autocomplete-graph.json file must be exposed as a public asset.
You can also install the location autocomplete using
$ npm install govuk-country-and-territory-autocomplete $ ls node_modules/openregister-location-autocomplete/dist/ location-autocomplete-canonical-list.json location-autocomplete-graph.json location-autocomplete.min.css location-autocomplete.min.js location-autocomplete.min.js.map
location-autocomplete-canonical-list.json file contains an array of arrays containing the location names and ISO codes:
> JSON.parse(fs.readFileSync('data/location-autocomplete-canonical-list.json', 'utf8')) [["Abu Dhabi", "territory:AE-AZ"], ["Afghanistan", "country:AF"], …]
You should parse this file on your application's server or as part of the build process to produce a plain HTML
<select> dropdown. This is your progressive enhancement fallback. You should render something that looks like this:
<select id="location-autocomplete"> <option value="territory:AE-AZ">Abu Dhabi</option> <option value="country:AF">Afghanistan</option> … </select>
Create an accessible autocomplete widget
To make it easier for users to find a location using the autocomplete, you should progressively enhance the front-end to add auto-complete functionality. As a user types, the autocomplete will suggest a list of possible locations for the user to choose from.
On the page where you're rendering the previous
<select> dropdown, include the following HTML, updating the
/assets/ URLs as needed for your application:
This will render the same
<select> menu is still updated, so everything works as before.
Adding additional entries and synonyms
You can pass in custom entries and synonyms using the
You can additionally specify custom synonyms on the
<option> elements by using the
<select id="location-autocomplete"> <option value="territory:GB" data-additional-synonyms='["Blighty"]'>United Kingdom</option> <option value="country:RO" data-additional-synonyms='["Dacia"]'>Romania</option> </select>
Keep the data up to date
Government Digital Service will publish new versions of the
govuk-country-and-territory-autocomplete package when the data changes, such as when countries are renamed.
To keep up to date, you can use dependency monitoring tools, such as:
- Greenkeeper, a GitHub bot that will submit pull requests to your open source project when there are new versions of your dependencies
- David, a command line tool that can be configured to run on your continuous integration environment and return a non-zero status when there are new versions of your dependencies
Support and troubleshooting
Government Digital Service (GDS) maintains the platform behind registers and creates widgets such as the location autocomplete to make it easier for service teams to use register data.
Contact GDS if you want to use the autocomplete, but your needs differ from what is covered in this guide.
Contact the GOV.UK Registers team if you have any problems or questions that are not covered in this guide. Please include screenshots if useful. GDS provides operational support from 09:00 - 17:00 Monday-Friday.
You can also raise an issue against this repository if you prefer.
country register - A list of British English-language names and descriptive terms for countries.
location - A country or territory.
autocomplete - A widget that allows you to choose from items in a register.
register - A list of information designed to be an accurate and up-to-date source of data from government. Once entered into a register, the contents can only be added to, they cannot be deleted or rewritten.
territory - An administrative or geographical entity that isn't recognised as a country by the UK.
territory register - A list of British English-language names and descriptive terms for political, administrative and geographical entities that aren’t recognised as countries by the UK.