@ideal-postcodes/address-finder-bundled
v5.0.1
Published
JS bundles for Address Finder library
Downloads
301
Maintainers
Readme
JavaScript browser bundles for the Address Finder library
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 on a page without transpilation of address-finder
.
If you intend to incorporate the browser client in your own bundle, please use core-browser
in your package.json
.
Download
Download Latest Bundle
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 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 to pin a major version in production. E.g.
<script src="https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled@4"></script>
Links
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
- Default ES Module export
Usage
UMD
<script src="https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled@4"></script>
<script>
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",
},
});
</script>
ES Module
<script
type="module"
src="https://cdn.jsdelivr.net/npm/@ideal-postcodes/address-finder-bundled@4/dist/address-finder.esm.js"></script>
<script type="module">
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",
},
});
</script>
Client Documentation
This package is a transpiled copy of ideal-postcodes/address-finder
.
For a complete list of client methods, including low level resource methods, please see the address-finder documentation
Run Examples
Build, and serve example pages locally:
npm run build && \ # Build JS bundles
npm start # Start http server
For UMD demo visit http://localhost:8081/example/umd.html
For ES module demo visit http://localhost:8081/example/esm.html