@addresszen/address-lookup

    2.0.0 • Public • Published

    AddressZen Address Lookup Bundle

    JavaScript browser bundles for the Address Lookup library

    CI Release

    This package exports polyfilled, minified copies of address-lookup in various formats available on npm and various JavaScript CDNs. It can be readily dropped in on a page without transpilation of address-lookup.

    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-lookup.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-lookup to pin a major version in production. E.g.

    <script src="https://cdn.jsdelivr.net/npm/@addresszen/address-lookup@1></script>
    

    Links

    Documentation

    Bundles Overview

    address-lookup.js

    • UMD compatible
    • Transpiles address-lookup to target Internet Explorer 11 as minimum browser version
    • Default export of the npm module

    address-lookup.esm.js

    • ES Module compatible
    • Targets browsers with ES Module support
    • Default ES Module export

    Usage

    UMD

    <script src="https://cdn.jsdelivr.net/npm/@addresszen/address-lookup@1"></script>
    
    <script>
      AddressZen.AddressLookup.setup({
        apiKey: "iddqd",
        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/@addresszen/address-lookup@1/dist/address-lookup.esm.js"
    ></script>
    
    <script type="module">
      import { AddressLookup } from "https://cdn.jsdelivr.net/npm/@addresszen/address-lookup@1/dist/address-lookup.esm.js";
      AddressLookup.setup({
        apiKey: "iddqd",
        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

    For a complete list of client methods, including low level resource methods, please see the address-lookup 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

    Install

    npm i @addresszen/address-lookup

    DownloadsWeekly Downloads

    23

    Version

    2.0.0

    License

    AGPL-3.0

    Unpacked Size

    191 kB

    Total Files

    6

    Last publish

    Collaborators

    • cablanchard