Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ideal-postcodes/address-finder-bundled
JavaScript browser bundles for Address Finder library
https://github.com/ideal-postcodes/address-finder-bundled
address-finder
Last synced: 10 days ago
JSON representation
JavaScript browser bundles for Address Finder library
- Host: GitHub
- URL: https://github.com/ideal-postcodes/address-finder-bundled
- Owner: ideal-postcodes
- License: agpl-3.0
- Created: 2021-01-04T06:55:13.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T11:05:47.000Z (about 2 months ago)
- Last Synced: 2024-10-25T06:11:34.379Z (22 days ago)
- Topics: address-finder
- Language: TypeScript
- Homepage: https://ideal-postcodes.co.uk/address-finder
- Size: 3.56 MB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
> JavaScript browser bundles for the Address Finder library
[](https://badge.fury.io/js/%40ideal-postcodes%2Faddress-finder-bundled)
[](https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled/dist/)
[](https://bundlephobia.com/result?p=@ideal-postcodes/address-finder-bundled)
This package exports polyfilled, minified copies of `address-finder` in various formats available on npm and various JavaScript CDNs. It can be readily [dropped in](#usage) on a page without transpilation of `address-finder`.
If you intend to incorporate the browser client in your own bundle, please use [`core-browser`](https://github.com/ideal-postcodes/core-browser) in your `package.json`.
## Download
### Download Latest Bundle
- [address-finder.js](https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled/dist/address-finder.js)
Serving your own versioned copy is recommended. If a JavaScript CDN is used (e.g. jsDelivr, cdnjs), be sure to pin the version.
Use [address-finder.esm.js](https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled/dist/address-finder.esm.js) if you need a ES Module compatible build.
### ⚠️ Pinning Versions
It is important you pin your bundle version in production. Pulling directly from latest **will** cause your integration to fail at some point in the future.
For instance, follow the instructions on [jsdelivr.com/address-finder-bundled](https://www.jsdelivr.com/package/npm/@ideal-postcodes/address-finder-bundled) to pin a major version in production. E.g.
```html
```
## Links
- [Bundles Overview](#bundles-overview)
- [Usage](#usage)
- [Documentation](https://address-finder.ideal-postcodes.dev/)
- [npm](https://www.npmjs.com/package/@ideal-postcodes/address-finder-bundled)
- [GitHub Repository](https://github.com/ideal-postcodes/address-finder-bundled)
## Documentation
### Bundles Overview
#### address-finder.js
- **UMD compatible**
- Transpiles address-finder to target Internet Explorer 11 as minimum browser version
- Default export of the npm module
#### address-finder.esm.js
- **ES Module compatible**
- Targets browsers with [ES Module support](https://caniuse.com/#search=module)
- Default ES Module export
### Usage
#### UMD
```html
IdealPostcodes.AddressFinder.setup({
apiKey: "ak_test",
inputField: "#line_1",
outputFields: {
line_1: "#line_1",
line_2: "#line_2",
line_3: "#line_3",
post_town: "#post_town",
postcode: "#postcode",
},
});
```
#### ES Module
```html
import { AddressFinder } from "https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled@2/dist/address-finder.esm.js";
AddressFinder.setup({
apiKey: "ak_test",
inputField: "#line_1",
outputFields: {
line_1: "#line_1",
line_2: "#line_2",
line_3: "#line_3",
post_town: "#post_town",
postcode: "#postcode",
},
});
```
### Client Documentation
This package is a transpiled copy of [`ideal-postcodes/address-finder`](https://www.npmjs.com/package/@ideal-postcodes/address-finder).
For a complete list of client methods, including low level resource methods, please see the [address-finder documentation](https://address-finder.ideal-postcodes.dev/#documentation)
## Run Examples
Build, and serve example pages locally:
```bash
npm run build && \ # Build JS bundles
npm start # Start http server
```
For UMD demo visit [http://localhost:8081/example/umd.html](http://localhost:8081/example/umd.html)
For ES module demo visit [http://localhost:8081/example/esm.html](http://localhost:8081/example/esm.html)