Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ideal-postcodes/jquery.postcodes
jQuery plugin to quickly add postcode lookups on a form using Royal Mails Postcode Address File
https://github.com/ideal-postcodes/jquery.postcodes
Last synced: 10 days ago
JSON representation
jQuery plugin to quickly add postcode lookups on a form using Royal Mails Postcode Address File
- Host: GitHub
- URL: https://github.com/ideal-postcodes/jquery.postcodes
- Owner: ideal-postcodes
- Created: 2013-07-24T14:35:10.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2021-05-09T18:45:10.000Z (over 3 years ago)
- Last Synced: 2024-10-11T08:14:56.723Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://ideal-postcodes.co.uk/
- Size: 1.05 MB
- Stars: 21
- Watchers: 7
- Forks: 11
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
> **January 2021** jquery.postcodes has moved (and no longer requires jQuery). Please see our new [Postcode Lookup](https://github.com/ideal-postcodes/postcode-lookup) library
# UK Postcode Lookup jQuery Plugin
Add UK address lookups with a simple postcode input field on any web form with the Ideal-Postcodes.co.uk API. Ideal Postcodes uses Royal Mail's addressing database, the Postcode Address File (PAF).
[](https://circleci.com/gh/ideal-postcodes/jquery.postcodes/tree/master)
PAF is licensed from the Royal Mail and incurs a license fee per lookup. We make PAF available to the public at **2p** per [external](https://ideal-postcodes.co.uk/termsandconditions#external) lookup.
## How it Works
This plugin creates an input field to lookup postcodes on the Ideal Postcodes API. If your user searches a valid postcode, a dropdown menu is displayed and the selected address is piped into appropriate fields.
The plugin provides addresses according to [Royal Mail's Addressing Guidelines](http://www.royalmail.com/personal/help-and-support/How-do-I-address-my-mail-correctly). This consists of 3 address lines, a Post Town and Postcode and is sufficient to uniquely identify a premise in the UK.
## Getting Started
1) **[Download the plugin](https://raw.github.com/ideal-postcodes/jquery.postcodes/master/dist/postcodes.min.js)** and add to your page
```html
```
2) **[Sign up](https://ideal-postcodes.co.uk)** to get an API key
3) **Setup a Postcode Search Field** by inserting an empty div tag and calling `.setupPostcodeLookup()`. Pass in a configuration object identifying specifying your API Key and address fields (using CSS selectors)
```html
$('#postcode_lookup_field').setupPostcodeLookup({
// Set your API key
api_key: 'iddqd',
// Pass in CSS selectors pointing to your input fields to pipe the results
output_fields: {
line_1: '#first_line',
line_2: '#second_line',
line_3: '#third_line',
post_town: '#post_town',
postcode: '#postcode'
}
});
```
## Documentation & Configuration
[Latest documentation can be found at ideal-postcodes.co.uk](https://ideal-postcodes.co.uk/documentation/jquery-plugin)
This plugin also allows you to draw additional addressing information. The complete list of available data fields can be found [here](https://ideal-postcodes.co.uk/documentation/paf-data).
There are a lot of ways to configure the plugin to create an address lookup feature that suits most use cases. The documentation will guide you through how to use additional configuration options like customised styling, customised inputs & triggers, useful callbacks, key checking, etc.
For examples of the more advanced ways you can configure the plugin take a look at [ideal-postcodes.co.uk/jquery](https://ideal-postcodes.co.uk/jquery).
## Testing
Run automated tests with
```
npm test
```
Please use jQuery 1.9.x or higher. This plugin has been tested against jQuery 1.9.x, 1.10.x, 1.11.x, 2.0.x, 2.1.x, 2.2.x, 3.0.x. 3.1.x and 3.2.x
You may run the plugin locally and test in your browser
```bash
$ npm start # starts a HTTP server
# Navigate to the `examples` folder and select an example in a *.html file
```
Our test postcodes are:
- **ID1 1QD** Returns a successful postcode lookup response (2000)
- **ID1 KFA** Returns "postcode not found" error (4040)
- **ID1 CLIP** Returns "no lookups remaining" error (4020)
- **ID1 CHOP** Returns "daily (or individual) lookup limit breached" error (4021)
## License
MIT