https://github.com/ideal-postcodes/uk-clear-addressing-bundled

UK Clear Addressing packaged as a drop-in script
https://github.com/ideal-postcodes/uk-clear-addressing-bundled

Last synced: 10 days ago
JSON representation

UK Clear Addressing packaged as a drop-in script

• Host: GitHub
• URL: https://github.com/ideal-postcodes/uk-clear-addressing-bundled
• Owner: ideal-postcodes
• Created: 2021-07-26T19:32:40.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-12T08:30:55.000Z (almost 2 years ago)
• Last Synced: 2024-10-25T06:11:34.897Z (22 days ago)
• Language: HTML
• Size: 574 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        


  



> JavaScript browser bundles for uk-clear-addressing

[![npm version](https://badge.fury.io/js/%40ideal-postcodes%2Fuk-clear-addressing-bundled.svg)](https://badge.fury.io/js/%40ideal-postcodes%2Fuk-clear-addressing-bundled)

[![jscdn](https://badgen.net/jsdelivr/v/npm/@ideal-postcodes/uk-clear-addressing-bundled)](https://cdn.jsdelivr.net/npm/@ideal-postcodes/uk-clear-addressing-bundled/dist/)

![Release](https://github.com/ideal-postcodes/uk-clear-addressing-bundled/workflows/Release/badge.svg)

This package exports polyfilled, minified copies of `uk-clear-addressing` in various formats available on npm and various JavaScript CDNs. It can be readily [dropped in](#usage) on a page.

This package is a transpiled copy of [`uk-clear-addressing`](https://github.com/ideal-postcodes/uk-clear-addressing-bundled).

## Download

Latest and pinned versions of each bundle can be downloaded from [jsdelivr.com](https://www.jsdelivr.com).

### Latest Versions

- [umd.min.js@latest](https://cdn.jsdelivr.net/npm/@ideal-postcodes/uk-clear-addressing-bundled/dist/umd.min.js)

- [esm.min.js@latest](https://cdn.jsdelivr.net/npm/@ideal-postcodes/uk-clear-addressing-bundled/dist/esm.min.js)

## Documentation

### Usage

#### UMD

```html

  var Address = IdealPostcodes.default.Address;

  let address = new Address({

    postcode: "WS11 5SB",

    post_town: "CANNOCK",

    thoroughfare: "Pye Green Road",

    building_name: "Flower House 189A",

    organisation_name: "S D Alcott Florists",

  });

```

#### ES Module

```html

  import IdealPostcodes from "https://cdn.jsdelivr.net/npm/@ideal-postcodes/uk-clear-addressing-bundled/dist/esm.min.js";

  let address = new IdealPostcodes.Address({

    postcode: "WS11 5SB",

    post_town: "CANNOCK",

    thoroughfare: "Pye Green Road",

    building_name: "Flower House 189A",

    organisation_name: "S D Alcott Florists",

  });

```

## Licence

MIT