> JavaScript browser bundles for the Postcode Lookup library ![CI](https://github.com/ideal-postcodes/postcode-lookup-bundled/workflows/CI/badge.svg) ![Cross Browser Testing](https://github.com/ideal-postcodes/postcode-lookup-bundled/workflows/Cross%20Browser%20Testing/badge.svg) [![npm version](https://badge.fury.io/js/%40ideal-postcodes%2Fpostcode-lookup-bundled.svg)](https://badge.fury.io/js/%40ideal-postcodes%2Fpostcode-lookup-bundled) [![jscdn](https://badgen.net/jsdelivr/v/npm/@ideal-postcodes/postcode-lookup-bundled)](https://cdn.jsdelivr.net/npm/@ideal-postcodes/postcode-lookup-bundled/dist/) ![Release](https://github.com/ideal-postcodes/postcode-lookup-bundled/workflows/Release/badge.svg) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/@ideal-postcodes/postcode-lookup-bundled)](https://bundlephobia.com/result?p=@ideal-postcodes/postcode-lookup-bundled) This package exports polyfilled, minified copies of `postcode-lookup` in various formats available on npm and various JavaScript cdns. It can be readily [dropped in](#usage) on a page without transpilation of `postcode-lookup`. If you intend to incorporate the browser client in your own bundle, please use [`postcode-lookup`](https://github.com/ideal-postcodes/postcode-lookup) as your `package.json` dependency. ## Download ### Download Latest Bundle - [postcode-lookup.js](https://cdn.jsdelivr.net/npm/@ideal-postcodes/postcode-lookup-bundled/dist/postcode-lookup.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 [postcode-lookup.esm.js](https://cdn.jsdelivr.net/npm/@ideal-postcodes/postcode-lookup-bundled/dist/postcode-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/postcode-lookup-bundled](https://www.jsdelivr.com/package/npm/@ideal-postcodes/postcode-lookup-bundled) to pin a specific version in production. E.g. ```html ``` ## Links - [Bundles Overview](#bundles-overview) - [Usage](#usage) - [Documentation](https://postcode-lookup.ideal-postcodes.dev/) - [npm](https://www.npmjs.com/package/@ideal-postcodes/postcode-lookup-bundled) - [GitHub Repository](https://github.com/ideal-postcodes/postcode-lookup-bundled) ## Documentation ### Bundles Overview #### postcode-lookup.js - **UMD compatible** - Transpiles postcode-lookup to target IE11 as minimum browser version - Default export of the npm module #### postcode-lookup.esm.js - **ES Module compatible** - Targets browsers with [ES Module support](https://caniuse.com/#search=module) - Default ES Module export ### Usage #### UMD ```html ``` #### ES Module ```html ``` ### Client Documentation This package is a transpiled copy of [`ideal-postcodes/postcode-lookup`](https://github.com/ideal-postcodes/postcode-lookup). For a complete list of client methods, including low level resource methods, please see the [postcode-lookup documentation](https://postcode-lookup.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)