Rename sortFields to searchFields for clarity

README.md

@@ -69,12 +69,12 @@ Or include Choices directly:
     search: true,
     searchChoices: true,
     searchFloor: 1,
+    searchFields: ['label', 'value'],
     position: 'auto',
     resetScrollPosition: true,
     regexFilter: null,
     shouldSort: true,
     sortFilter: () => {...},
-    sortFields: ['label', 'value'],
     placeholder: true,
     placeholderValue: null,
     prependValue: null,
@@ -251,7 +251,15 @@ Pass an array of objects:
 
 **Input types affected:** `select-one`
 
-**Usage:** Whether the plugin should filter the choices by input or not. If `false` the search event will be emited.
+**Usage:** Whether the plugin should filter the choices by input or not. If `false`, the search event will still emit.
+
+
+### searchFields
+**Type:** `Array/String` **Default:** `['label', 'value']`
+
+**Input types affected:**`select-one`, `select-multiple`
+
+**Usage:** Specify which fields should be used when a user is searching.
 
 ### searchFloor
 **Type:** `Number` **Default:** `1`
@@ -306,13 +314,6 @@ const example = new Choices(element, {
 };
 ```
 
-### sortFields
-**Type:** `Array/String` **Default:** `['label', 'value']`
-
-**Input types affected:**`select-one`, `select-multiple`
-
-**Usage:** Specify which fields should be used for sorting when a user is searching. If a user is not searching and sorting is enabled, only the choice's label will be sorted.
-
 ### placeholder
 **Type:** `Boolean` **Default:** `true`
 

assets/scripts/dist/choices.js

@@ -1,4 +1,4 @@
-/*! choices.js v2.7.7 | (c) 2017 Josh Johnson | https://github.com/jshjohnson/Choices#readme */ 
+/*! choices.js v2.7.7 | (c) 2017 Josh Johnson | https://github.com/jshjohnson/Choices#readme */
 (function webpackUniversalModuleDefinition(root, factory) {
 	if(typeof exports === 'object' && typeof module === 'object')
 		module.exports = factory();
@@ -131,7 +131,7 @@ return /******/ (function(modules) { // webpackBootstrap
 	      regexFilter: null,
 	      shouldSort: true,
 	      sortFilter: _utils.sortByAlpha,
-	      sortFields: ['label', 'value'],
+	      searchFields: ['label', 'value'],
 	      placeholder: true,
 	      placeholderValue: null,
 	      prependValue: null,
@@ -1409,7 +1409,7 @@ return /******/ (function(modules) { // webpackBootstrap
 	      if (newValue.length >= 1 && newValue !== currentValue + ' ') {
 	        var haystack = this.store.getChoicesFilteredBySelectable();
 	        var needle = newValue;
-	        var keys = (0, _utils.isType)('Array', this.config.sortFields) ? this.config.sortFields : [this.config.sortFields];
+	        var keys = (0, _utils.isType)('Array', this.config.searchFields) ? this.config.searchFields : [this.config.searchFields];
 	        var options = Object.assign(this.config.fuseOptions, { keys: keys });
 	        var fuse = new _fuse2.default(haystack, options);
 	        var results = fuse.search(needle);
@@ -4301,16 +4301,16 @@ return /******/ (function(modules) { // webpackBootstrap
 /* 18 */
 /***/ function(module, exports) {
 
-	module.exports = function(module) {
-		if(!module.webpackPolyfill) {
-			module.deprecate = function() {};
-			module.paths = [];
-			// module.parent = undefined by default
-			module.children = [];
-			module.webpackPolyfill = 1;
-		}
-		return module;
-	}
+	module.exports = function(module) {
+		if(!module.webpackPolyfill) {
+			module.deprecate = function() {};
+			module.paths = [];
+			// module.parent = undefined by default
+			module.children = [];
+			module.webpackPolyfill = 1;
+		}
+		return module;
+	}
 
 
 /***/ },
@@ -5729,4 +5729,4 @@ return /******/ (function(modules) { // webpackBootstrap
 /******/ ])
 });
 ;
-//# sourceMappingURL=choices.js.map
+//# sourceMappingURL=choices.js.map

assets/scripts/src/choices.js

@@ -62,12 +62,12 @@ class Choices {
       search: true,
       searchChoices: true,
       searchFloor: 1,
+      searchFields: ['label', 'value'],
       position: 'auto',
       resetScrollPosition: true,
       regexFilter: null,
       shouldSort: true,
       sortFilter: sortByAlpha,
-      sortFields: ['label', 'value'],
       placeholder: true,
       placeholderValue: null,
       prependValue: null,
@@ -1199,7 +1199,7 @@ class Choices {
     if (newValue.length >= 1 && newValue !== `${currentValue} `) {
       const haystack = this.store.getChoicesFilteredBySelectable();
       const needle = newValue;
-      const keys = isType('Array', this.config.sortFields) ? this.config.sortFields : [this.config.sortFields];
+      const keys = isType('Array', this.config.searchFields) ? this.config.searchFields : [this.config.searchFields];
       const options = Object.assign(this.config.fuseOptions, { keys });
       const fuse = new Fuse(haystack, options);
       const results = fuse.search(needle);

tests/spec/choices_spec.js

@@ -76,10 +76,10 @@ describe('Choices', () => {
       expect(this.choices.config.paste).toEqual(jasmine.any(Boolean));
       expect(this.choices.config.search).toEqual(jasmine.any(Boolean));
       expect(this.choices.config.searchFloor).toEqual(jasmine.any(Number));
+      expect(this.choices.config.searchFields).toEqual(jasmine.any(Array) || jasmine.any(String));
       expect(this.choices.config.position).toEqual(jasmine.any(String));
       expect(this.choices.config.regexFilter).toEqual(null);
       expect(this.choices.config.sortFilter).toEqual(jasmine.any(Function));
-      expect(this.choices.config.sortFields).toEqual(jasmine.any(Array) || jasmine.any(String));
       expect(this.choices.config.shouldSort).toEqual(jasmine.any(Boolean));
       expect(this.choices.config.placeholder).toEqual(jasmine.any(Boolean));
       expect(this.choices.config.placeholderValue).toEqual(null);