# ideal-postcodes-autocomplete

> Frontend UK Address Autocomplete Library for Ideal Postcodes API

Latest version **0.2.1** (published 2017-04-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install ideal-postcodes-autocomplete
pnpm add ideal-postcodes-autocomplete
yarn add ideal-postcodes-autocomplete
bun add ideal-postcodes-autocomplete
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2017-04-28 |
| First published | 2016-09-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ideal-Postcodes.co.uk |
| Maintainers | cablanchard |
| Keywords | UK, Addresses, Autocomplete, Ideal, Postcodes |

## Links

- npm: https://www.npmjs.com/package/ideal-postcodes-autocomplete
- Repository: https://github.com/ideal-postcodes/ideal-postcodes-autocomplete
- Homepage: https://ideal-postcodes.co.uk
- Issues: https://github.com/ideal-postcodes/ideal-postcodes-autocomplete/issues
- npm.io page: https://npm.io/package/ideal-postcodes-autocomplete

## Dependencies (1)

- [ideal-postcodes-core](https://npm.io/package/ideal-postcodes-core.md) 0.3.5

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.2.1 (latest) — 2017-04-28
- 0.2.0 — 2017-03-23
- 0.1.1 — 2016-10-05
- 0.1.0 — 2016-09-19
- 0.0.2 — 2016-09-16
- 0.0.1 — 2016-09-16

## README

![BrowserStack Status](https://www.browserstack.com/automate/badge.svg?badge_key=d2RacFVWam1FSmd3UVBualZLUUR5VFIyWFpJNmIzcExCYzYxaTdoZmRGcz0tLThvWmptN0tJOXU4TDdLNUk4MWNqR0E9PQ==--9a8c9ba61a959635117c954808b1d6dbd35dc662) [![npm version](https://badge.fury.io/js/ideal-postcodes-autocomplete.svg)](https://badge.fury.io/js/ideal-postcodes-autocomplete) ![gzip file size](http://img.badgesize.io/ideal-postcodes/ideal-postcodes-autocomplete/master/dist/ideal-postcodes-autocomplete.min.js.svg?compression=gzip) ![file size](http://img.badgesize.io/ideal-postcodes/ideal-postcodes-autocomplete/master/dist/ideal-postcodes-autocomplete.min.js.svg)

# Ideal Postcodes Autocomplete - Frontend Address Autocomplete Library

## Introduction

This library will create an autocomplete box for any input field specified 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](https://raw.github.com/ideal-postcodes/ideal-postcodes-autocomplete/master/example/example.png)

## 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.

```javascript
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](https://ideal-postcodes.co.uk/documentation/ideal-postcodes-autocomplete) for more information

## Installation

You may install it via npm with,

```bash
npm install ideal-postcodes-autocomplete --save
```

You may also use Bower with,

```bash
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,

```bash
gulp test
```

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

```bash
gulp webserver
```

## License

MIT

---
_Source: https://npm.io/package/ideal-postcodes-autocomplete · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._