Skip to content
Frontend UK Address Autocomplete Library for Ideal Postcodes API
Branch: master
Clone or download
cblanc Merge pull request #4 from ideal-postcodes/fix_filter_typo
Fix typo in setSearchFilter docs and regenerate docs
Latest commit d356104 Nov 9, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
css Use default pointer and more consistent styling for error messages Feb 16, 2017
dist Bump to version 0.2.1 Apr 28, 2017
docs Fix typo in setSearchFilter docs and regenerate docs Nov 9, 2017
example Add id to title for testing Feb 21, 2017
lib Fix typo in setSearchFilter docs and regenerate docs Nov 9, 2017
test Truncate test Mar 23, 2017
.gitignore
.npmignore
.travis.yml Initial commit Sep 16, 2016
CHANGELOG.md
LICENSE.txt
README.md
bower.json Fix main Sep 16, 2016
gulpfile.js
package.json
tsconfig.json Use 'include' instead of 'files' to specify source Sep 15, 2017
tslint.json Initial commit Sep 16, 2016

README.md

npm version gzip file size file size

UK Address Autocomplete

Introduction

This library will create a UK address autocomplete box for any input field provided and pipe the details of a selected address to input fields you designate.

Usage requires an Ideal-Postcodes.co.uk API Key

Ideal Postcodes Autocomplete Example

Build Status & Browser Compatibility Information

This library is tested across modern desktop and mobile browers

Internet Explorer 9 and above is supported. Internet Explorer 6, 7 and 8 are not supported

Methods

To get started, create and point an Autocomplete instance to the input box to add autocomplete to while specifying output fields. E.g.

const controller = new IdealPostcodes.Autocomplete.Controller({
	api_key: "iddqd",
	inputField: "#input",
	outputFields: {
		line_1: "#line_1",
		line_2: "#line_2",
		line_3: "#line_3",
		post_town: "#post_town",
		postcode: "#postcode"
	}
});

Please see our documentation for more information

Installation

You may install it via npm with,

npm install ideal-postcodes-autocomplete --save

You may also use Bower with,

bower install ideal-postcodes-autocomplete --save

Finally you can install it manually by copying the minified build from /dist/

Testing

Run the test suite with,

gulp test

You may test the library manually in a browser console with,

gulp webserver

License

MIT

You can’t perform that action at this time.