Added order handling to tie into custom sorting

bjorn2404 · bjorn2404 · commit 12565c80bf4f · 2018-09-06T23:55:58.000-05:00
diff --git a/bower.json b/bower.json
@@ -1,6 +1,6 @@
 {
   "name": "jquery-storelocator-plugin",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "This jQuery plugin takes advantage of Google Maps API version 3 to create an easy to implement store locator. No back-end programming is required, you just need to feed it KML, XML, or JSON data with all the location information.",
   "repository": {
     "type": "git",
diff --git a/callbacks/callback-order.md b/callbacks/callback-order.md
@@ -0,0 +1,11 @@
+# callbackOrder
+
+## Description
+
+Fires when a new order option is selected.
+
+## Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| sortObj | object | Sorting object properties: method, order, and prop. |
diff --git a/callbacks/callback-sorting.md b/callbacks/callback-sorting.md
@@ -8,4 +8,4 @@ Fires when a new sorting method is selected.
 
 | Name | Type | Description |
 |---|---|---|
-| sortObj | object | Sorting object properties: method, order, and prop. |
+| order | string | Order string value - asc or desc. |
diff --git a/dist/assets/js/plugins/storeLocator/jquery.storelocator.js b/dist/assets/js/plugins/storeLocator/jquery.storelocator.js
@@ -1,4 +1,4 @@
-/*! jQuery Google Maps Store Locator - v3.0.0 - 2018-05-06
+/*! jQuery Google Maps Store Locator - v3.0.1 - 2018-09-06
 * http://www.bjornblog.com/web/jquery-store-locator-plugin
 * Copyright (c) 2018 Bjorn Holine; Licensed MIT */
 
@@ -90,6 +90,7 @@
 		'maxDistanceID'              : 'bh-sl-maxdistance',
 		'modalContent'               : 'bh-sl-modal-content',
 		'modalWindow'                : 'bh-sl-modal-window',
+		'orderID'                    : 'bh-sl-order',
 		'overlay'                    : 'bh-sl-overlay',
 		'regionID'                   : 'bh-sl-region',
 		'searchID'                   : 'bh-sl-search',
@@ -121,6 +122,7 @@
 		'callbackNearestLoc'         : null,
 		'callbackNoResults'          : null,
 		'callbackNotify'             : null,
+		'callbackOrder'              : null,
 		'callbackPageChange'         : null,
 		'callbackRegion'             : null,
 		'callbackSorting'            : null,
@@ -196,8 +198,9 @@
 				this.taxonomyFiltering();
 			}
 
-			// Do sorting if set.
+			// Do sorting and ordering if set.
 			this.sorting();
+			this.order();
 
 			// Add modal window divs if set
 			if (this.settings.modal === true) {
@@ -1872,6 +1875,40 @@
 			});
 		},
 
+		/**
+		 * Set up front-end ordering functionality - this ties in to sorting and that has to be enabled for this to work.
+		 */
+		order: function() {
+			this.writeDebug('order',arguments);
+			var _this = this,
+				$mapDiv = $('#' + _this.settings.mapID),
+				$orderSelect = $('#' + _this.settings.orderID);
+
+			if ($orderSelect.length === 0) {
+				return;
+			}
+
+			$orderSelect.on('change.'+pluginName, function (e) {
+				e.stopPropagation();
+
+				// Reset pagination.
+				if (_this.settings.pagination === true) {
+					_this.paginationChange(0);
+				}
+
+				_this.settings.sortBy.order = $(this).val();
+
+				// Callback
+				if (_this.settings.callbackOrder) {
+					_this.settings.callbackOrder.call(this, _this.settings.order);
+				}
+
+				if ($mapDiv.hasClass('bh-sl-map-open')) {
+					_this.mapping(mappingObj);
+				}
+			});
+		},
+
 		/**
 		 * Count the selected filters
 		 *
diff --git a/dist/assets/js/plugins/storeLocator/jquery.storelocator.min.js b/dist/assets/js/plugins/storeLocator/jquery.storelocator.min.js
diff --git a/dist/sort-example.html b/dist/sort-example.html
@@ -28,6 +28,12 @@ <h1 class="bh-sl-title">Using Chipotle as an Example</h1>
                     <option data-method="numeric" value="address">Address</option>
                     <option data-method="numeric" value="distance">Distance</option>
                 </select>
+
+                <label for="bh-sl-order">Order:</label>
+                <select id="bh-sl-order" name="bh-sl-order">
+                    <option value="asc">Ascending</option>
+                    <option value="desc">Descending</option>
+                </select>
             </div>
 
             <button id="bh-sl-submit" type="submit">Submit</button>
diff --git a/options.md b/options.md
@@ -73,6 +73,7 @@
 | maxDistanceID | 'bh-sl-maxdistance' | ID of the select element for the maximum distance options. |
 | modalContent | 'bh-sl-modal-content' | Class of element container around the content of the modal window. |
 | modalWindow | 'bh-sl-modal-window' | Class of element of the actual modal window |
+| orderID | 'bh-sl-order' | ID of the select form field for custom sort order handling of location results. |
 | overlay | 'bh-sl-overlay' | Class of element that fills 100% of the window and fills with a transparent background image. |
 | regionID | 'bh-sl-region' | ID of the region select form field for country region biasing. |
 | searchID | 'bh-sl-search' | ID of the search input form field for location name searching. |
@@ -111,6 +112,7 @@
 | [callbackNearestLoc](callbacks/callback-nearestloc.md) | null | Nearest location callback |
 | [callbackNoResults](callbacks/callback-noresults.md) | null | No results callback |
 | [callbackNotify](callbacks/callback-notification.md) | null | Notification callback |
+| [callbackNotify](callbacks/callback-order.md) | null | Order callback |
 | [callbackPageChange](callbacks/callback-pagechange.md) | null | Page change callback |
 | [callbackRegion](callbacks/callback-region.md) | null | Region callback |
 | [callbackSorting](callbacks/callback-sorting.md) | null | Sorting callback |
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "jquery-storelocator-plugin",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "This jQuery plugin takes advantage of Google Maps API version 3 to create an easy to implement store locator. No back-end programming is required, you just need to feed it KML, XML, or JSON data with all the location information.",
   "repository": {
     "type": "git",
diff --git a/readme.md b/readme.md
@@ -35,6 +35,11 @@ filtering.
 
 ## Changelog
 
+### Version 3.0.1
+
+* Added custom order handling to tie into previously added custom sorting. Set order to asc or desc.
+* Updated sort-example.html example with order select field.
+
 ### Version 3.0.0
 
 Version 3 has a breaking change with the dataLocation and dataType settings switching the default from XML to JSON.
diff --git a/src/js/jquery.storelocator.js b/src/js/jquery.storelocator.js
@@ -86,6 +86,7 @@
 		'maxDistanceID'              : 'bh-sl-maxdistance',
 		'modalContent'               : 'bh-sl-modal-content',
 		'modalWindow'                : 'bh-sl-modal-window',
+		'orderID'                    : 'bh-sl-order',
 		'overlay'                    : 'bh-sl-overlay',
 		'regionID'                   : 'bh-sl-region',
 		'searchID'                   : 'bh-sl-search',
@@ -117,6 +118,7 @@
 		'callbackNearestLoc'         : null,
 		'callbackNoResults'          : null,
 		'callbackNotify'             : null,
+		'callbackOrder'              : null,
 		'callbackPageChange'         : null,
 		'callbackRegion'             : null,
 		'callbackSorting'            : null,
@@ -192,8 +194,9 @@
 				this.taxonomyFiltering();
 			}
 
-			// Do sorting if set.
+			// Do sorting and ordering if set.
 			this.sorting();
+			this.order();
 
 			// Add modal window divs if set
 			if (this.settings.modal === true) {
@@ -1868,6 +1871,40 @@
 			});
 		},
 
+		/**
+		 * Set up front-end ordering functionality - this ties in to sorting and that has to be enabled for this to work.
+		 */
+		order: function() {
+			this.writeDebug('order',arguments);
+			var _this = this,
+				$mapDiv = $('#' + _this.settings.mapID),
+				$orderSelect = $('#' + _this.settings.orderID);
+
+			if ($orderSelect.length === 0) {
+				return;
+			}
+
+			$orderSelect.on('change.'+pluginName, function (e) {
+				e.stopPropagation();
+
+				// Reset pagination.
+				if (_this.settings.pagination === true) {
+					_this.paginationChange(0);
+				}
+
+				_this.settings.sortBy.order = $(this).val();
+
+				// Callback
+				if (_this.settings.callbackOrder) {
+					_this.settings.callbackOrder.call(this, _this.settings.order);
+				}
+
+				if ($mapDiv.hasClass('bh-sl-map-open')) {
+					_this.mapping(mappingObj);
+				}
+			});
+		},
+
 		/**
 		 * Count the selected filters
 		 *
diff --git a/storelocator.jquery.json b/storelocator.jquery.json
@@ -3,7 +3,7 @@
     "title": "jQuery Google Maps Store Locator",
     "description": "This jQuery plugin takes advantage of Google Maps API version 3 to create an easy to implement store locator. No back-end programming is required, you just need to feed it KML, XML, or JSON data with all the location information.",
     "keywords": ["jquery","locator","store","dealer","location", "locations", "maps", "map", "stores", "find"],
-    "version": "3.0.0",
+    "version": "3.0.1",
     "author": {
         "name": "Bjorn Holine",
         "url": "http://www.bjornblog.com/"

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "jquery-storelocator-plugin",`
`3`		`- "version": "3.0.0",`
	`3`	`+ "version": "3.0.1",`
`4`	`4`	`"description": "This jQuery plugin takes advantage of Google Maps API version 3 to create an easy to implement store locator. No back-end programming is required, you just need to feed it KML, XML, or JSON data with all the location information.",`
`5`	`5`	`"repository": {`
`6`	`6`	`"type": "git",`