diff --git a/.gitignore b/.gitignore index df34fbd..fbd3d6c 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,7 @@ node_modules npm-debug.log .DS_Store .vscode -.package-lock.json +package-lock.json # Test tests/reports diff --git a/README.md b/README.md index a5d4b91..1b1ad0e 100644 --- a/README.md +++ b/README.md @@ -92,29 +92,29 @@ Or include Choices directly: return `Only ${maxItemCount} values can be added.`; }, classNames: { - containerOuter: 'choices', - containerInner: 'choices__inner', - input: 'choices__input', - inputCloned: 'choices__input--cloned', - list: 'choices__list', - listItems: 'choices__list--multiple', - listSingle: 'choices__list--single', - listDropdown: 'choices__list--dropdown', - item: 'choices__item', - itemSelectable: 'choices__item--selectable', - itemDisabled: 'choices__item--disabled', - itemChoice: 'choices__item--choice', - group: 'choices__group', - groupHeading : 'choices__heading', - button: 'choices__button', - activeState: 'is-active', - focusState: 'is-focused', - openState: 'is-open', - disabledState: 'is-disabled', - highlightedState: 'is-highlighted', - hiddenState: 'is-hidden', - flippedState: 'is-flipped', - loadingState: 'is-loading', + containerOuter: 'choices', + containerInner: 'choices__inner', + input: 'choices__input', + inputCloned: 'choices__input--cloned', + list: 'choices__list', + listItems: 'choices__list--multiple', + listSingle: 'choices__list--single', + listDropdown: 'choices__list--dropdown', + item: 'choices__item', + itemSelectable: 'choices__item--selectable', + itemDisabled: 'choices__item--disabled', + itemChoice: 'choices__item--choice', + group: 'choices__group', + groupHeading : 'choices__heading', + button: 'choices__button', + activeState: 'is-active', + focusState: 'is-focused', + openState: 'is-open', + disabledState: 'is-disabled', + highlightedState: 'is-highlighted', + hiddenState: 'is-hidden', + flippedState: 'is-flipped', + loadingState: 'is-loading', }, // Choices uses the great Fuse library for searching. You // can find more options here: https://github.com/krisk/Fuse#options @@ -165,7 +165,10 @@ Pass an array of objects: { value: 'Value 2', label: 'Label 2', - id: 2 + id: 2, + customProperties: { + random: 'I am a custom property' + } }] ``` @@ -190,6 +193,10 @@ Pass an array of objects: label: 'Option 2', selected: false, disabled: true, + customProperties: { + description: 'Custom description about Option 2', + random: 'Another random custom property' + }, }] ``` @@ -269,7 +276,7 @@ Pass an array of objects: **Input types affected:**`select-one`, `select-multiple` -**Usage:** Specify which fields should be used when a user is searching. +**Usage:** Specify which fields should be used when a user is searching. If you have added custom properties to your choices, you can add these values thus: `['label', 'value', 'customProperties.example']`. ### searchFloor **Type:** `Number` **Default:** `1` @@ -325,9 +332,9 @@ Pass an array of objects: ```js // Sorting via length of label from largest to smallest const example = new Choices(element, { - sortFilter: function(a, b) { - return b.label.length - a.label.length; - }, + sortFilter: function(a, b) { + return b.label.length - a.label.length; + }, }; ``` @@ -406,29 +413,29 @@ const example = new Choices(element, { ``` classNames: { - containerOuter: 'choices', - containerInner: 'choices__inner', - input: 'choices__input', - inputCloned: 'choices__input--cloned', - list: 'choices__list', - listItems: 'choices__list--multiple', - listSingle: 'choices__list--single', - listDropdown: 'choices__list--dropdown', - item: 'choices__item', - itemSelectable: 'choices__item--selectable', - itemDisabled: 'choices__item--disabled', - itemOption: 'choices__item--choice', - group: 'choices__group', - groupHeading : 'choices__heading', - button: 'choices__button', - activeState: 'is-active', - focusState: 'is-focused', - openState: 'is-open', - disabledState: 'is-disabled', - highlightedState: 'is-highlighted', - hiddenState: 'is-hidden', - flippedState: 'is-flipped', - selectedState: 'is-highlighted', + containerOuter: 'choices', + containerInner: 'choices__inner', + input: 'choices__input', + inputCloned: 'choices__input--cloned', + list: 'choices__list', + listItems: 'choices__list--multiple', + listSingle: 'choices__list--single', + listDropdown: 'choices__list--dropdown', + item: 'choices__item', + itemSelectable: 'choices__item--selectable', + itemDisabled: 'choices__item--disabled', + itemOption: 'choices__item--choice', + group: 'choices__group', + groupHeading : 'choices__heading', + button: 'choices__button', + activeState: 'is-active', + focusState: 'is-focused', + openState: 'is-open', + disabledState: 'is-disabled', + highlightedState: 'is-highlighted', + hiddenState: 'is-hidden', + flippedState: 'is-flipped', + selectedState: 'is-highlighted', } ``` @@ -465,14 +472,14 @@ const example = new Choices(element, {
★ ${data.label}
- `); + `); }, choice: (data) => { return template(`
0 ? 'role="treeitem"' : 'role="option"'}> - ★ ${data.label} -
- `); + ★ ${data.label} + + `); }, }; } @@ -506,7 +513,6 @@ example.passedElement.addEventListener('addItem', function(event) { console.log(event.detail.label); console.log(event.detail.groupValue); }, false); - ``` ### addItem @@ -574,12 +580,14 @@ Methods can be called either directly or by chaining: const choices = new Choices(element, { addItems: false, removeItems: false, -}).setValue(['Set value 1', 'Set value 2']).disable(); + }) + .setValue(['Set value 1', 'Set value 2']) + .disable(); // Calling a method directly const choices = new Choices(element, { - addItems: false, - removeItems: false, + addItems: false, + removeItems: false, }); choices.setValue(['Set value 1', 'Set value 2']) @@ -648,7 +656,7 @@ choices.disable(); ### setChoices(choices, value, label, replaceChoices); **Input types affected:** `select-one`, `select-multiple` -**Usage:** Set choices of select input via an array of objects, a value name and a label name. This behaves the same as passing items via the `choices` option but can be called after initialising Choices. This can also be used to add groups of choices (see example 2); Optionally pass a true `replaceChoices` value to remove any existing choices. +**Usage:** Set choices of select input via an array of objects, a value name and a label name. This behaves the same as passing items via the `choices` option but can be called after initialising Choices. This can also be used to add groups of choices (see example 2); Optionally pass a true `replaceChoices` value to remove any existing choices. Optionally pass a `customProperties` object to add additional data to your choices (useful when searching/filtering etc). **Example 1:** @@ -656,9 +664,9 @@ choices.disable(); const example = new Choices(element); example.setChoices([ - {value: 'One', label: 'Label One', disabled: true}, - {value: 'Two', label: 'Label Two', selected: true}, - {value: 'Three', label: 'Label Three'}, + {value: 'One', label: 'Label One', disabled: true}, + {value: 'Two', label: 'Label Two', selected: true}, + {value: 'Three', label: 'Label Three'}, ], 'value', 'label', false); ``` @@ -668,24 +676,27 @@ example.setChoices([ const example = new Choices(element); example.setChoices([{ - label: 'Group one', - id: 1, - disabled: false, - choices: [ - {value: 'Child One', label: 'Child One', selected: true}, - {value: 'Child Two', label: 'Child Two', disabled: true}, - {value: 'Child Three', label: 'Child Three'}, - ] + label: 'Group one', + id: 1, + disabled: false, + choices: [ + {value: 'Child One', label: 'Child One', selected: true}, + {value: 'Child Two', label: 'Child Two', disabled: true}, + {value: 'Child Three', label: 'Child Three'}, + ] }, { - label: 'Group two', - id: 2, - disabled: false, - choices: [ - {value: 'Child Four', label: 'Child Four', disabled: true}, - {value: 'Child Five', label: 'Child Five'}, - {value: 'Child Six', label: 'Child Six'}, - ] + label: 'Group two', + id: 2, + disabled: false, + choices: [ + {value: 'Child Four', label: 'Child Four', disabled: true}, + {value: 'Child Five', label: 'Child Five'}, + {value: 'Child Six', label: 'Child Six', customProperties: { + description: 'Custom description about child six', + random: 'Another random custom property' + }}, + ] }], 'value', 'label', false); ``` @@ -714,9 +725,9 @@ const example = new Choices(element); // via an array of objects example.setValue([ - {value: 'One', label: 'Label One'}, - {value: 'Two', label: 'Label Two'}, - {value: 'Three', label: 'Label Three'}, + {value: 'One', label: 'Label One'}, + {value: 'Two', label: 'Label Two'}, + {value: 'Three', label: 'Label Three'}, ]); // or via an array of strings @@ -732,11 +743,11 @@ example.setValue(['Four','Five','Six']); ```js const example = new Choices(element, { - choices: [ - {value: 'One', label: 'Label One'}, - {value: 'Two', label: 'Label Two', disabled: true}, - {value: 'Three', label: 'Label Three'}, - ], + choices: [ + {value: 'One', label: 'Label One'}, + {value: 'Two', label: 'Label Two', disabled: true}, + {value: 'Three', label: 'Label Three'}, + ], }); example.setValueByChoice('Two'); // Choice with value of 'Two' has now been selected. @@ -776,15 +787,15 @@ example.setValueByChoice('Two'); // Choice with value of 'Two' has now been sele var example = new Choices(element); example.ajax(function(callback) { - fetch(url) - .then(function(response) { - response.json().then(function(data) { - callback(data, 'value', 'label'); - }); - }) - .catch(function(error) { - console.log(error); - }); + fetch(url) + .then(function(response) { + response.json().then(function(data) { + callback(data, 'value', 'label'); + }); + }) + .catch(function(error) { + console.log(error); + }); }); ``` diff --git a/assets/scripts/src/choices.js b/assets/scripts/src/choices.js index 280d552..399f30b 100644 --- a/assets/scripts/src/choices.js +++ b/assets/scripts/src/choices.js @@ -871,7 +871,13 @@ class Choices { if (foundChoice) { if (!foundChoice.selected) { - this._addItem(foundChoice.value, foundChoice.label, foundChoice.id, foundChoice.groupId, foundChoice.customProperties); + this._addItem( + foundChoice.value, + foundChoice.label, + foundChoice.id, + foundChoice.groupId, + foundChoice.customProperties + ); } else if (!this.config.silent) { console.warn('Attempting to select choice already selected'); } @@ -2673,7 +2679,13 @@ class Choices { if (!item.value) { return; } - this._addItem(item.value, item.label, item.id); + this._addItem( + item.value, + item.label, + item.id, + undefined, + item.customProperties + ); } else if (itemType === 'String') { this._addItem(item); } diff --git a/index.html b/index.html index 330fa51..806713c 100644 --- a/index.html +++ b/index.html @@ -63,7 +63,7 @@ - + @@ -208,7 +208,8 @@ - + +

Try searching for 'fantastic'

@@ -306,7 +307,13 @@ }).removeActiveItems(); var textPresetVal = new Choices('#choices-text-preset-values', { - items: ['josh@joshuajohnson.co.uk', { value: 'joe@bloggs.co.uk', label: 'Joe Bloggs' } ], + items: ['Josh Johnson', { + value: 'joe@bloggs.co.uk', + label: 'Joe Bloggs', + customProperties: { + description: 'Joe Blogg is such a generic name' + } + }], }); var multipleDefault = new Choices(document.getElementById('choices-multiple-groups')); @@ -433,10 +440,13 @@ }], 'value', 'label'); var singleSelectedOpt = new Choices('#choices-single-selected-option', { + searchFields: ['label', 'value', 'customProperties.description'], choices: [ {value: 'One', label: 'Label One', selected: true}, {value: 'Two', label: 'Label Two', disabled: true}, - {value: 'Three', label: 'Label Three'}, + {value: 'Three', label: 'Label Three', customProperties: { + description: 'This option is fantastic' + }}, ], }).setValueByChoice('Two'); diff --git a/package.json b/package.json index 5fdff57..4ebf3f0 100644 --- a/package.json +++ b/package.json @@ -33,6 +33,7 @@ "babel-loader": "^6.2.4", "babel-preset-es2015": "^6.6.0", "concurrently": "^3.1.0", + "core-js": "^2.4.1", "csso": "^1.8.2", "es6-promise": "^3.2.1", "eslint": "^3.3.0", diff --git a/tests/spec/choices_spec.js b/tests/spec/choices_spec.js index e1b0169..3afafb2 100644 --- a/tests/spec/choices_spec.js +++ b/tests/spec/choices_spec.js @@ -1,38 +1,16 @@ import 'whatwg-fetch'; import 'es6-promise'; +import 'core-js/fn/object/assign'; import Choices from '../../assets/scripts/src/choices.js'; import itemReducer from '../../assets/scripts/src/reducers/items.js'; import choiceReducer from '../../assets/scripts/src/reducers/choices.js'; -import { addItem as addItemAction, addChoice as addChoiceAction } from '../../assets/scripts/src/actions/index.js'; - -if (typeof Object.assign != 'function') { - Object.assign = function (target, varArgs) { // .length of function is 2 - if (target == null) { // TypeError if undefined or null - throw new TypeError('Cannot convert undefined or null to object'); - } - - var to = Object(target); - - for (var index = 1; index < arguments.length; index++) { - var nextSource = arguments[index]; - - if (nextSource != null) { // Skip over if undefined or null - for (var nextKey in nextSource) { - // Avoid bugs when hasOwnProperty is shadowed - if (Object.prototype.hasOwnProperty.call(nextSource, nextKey)) { - to[nextKey] = nextSource[nextKey]; - } - } - } - } - return to; - }; -} +import { + addItem as addItemAction, + addChoice as addChoiceAction +} from '../../assets/scripts/src/actions/index.js'; describe('Choices', () => { - describe('should initialize Choices', () => { - beforeEach(function() { this.input = document.createElement('input'); this.input.type = 'text'; @@ -952,99 +930,113 @@ describe('Choices', () => { }); describe('should allow custom properties provided by the user on items or choices', function() { - it('should allow the user to supply custom properties for an item', function() { - var randomItem = { - id: 8999, - choiceId: 9000, - groupId: 9001, - value: 'value', - label: 'label', - customProperties: { - foo: 'bar' - } + it('should allow the user to supply custom properties for an item', function() { + const randomItem = { + id: 8999, + choiceId: 9000, + groupId: 9001, + value: 'value', + label: 'label', + customProperties: { + foo: 'bar' } + } - var expectedState = [{ - id: randomItem.id, - choiceId: randomItem.choiceId, - groupId: randomItem.groupId, - value: randomItem.value, - label: randomItem.label, - active: true, - highlighted: false, - customProperties: randomItem.customProperties - }]; + const expectedState = [{ + id: randomItem.id, + choiceId: randomItem.choiceId, + groupId: randomItem.groupId, + value: randomItem.value, + label: randomItem.label, + active: true, + highlighted: false, + customProperties: randomItem.customProperties + }]; - var action = addItemAction(randomItem.value, randomItem.label, randomItem.id, randomItem.choiceId, randomItem.groupId, randomItem.customProperties); + const action = addItemAction( + randomItem.value, + randomItem.label, + randomItem.id, + randomItem.choiceId, + randomItem.groupId, + randomItem.customProperties + ); - expect(itemReducer([], action)).toEqual(expectedState); - }); - - it('should allow the user to supply custom properties for a choice', function() { - var randomChoice = { - id: 123, - elementId: 321, - groupId: 213, - value: 'value', - label: 'label', - disabled: false, - customProperties: { - foo: 'bar' - } - } - - var expectedState = [{ - id: randomChoice.id, - elementId: randomChoice.elementId, - groupId: randomChoice.groupId, - value: randomChoice.value, - label: randomChoice.label, - disabled: randomChoice.disabled, - selected: false, - active: true, - score: 9999, - customProperties: randomChoice.customProperties - }]; - - var action = addChoiceAction(randomChoice.value, randomChoice.label, randomChoice.id, randomChoice.groupId, randomChoice.disabled, randomChoice.elementId, randomChoice.customProperties); - - expect(choiceReducer([], action)).toEqual(expectedState); - }); + expect(itemReducer([], action)).toEqual(expectedState); }); - describe('should allow custom properties provided by the user on items or choices', function() { - beforeEach(function() { - this.input = document.createElement('select'); - this.input.className = 'js-choices'; - this.input.setAttribute('multiple', ''); + it('should allow the user to supply custom properties for a choice', function() { + const randomChoice = { + id: 123, + elementId: 321, + groupId: 213, + value: 'value', + label: 'label', + disabled: false, + customProperties: { + foo: 'bar' + } + } - document.body.appendChild(this.input); - }); + const expectedState = [{ + id: randomChoice.id, + elementId: randomChoice.elementId, + groupId: randomChoice.groupId, + value: randomChoice.value, + label: randomChoice.label, + disabled: randomChoice.disabled, + selected: false, + active: true, + score: 9999, + customProperties: randomChoice.customProperties + }]; - afterEach(function() { - this.choices.destroy(); - }); + const action = addChoiceAction( + randomChoice.value, + randomChoice.label, + randomChoice.id, + randomChoice.groupId, + randomChoice.disabled, + randomChoice.elementId, + randomChoice.customProperties + ); - it('should allow the user to supply custom properties for a choice that will be inherited by the item when the user selects the choice', function() { - - var expectedCustomProperties = { - isBestOptionEver: true - }; - - this.choices = new Choices(this.input); - this.choices.setChoices([{ - value: '42', - label: 'My awesome choice', - selected: false, - disabled: false, - customProperties: expectedCustomProperties - }], 'value', 'label', true); - - this.choices.setValueByChoice('42'); - var selectedItems = this.choices.getValue(); - - expect(selectedItems.length).toBe(1); - expect(selectedItems[0].customProperties).toBe(expectedCustomProperties); - }); + expect(choiceReducer([], action)).toEqual(expectedState); }); + }); + + describe('should allow custom properties provided by the user on items or choices', function() { + beforeEach(function() { + this.input = document.createElement('select'); + this.input.className = 'js-choices'; + this.input.setAttribute('multiple', ''); + + document.body.appendChild(this.input); + }); + + afterEach(function() { + this.choices.destroy(); + }); + + it('should allow the user to supply custom properties for a choice that will be inherited by the item when the user selects the choice', function() { + const expectedCustomProperties = { + isBestOptionEver: true + }; + + this.choices = new Choices(this.input); + this.choices.setChoices([{ + value: '42', + label: 'My awesome choice', + selected: false, + disabled: false, + customProperties: expectedCustomProperties + }], 'value', 'label', true); + + this.choices.setValueByChoice('42'); + const selectedItems = this.choices.getValue(); + + expect(selectedItems.length).toBe(1); + expect(selectedItems[0].customProperties).toBe(expectedCustomProperties); + }); + }); });