Merge pull request #13 from ideal-postcodes/3.0.5

3.0.5

Author: cblanc

.gitignore

@@ -0,0 +1 @@
+node_modules/

.npmignore

@@ -0,0 +1,3 @@
+examples/
+test/
+libs/

.travis.yml

@@ -1,4 +1,4 @@
 language: node_js
 node_js:
-  - 0.10
+  - 6.9
 before_install: npm install -g grunt-cli

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [3.0.5] 2017-11-02
+- Added placeholder to input field. The placeholder is determined by the `placeholder_label` attribute
+- Added `onDropdownDestroyed` destroyed callback, invoked when dropdown is removed from DOM following a new search
+
 ## [3.0.4] 2016-07-29
 - Added shouldLookupTrigger callback
 

Gruntfile.js

@@ -39,7 +39,7 @@ module.exports = function(grunt) {
       '<%= grunt.template.today("yyyy-mm-dd") %>\n' +
       '<%= pkg.homepage ? "* " + pkg.homepage + "\\n" : "" %>' +
       '<%= grunt.template.today("yyyy") %> <%= pkg.author.name %>;' +
-      ' Licensed <%= _.pluck(pkg.licenses, "type").join(", ") %> */\n',
+      ' Licensed <%= _.map(pkg.licenses, "type").join(", ") %> */\n',
     // Task configuration.
     clean: {
       files: ['dist']

README.md

@@ -64,7 +64,15 @@ Run automated tests with
 grunt test
 ```
 
-Please use jQuery 1.9.x or higher. This plugin has been tested against jQuery 1.9.x, 1.10.x, 1.11.x, 2.0.x, 2.1.x, 2.2.x and 3.0.x
+Please use jQuery 1.9.x or higher. This plugin has been tested against jQuery 1.9.x, 1.10.x, 1.11.x, 2.0.x, 2.1.x, 2.2.x, 3.0.x. 3.1.x and 3.2.x
+
+You may run the plugin locally and test in your browser
+
+```bash
+$ npm start # starts a HTTP server
+
+# Navigate to the `examples` folder and select an example in a *.html file
+```
 
 Our test postcodes are:
 - **ID1 1QD** Returns a successful postcode lookup response (2000)

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "jquery.postcodes",
-  "version": "3.0.4",
+  "version": "3.0.5",
   "authors": [
     "support@ideal-postcodes.co.uk"
   ],

dist/postcodes.js

@@ -1,6 +1,6 @@
-/*! Ideal Postcodes jQuery Plugin - v3.0.4 - 2016-07-29
+/*! Ideal Postcodes jQuery Plugin - v3.0.5 - 2017-11-16
 * https://github.com/ideal-postcodes/jquery.postcodes
-2016 Ideal Postcodes; Licensed MIT */
+2017 Ideal Postcodes; Licensed MIT */
 (function($) {
   "use strict";
   // Cache for all new instances of the plugin
@@ -52,6 +52,7 @@
     input: undefined,
     $input: undefined,
     input_label: "Please enter your postcode",
+    placeholder_label: "",
     input_muted_style: "color:#CBCBCB;",
     input_class: "",
     input_id: "idpc_input",
@@ -130,6 +131,7 @@
     onAddressesRetrieved: undefined,  // When a lookup succeeds with a list of addresses
     onAddressSelected: undefined,     // User has clicked an address in dropdown
     onDropdownCreated: undefined,     // When the address selection dropdown is inserted to DOM
+    onDropdownDestroyed: undefined,   // When the address selection dropdown is removed (following new search)
     onLookupTriggered: undefined,     // When user clicks the button to trigger a lookup
     shouldLookupTrigger: undefined,   // 
     onSearchError: undefined,         // When a request succeeds but the API returns an error code
@@ -138,6 +140,22 @@
     tags: undefined
   };
 
+  /* 
+   * Utility method to remove organisation from Address result
+   *
+   * All organisations will have their name as first line
+   */
+  var removeOrganisation = function (address) {
+    if (address.organisation_name.length !== 0 &&
+        (address.line_1 === address.organisation_name)) {
+      // Shift addresses up
+      address.line_1 = address.line_2;
+      address.line_2 = address.line_3;
+      address.line_3 = "";
+    }
+    return address;
+  };
+
   function AddressFinderController (options) {
     // Load in defaults
     this.config = {};
@@ -183,7 +201,8 @@
       this.$input = $('<input />', {
         type: "text",
         id: this.input_id,
-        value: this.input_label
+        value: this.input_label,
+        placeholder: this.placeholder_label
       })
       .appendTo(this.$context)
       .addClass(this.input_class)
@@ -443,6 +462,9 @@
     if (this.$dropdown && this.$dropdown.length) {
       this.$dropdown.remove();
       delete this.$dropdown;
+      if (this.onDropdownDestroyed) {
+        this.onDropdownDestroyed.call(this);
+      }
     }
 
     if (!data) {
@@ -548,23 +570,6 @@
     }
   };
 
-  /* 
-   * Utility method to remove organisation from Address result
-   *
-   * All organisations will have their name as first line
-   */
-
-  var removeOrganisation = function (address) {
-    if (address.organisation_name.length !== 0 &&
-        (address.line_1 === address.organisation_name)) {
-      // Shift addresses up
-      address.line_1 = address.line_2;
-      address.line_2 = address.line_3;
-      address.line_3 = "";
-    }
-    return address;
-  };
-
   var extractError = function (data) {
     return data.code + " - " + data.message;
   };

dist/postcodes.min.js

@@ -3,6 +3,7 @@
 <head>
   <meta charset="utf-8">
   <title>Ideal Postcodes Example</title>
+  <LINK href="styling.css" rel="stylesheet" type="text/css">
   <LINK href="bootstrap.css" rel="stylesheet" type="text/css">
 	<LINK href="bootstrap-theme.css" rel="stylesheet" type="text/css">
 	<script src="//code.jquery.com/jquery-1.9.1.min.js"></script>