mirror of
https://github.com/Choices-js/Choices.git
synced 2024-05-17 13:06:34 +02:00
1228 lines
41 KiB
JavaScript
1228 lines
41 KiB
JavaScript
'use strict';
|
|
|
|
import { createStore } from 'redux';
|
|
import rootReducer from './reducers/index.js';
|
|
import { addItem, removeItem, selectItem, addOption, filterOptions, activateOptions, addGroup } from './actions/index';
|
|
import { isScrolledIntoView, getAdjacentEl, findAncestor, wrap, isType, strToEl, extend, getWidthOfInput, debounce } from './lib/utils.js';
|
|
import Fuse from 'fuse.js';
|
|
|
|
/**
|
|
* Choices
|
|
*
|
|
* To do:
|
|
* - Remove item by clicking a target
|
|
* - Set input width based on the size of the contents
|
|
* - Single select input support
|
|
* - Populate options by function
|
|
*/
|
|
export class Choices {
|
|
constructor(element = '[data-choice]', userOptions = {}) {
|
|
|
|
// Cutting the mustard
|
|
const cuttingTheMustard = 'querySelector' in document && 'addEventListener' in document && 'classList' in document.createElement("div");
|
|
if (!cuttingTheMustard) console.error('init: Your browser doesn\'t support Choices');
|
|
|
|
// If there are multiple elements, create a new instance
|
|
// for each element besides the first one (as that already has an instance)
|
|
if(isType('String', element)) {
|
|
const elements = document.querySelectorAll(element);
|
|
if(elements.length > 1) {
|
|
for (let i = 1; i < elements.length; i++) {
|
|
const el = elements[i];
|
|
new Choices(el, userOptions);
|
|
}
|
|
}
|
|
}
|
|
|
|
const defaultOptions = {
|
|
items: [],
|
|
addItems: true,
|
|
removeItems: true,
|
|
editItems: false,
|
|
maxItems: false,
|
|
delimiter: ',',
|
|
allowDuplicates: true,
|
|
allowPaste: true,
|
|
allowSearch: true,
|
|
regexFilter: false,
|
|
placeholder: true,
|
|
placeholderValue: '',
|
|
prependValue: false,
|
|
appendValue: false,
|
|
selectAll: true,
|
|
classNames: {
|
|
containerOuter: 'choices',
|
|
containerInner: 'choices__inner',
|
|
input: 'choices__input',
|
|
inputCloned: 'choices__input--cloned',
|
|
list: 'choices__list',
|
|
listItems: 'choices__list--items',
|
|
listDropdown: 'choices__list--dropdown',
|
|
item: 'choices__item',
|
|
itemSelectable: 'choices__item--selectable',
|
|
itemDisabled: 'choices__item--disabled',
|
|
itemOption: 'choices__item--option',
|
|
group: 'choices__group',
|
|
groupHeading : 'choices__heading',
|
|
activeState: 'is-active',
|
|
disabledState: 'is-disabled',
|
|
highlightedState: 'is-highlighted',
|
|
hiddenState: 'is-hidden',
|
|
flippedState: 'is-flipped',
|
|
selectedState: 'is-selected'
|
|
},
|
|
templates: {},
|
|
callbackOnInit: function() {},
|
|
callbackOnRender: function() {},
|
|
callbackOnRemoveItem: function() {},
|
|
callbackOnAddItem: function() {}
|
|
};
|
|
|
|
// Initial instance state
|
|
this.initialised = false;
|
|
|
|
// Merge options with user options
|
|
this.options = extend(defaultOptions, userOptions);
|
|
|
|
// Create data store
|
|
this.store = createStore(rootReducer);
|
|
|
|
// Retrieve triggering element (i.e. element with 'data-choice' trigger)
|
|
this.passedElement = isType('String', element) ? document.querySelector(element) : element;
|
|
|
|
this.highlightPosition = 0;
|
|
|
|
// Set preset items - this looks out of place
|
|
this.presetItems = [];
|
|
if(this.options.items.length) {
|
|
this.presetItems = this.options.items;
|
|
} else if(this.passedElement.value !== '') {
|
|
this.presetItems = this.passedElement.value.split(this.options.delimiter);
|
|
}
|
|
|
|
// Bind methods
|
|
this.init = this.init.bind(this);
|
|
this.render = this.render.bind(this);
|
|
this.destroy = this.destroy.bind(this);
|
|
|
|
// Bind event handlers
|
|
this.onFocus = this.onFocus.bind(this);
|
|
this.onBlur = this.onBlur.bind(this);
|
|
this.onKeyUp = this.onKeyUp.bind(this);
|
|
this.onKeyDown = this.onKeyDown.bind(this);
|
|
this.onClick = this.onClick.bind(this);
|
|
this.onPaste = this.onPaste.bind(this);
|
|
this.onMouseOver = this.onMouseOver.bind(this);
|
|
|
|
// Let's have it large
|
|
this.init();
|
|
}
|
|
|
|
/**
|
|
* Process enter key event
|
|
* @param {Array} activeItems Items that are currently active
|
|
* @return
|
|
*/
|
|
handleEnter(activeItems, value) {
|
|
let canUpdate = true;
|
|
|
|
if(this.passedElement.type === 'text') {
|
|
if(this.options.addItems) {
|
|
if (this.options.maxItems && this.options.maxItems <= this.list.children.length) {
|
|
// If there is a max entry limit and we have reached that limit
|
|
// don't update
|
|
canUpdate = false;
|
|
} else if(this.options.allowDuplicates === false && this.passedElement.value) {
|
|
// If no duplicates are allowed, and the value already exists
|
|
// in the array, don't update
|
|
canUpdate = !activeItems.some((item) => {
|
|
return item.value === value;
|
|
});
|
|
}
|
|
} else {
|
|
canUpdate = false;
|
|
}
|
|
|
|
if (canUpdate) {
|
|
let canAddItem = true;
|
|
|
|
// If a user has supplied a regular expression filter
|
|
if(this.options.regexFilter) {
|
|
// Determine whether we can update based on whether
|
|
// our regular expression passes
|
|
canAddItem = this.regexFilter(value);
|
|
}
|
|
|
|
// All is good, add
|
|
if(canAddItem) {
|
|
this.addItem(value);
|
|
this.clearInput(this.passedElement);
|
|
}
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Process back space event
|
|
* @param {Array} Active items
|
|
* @return
|
|
*/
|
|
handleBackspaceKey(activeItems) {
|
|
if(this.options.removeItems && activeItems) {
|
|
const lastItem = activeItems[activeItems.length - 1];
|
|
const hasSelectedItems = activeItems.some((item) => {
|
|
return item.selected === true;
|
|
});
|
|
|
|
// If editing the last item is allowed and there are not other selected items,
|
|
// we can edit the item value. Otherwise if we can remove items, remove all selected items
|
|
if(this.options.editItems && !hasSelectedItems && lastItem) {
|
|
this.input.value = lastItem.value;
|
|
this.removeItem(lastItem);
|
|
} else {
|
|
this.selectItem(lastItem);
|
|
this.removeAllSelectedItems();
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Handle what happens on a click event
|
|
* @param {Array} activeItems Items that are active
|
|
* @param {HTMLElement} target What triggered the click
|
|
* @param {Boolean} hasShiftKey Whether shift key is active
|
|
* @return
|
|
*/
|
|
handleClick(activeItems, target, hasShiftKey) {
|
|
if(this.options.removeItems && target) {
|
|
const passedId = target.getAttribute('data-id');
|
|
|
|
// We only want to select one item with a click
|
|
// so we deselect any items that aren't the target
|
|
// unless shift is being pressed
|
|
activeItems.forEach((item) => {
|
|
if(item.id === parseInt(passedId) && !item.selected) {
|
|
this.selectItem(item);
|
|
} else if(!hasShiftKey) {
|
|
this.deselectItem(item);
|
|
}
|
|
});
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Key down event
|
|
* @param {Object} e Event
|
|
* @return
|
|
*/
|
|
onKeyDown(e) {
|
|
if(e.target !== this.input) return;
|
|
|
|
const ctrlDownKey = e.ctrlKey || e.metaKey;
|
|
const backKey = 46;
|
|
const deleteKey = 8;
|
|
const enterKey = 13;
|
|
const aKey = 65;
|
|
const escapeKey = 27;
|
|
const upKey = 38;
|
|
const downKey = 40;
|
|
|
|
const activeItems = this.getItemsFilteredByActive();
|
|
const activeOptions = this.getOptionsFilteredByActive();
|
|
|
|
const hasFocussedInput = this.input === document.activeElement;
|
|
const hasActiveDropdown = this.dropdown && this.dropdown.classList.contains(this.options.classNames.activeState);
|
|
const hasItems = this.list && this.list.children;
|
|
const keyString = String.fromCharCode(event.keyCode);
|
|
|
|
// If a user is typing and the dropdown is not active
|
|
if(/[a-zA-Z0-9-_ ]/.test(keyString) && this.dropdown && !hasActiveDropdown) {
|
|
this.toggleDropdown();
|
|
}
|
|
|
|
switch (e.keyCode) {
|
|
case aKey:
|
|
// If CTRL + A or CMD + A have been pressed and there are items to select
|
|
if(ctrlDownKey && hasItems) {
|
|
if(this.options.removeItems && !this.input.value && this.options.selectAll && this.input === document.activeElement) {
|
|
this.selectAll(this.list.children);
|
|
}
|
|
}
|
|
break;
|
|
|
|
case enterKey:
|
|
// If enter key is pressed and the input has a value
|
|
if(e.target.value && this.passedElement.type === 'text') {
|
|
const value = this.input.value;
|
|
this.handleEnter(activeItems, value);
|
|
}
|
|
|
|
if(this.passedElement.type === 'select-multiple' && hasActiveDropdown) {
|
|
const highlighted = this.dropdown.querySelector(`.${this.options.classNames.highlightedState}`);
|
|
|
|
if(highlighted) {
|
|
const value = highlighted.getAttribute('data-value');
|
|
const label = highlighted.innerHTML;
|
|
const id = highlighted.getAttribute('data-id');
|
|
this.addItem(value, label, id);
|
|
this.clearInput(this.passedElement);
|
|
}
|
|
}
|
|
break;
|
|
|
|
case escapeKey:
|
|
if(this.passedElement.type === 'select-multiple' && hasActiveDropdown) {
|
|
this.toggleDropdown();
|
|
}
|
|
break;
|
|
|
|
case downKey:
|
|
case upKey:
|
|
// If up or down key is pressed, traverse through options
|
|
if(this.passedElement.type === 'select-multiple' && hasActiveDropdown) {
|
|
const currentEl = this.dropdown.querySelector(`.${this.options.classNames.highlightedState}`);
|
|
const directionInt = e.keyCode === downKey ? 1 : -1;
|
|
let nextEl;
|
|
|
|
if(currentEl) {
|
|
nextEl = getAdjacentEl(currentEl, '[data-option-selectable]', directionInt);
|
|
} else {
|
|
nextEl = this.dropdown.querySelector('[data-option-selectable]');
|
|
}
|
|
|
|
if(nextEl) {
|
|
// We prevent default to stop the cursor moving
|
|
// when pressing the arrow
|
|
e.preventDefault();
|
|
if(!isScrolledIntoView(nextEl, this.dropdown, directionInt)) {
|
|
this.scrollToOption(nextEl, directionInt);
|
|
}
|
|
this.highlightOption(nextEl);
|
|
}
|
|
}
|
|
break
|
|
|
|
case backKey:
|
|
case deleteKey:
|
|
// If backspace or delete key is pressed and the input has no value
|
|
if(hasFocussedInput && !e.target.value) {
|
|
this.handleBackspaceKey(activeItems);
|
|
e.preventDefault();
|
|
}
|
|
break;
|
|
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Key up event
|
|
* @param {Object} e Event
|
|
* @return
|
|
*/
|
|
onKeyUp(e) {
|
|
if(e.target !== this.input) return;
|
|
|
|
if(this.passedElement.type === 'select-multiple' && this.options.allowSearch) {
|
|
if(this.input === document.activeElement) {
|
|
const options = this.getOptions();
|
|
const hasUnactiveOptions = options.some((option) => {
|
|
return option.active !== true;
|
|
});
|
|
|
|
// Check that have a value to search
|
|
if(this.input.value) {
|
|
const handleFilter = debounce(() => {
|
|
// Ensure value *still* has a value after 500 delay
|
|
if(this.input.value && this.input.value.length >= 1) {
|
|
const options = this.getOptionsFiltedBySelectable();
|
|
const fuse = new Fuse(options, {
|
|
keys: ['label', 'value'],
|
|
shouldSort: true,
|
|
include: 'score',
|
|
});
|
|
const results = fuse.search(this.input.value);
|
|
this.isSearching = true;
|
|
this.store.dispatch(filterOptions(results));
|
|
}
|
|
}, 500);
|
|
handleFilter();
|
|
} else if(hasUnactiveOptions) {
|
|
// Otherwise reset options to active
|
|
this.isSearching = false;
|
|
this.store.dispatch(activateOptions());
|
|
}
|
|
}
|
|
}
|
|
} q
|
|
|
|
|
|
/**
|
|
* Click event
|
|
* @param {Object} e Event
|
|
* @return
|
|
*/
|
|
onClick(e) {
|
|
const activeItems = this.getItemsFilteredByActive();
|
|
const hasShiftKey = e.shiftKey ? true : false;
|
|
|
|
if(this.passedElement.type === 'select-multiple' && !this.dropdown.classList.contains(this.options.classNames.activeState)) {
|
|
this.toggleDropdown();
|
|
}
|
|
|
|
// If click is affecting a child node of our element
|
|
if(this.containerOuter.contains(e.target)) {
|
|
// If input is not in focus, it ought to be
|
|
if(this.input !== document.activeElement) {
|
|
this.input.focus();
|
|
}
|
|
|
|
if(e.target.hasAttribute('data-item')) {
|
|
// If we are clicking on an item
|
|
this.handleClick(activeItems, e.target, hasShiftKey);
|
|
} else if(e.target.hasAttribute('data-option')) {
|
|
// If we are clicking on an option
|
|
const options = this.getOptionsFilteredByActive();
|
|
const id = e.target.getAttribute('data-id');
|
|
const option = options.find((option) => {
|
|
return option.id === parseInt(id);
|
|
});
|
|
|
|
if(!option.selected && !option.disabled) {
|
|
this.addItem(option.value, option.label, option.id);
|
|
}
|
|
}
|
|
|
|
} else {
|
|
// Click is outside of our element so close dropdown and de-select items
|
|
const hasSelectedItems = activeItems.some((item) => {
|
|
return item.selected === true;
|
|
});
|
|
|
|
if(hasSelectedItems) {
|
|
this.deselectAll();
|
|
}
|
|
|
|
this.containerOuter.classList.remove(this.options.classNames.activeState);
|
|
|
|
// Close all other dropodowns
|
|
if(this.passedElement.type === 'select-multiple' && this.dropdown.classList.contains(this.options.classNames.activeState)) {
|
|
this.toggleDropdown();
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Paste event
|
|
* @param {Object} e Event
|
|
* @return
|
|
*/
|
|
onPaste(e) {
|
|
// Disable pasting into the input if option has been set
|
|
if(!this.options.allowPaste) {
|
|
e.preventDefault();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Mouse over (hover) event
|
|
* @param {Object} e Event
|
|
* @return
|
|
*/
|
|
onMouseOver(e) {
|
|
// If we have a dropdown and it is either the target or one of its children is the target
|
|
if(this.dropdown && (e.target === this.dropdown || findAncestor(e.target, this.options.classNames.listDropdown))) {
|
|
if(e.target.hasAttribute('data-option')) {
|
|
this.highlightOption(e.target);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Focus event
|
|
* @param {Object} e Event
|
|
* @return
|
|
*/
|
|
onFocus(e) {
|
|
if(!this.containerOuter.classList.contains(this.options.classNames.activeState)) {
|
|
this.containerOuter.classList.add(this.options.classNames.activeState);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Blur event
|
|
* @param {Object} e Event
|
|
* @return
|
|
*/
|
|
onBlur(e) {
|
|
const hasActiveDropdown = this.dropdown && this.dropdown.classList.contains(this.options.classNames.activeState);
|
|
if(!hasActiveDropdown) {
|
|
this.containerOuter.classList.remove(this.options.classNames.activeState);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set value of input to blank
|
|
* @return
|
|
*/
|
|
clearInput() {
|
|
if (this.input.value) this.input.value = '';
|
|
}
|
|
|
|
/**
|
|
* Tests value against a regular expression
|
|
* @param {string} value Value to test
|
|
* @return {Boolean} Whether test passed/failed
|
|
*/
|
|
regexFilter(value) {
|
|
const expression = new RegExp(this.options.regexFilter, 'i');
|
|
const passesTest = expression.test(value);
|
|
|
|
return passesTest;
|
|
}
|
|
|
|
/**
|
|
* Scroll to an option element
|
|
* @param {HTMLElement} option Option to scroll to
|
|
* @param {Number} direction Whether option is above or below
|
|
* @return
|
|
*/
|
|
scrollToOption(option, direction) {
|
|
if(!option) return;
|
|
|
|
const dropdownHeight = this.dropdown.offsetHeight;
|
|
const optionHeight = option.offsetHeight;
|
|
|
|
// Distance from bottom of element to top of parent
|
|
const optionPos = option.offsetTop + optionHeight;
|
|
|
|
// Scroll position of dropdown
|
|
const containerScrollPos = this.dropdown.scrollTop + dropdownHeight;
|
|
|
|
// Difference between the option and scroll position
|
|
let endPoint;
|
|
|
|
const animateScroll = (time, endPoint, direction) => {
|
|
let continueAnimation = false;
|
|
|
|
let easing, distance;
|
|
const strength = 4;
|
|
|
|
if(direction > 0) {
|
|
easing = (endPoint - this.dropdown.scrollTop)/strength;
|
|
distance = easing > 1 ? easing : 1;
|
|
|
|
this.dropdown.scrollTop = this.dropdown.scrollTop + distance;
|
|
if(this.dropdown.scrollTop < endPoint) {
|
|
continueAnimation = true;
|
|
}
|
|
} else {
|
|
easing = (this.dropdown.scrollTop - endPoint)/strength;
|
|
distance = easing > 1 ? easing : 1;
|
|
|
|
this.dropdown.scrollTop = this.dropdown.scrollTop - distance;
|
|
if(this.dropdown.scrollTop > endPoint) {
|
|
continueAnimation = true;
|
|
}
|
|
}
|
|
|
|
if(continueAnimation) {
|
|
requestAnimationFrame((time) => {
|
|
animateScroll(time, endPoint, direction);
|
|
});
|
|
}
|
|
};
|
|
|
|
// Scroll dropdown to top of option
|
|
if(direction > 0) {
|
|
endPoint = (this.dropdown.scrollTop + optionPos) - containerScrollPos;
|
|
requestAnimationFrame((time) => {
|
|
animateScroll(time, endPoint, 1);
|
|
});
|
|
} else {
|
|
endPoint = option.offsetTop;
|
|
requestAnimationFrame((time) => {
|
|
animateScroll(time, endPoint, -1);
|
|
});
|
|
}
|
|
}
|
|
|
|
highlightOption(el) {
|
|
// Highlight first element in dropdown
|
|
const options = Array.from(this.dropdown.querySelectorAll('[data-option-selectable]'));
|
|
|
|
if(options.length) {
|
|
const highlightedOptions = Array.from(this.dropdown.querySelectorAll(`.${this.options.classNames.highlightedState}`));
|
|
|
|
// Remove any highlighted options
|
|
highlightedOptions.forEach((el) => {
|
|
el.classList.remove(this.options.classNames.highlightedState);
|
|
});
|
|
|
|
if(el){
|
|
// Highlight given option
|
|
el.classList.add(this.options.classNames.highlightedState);
|
|
this.highlightPosition = options.indexOf(el);
|
|
} else {
|
|
// Highlight option based on last known highlight location
|
|
let el;
|
|
|
|
if(options.length > this.highlightPosition) {
|
|
// If we have an option to highlight
|
|
el = options[this.highlightPosition];
|
|
} else {
|
|
// Otherwise highlight the option before
|
|
el = options[options.length - 1];
|
|
}
|
|
|
|
if(!el) el = options[0];
|
|
el.classList.add(this.options.classNames.highlightedState);
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Select item (a selected item can be deleted)
|
|
* @param {Element} item Element to select
|
|
* @return
|
|
*/
|
|
selectItem(item) {
|
|
if(!item) return;
|
|
const id = item.id;
|
|
this.store.dispatch(selectItem(id, true));
|
|
}
|
|
|
|
/**
|
|
* Deselect item
|
|
* @param {Element} item Element to de-select
|
|
* @return
|
|
*/
|
|
deselectItem(item) {
|
|
if(!item) return;
|
|
const id = item.id;
|
|
this.store.dispatch(selectItem(id, false));
|
|
}
|
|
|
|
/**
|
|
* Select items within store
|
|
* @return
|
|
*/
|
|
selectAll() {
|
|
const items = this.getItems();
|
|
items.forEach((item) => {
|
|
this.selectItem(item);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Deselect items within store
|
|
* @return
|
|
*/
|
|
deselectAll() {
|
|
const items = this.getItems();
|
|
items.forEach((item) => {
|
|
this.deselectItem(item);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Add item to store with correct value
|
|
* @param {String} value Value to add to store
|
|
*/
|
|
addItem(value, label, optionId = -1, callback = this.options.callbackOnAddItem) {
|
|
let passedValue = value.trim();
|
|
let passedLabel = label || passedValue;
|
|
let passedOptionId = optionId || -1;
|
|
|
|
// If a prepended value has been passed, prepend it
|
|
if(this.options.prependValue) {
|
|
passedValue = this.options.prependValue + passedValue.toString();
|
|
}
|
|
|
|
// If an appended value has been passed, append it
|
|
if(this.options.appendValue) {
|
|
passedValue = passedValue + this.options.appendValue.toString();
|
|
}
|
|
|
|
// Generate unique id
|
|
const id = this.store.getState().items.length + 1;
|
|
|
|
this.store.dispatch(addItem(passedValue, passedLabel, id, passedOptionId));
|
|
|
|
// Run callback if it is a function
|
|
if(callback){
|
|
if(isType('Function', callback)) {
|
|
callback(id, value);
|
|
} else {
|
|
console.error('callbackOnAddItem: Callback is not a function');
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Remove item from store
|
|
* @param
|
|
*/
|
|
removeItem(item, callback = this.options.callbackOnRemoveItem) {
|
|
if(!item || !isType('Object', item)) {
|
|
console.error('removeItem: No item object was passed to be removed');
|
|
return;
|
|
}
|
|
|
|
const id = item.id;
|
|
const value = item.value;
|
|
const optionId = item.optionId;
|
|
|
|
this.store.dispatch(removeItem(id, optionId));
|
|
|
|
// Run callback
|
|
if(callback){
|
|
if(isType('Function', callback)) {
|
|
callback(value);
|
|
} else {
|
|
console.error('callbackOnRemoveItem: Callback is not a function');
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Remove an item from the store by its value
|
|
* @param {String} value Value to search for
|
|
* @return
|
|
*/
|
|
removeItemsByValue(value) {
|
|
if(!value || !isType('String', value)) {
|
|
console.error('removeItemsByValue: No value was passed to be removed');
|
|
}
|
|
|
|
const items = this.getItemsFilteredByActive();
|
|
|
|
items.forEach((item) => {
|
|
if(item.value === value) {
|
|
this.removeItem(item);
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Remove all items from store array
|
|
* Note: removed items are soft deleted
|
|
* @param {Boolean} selectedOnly Optionally remove only selected items
|
|
* @return
|
|
*/
|
|
removeAllItems() {
|
|
const items = this.getItemsFilteredByActive();
|
|
|
|
items.forEach((item) => {
|
|
if(item.active) {
|
|
this.removeItem(item);
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Remove all selected items from store
|
|
* Note: removed items are soft deleted
|
|
* @return
|
|
*/
|
|
removeAllSelectedItems() {
|
|
const items = this.getItemsFilteredByActive();
|
|
|
|
items.forEach((item) => {
|
|
if(item.selected && item.active) {
|
|
this.removeItem(item);
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Show dropdown to user by adding active state class
|
|
* @return
|
|
*/
|
|
showDropdown() {
|
|
this.dropdown.classList.add(this.options.classNames.activeState);
|
|
const dimensions = this.dropdown.getBoundingClientRect();
|
|
const shouldFlip = dimensions.top + dimensions.height >= document.body.offsetHeight;
|
|
|
|
// Whether or not the dropdown should appear above or below input
|
|
if(shouldFlip) {
|
|
this.dropdown.classList.add(this.options.classNames.flippedState);
|
|
} else {
|
|
this.dropdown.classList.remove(this.options.classNames.flippedState);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Hide dropdown from user
|
|
* @return {[type]} [description]
|
|
*/
|
|
hideDropdown() {
|
|
// A dropdown flips if it does not have space below the input
|
|
const isFlipped = this.dropdown.classList.contains(this.options.classNames.flippedState);
|
|
|
|
this.dropdown.classList.remove(this.options.classNames.activeState);
|
|
|
|
if(isFlipped) {
|
|
this.dropdown.classList.remove(this.options.classNames.flippedState);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Determine whether to hide or show dropdown based on its current state
|
|
* @return
|
|
*/
|
|
toggleDropdown() {
|
|
if(!this.dropdown) return;
|
|
const isActive = this.dropdown.classList.contains(this.options.classNames.activeState);
|
|
|
|
if(isActive) {
|
|
this.hideDropdown();
|
|
} else {
|
|
this.showDropdown();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add option to dropdown
|
|
* @param {Object} option Option to add
|
|
* @param {Number} groupId ID of the options group
|
|
* @return
|
|
*/
|
|
addOption(option, groupId = -1) {
|
|
// Generate unique id
|
|
const state = this.store.getState();
|
|
const id = state.options.length + 1;
|
|
const value = option.value;
|
|
const label = option.innerHTML;
|
|
const isDisabled = option.disabled || option.parentNode.disabled;
|
|
|
|
this.store.dispatch(addOption(value, label, id, groupId, isDisabled));
|
|
|
|
if(option.selected && !isDisabled) {
|
|
this.addItem(value, label, id);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add group to dropdown
|
|
* @param {Object} group Group to add
|
|
* @param {Number} index Whether this is the first group to add
|
|
*/
|
|
addGroup(group, id, isFirst) {
|
|
const groupOptions = Array.from(group.getElementsByTagName('OPTION'));
|
|
const groupId = id;
|
|
|
|
if(groupOptions) {
|
|
this.store.dispatch(addGroup(group.label, groupId, true, group.disabled));
|
|
|
|
groupOptions.forEach((option, optionIndex) => {
|
|
// We want to pre-highlight the first option
|
|
const highlighted = isFirst && optionIndex === 0 ? true : false;
|
|
this.addOption(option, groupId);
|
|
});
|
|
} else {
|
|
this.store.dispatch(addGroup(group.label, group.id, false, group.disabled));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get items from store
|
|
* @return {Array} Item objects
|
|
*/
|
|
getItems() {
|
|
const state = this.store.getState();
|
|
return state.items;
|
|
}
|
|
|
|
/**
|
|
* Get active items from store
|
|
* @return {Array} Item objects
|
|
*/
|
|
getItemsFilteredByActive() {
|
|
const items = this.getItems();
|
|
|
|
const valueArray = items.filter((item) => {
|
|
return item.active === true;
|
|
}, []);
|
|
|
|
return valueArray;
|
|
}
|
|
|
|
/**
|
|
* Get items from store reduced to just their values
|
|
* @return {Array} Item objects
|
|
*/
|
|
getItemsReducedToValues() {
|
|
const items = this.getItems();
|
|
|
|
const valueArray = items.reduce((prev, current) => {
|
|
prev.push(current.value);
|
|
return prev;
|
|
}, []);
|
|
|
|
return valueArray;
|
|
}
|
|
|
|
/**
|
|
* Get options from store
|
|
* @return {Array} Option objects
|
|
*/
|
|
getOptions() {
|
|
const state = this.store.getState();
|
|
return state.options;
|
|
}
|
|
|
|
/**
|
|
* Get active options from store
|
|
* @return {Array} Option objects
|
|
*/
|
|
getOptionsFilteredByActive() {
|
|
const options = this.getOptions();
|
|
const valueArray = options.filter((option) => {
|
|
return option.active === true && option.selected !== true;
|
|
},[]);
|
|
|
|
return valueArray;
|
|
}
|
|
|
|
/**
|
|
* Get selectable options from store
|
|
* @return {Array} Option objects
|
|
*/
|
|
getOptionsFiltedBySelectable() {
|
|
const options = this.getOptions();
|
|
const valueArray = options.filter((option) => {
|
|
return option.selected === false && option.disabled !== true;
|
|
},[]);
|
|
|
|
return valueArray;
|
|
}
|
|
|
|
/**
|
|
* Get groups from store
|
|
* @return {Array} Group objects
|
|
*/
|
|
getGroups() {
|
|
const state = this.store.getState();
|
|
return state.groups;
|
|
}
|
|
|
|
/**
|
|
* Get active groups from store
|
|
* @return {Array} Group objects
|
|
*/
|
|
getGroupsFilteredByActive() {
|
|
const groups = this.getGroups();
|
|
const options = this.getOptions();
|
|
|
|
const valueArray = groups.filter((group) => {
|
|
const isActive = group.active === true && group.disabled === false;
|
|
const hasActiveOptions = options.some((option) => {
|
|
return option.active === true && option.disabled === false;
|
|
});
|
|
return isActive && hasActiveOptions ? true : false;
|
|
},[]);
|
|
|
|
return valueArray;
|
|
}
|
|
|
|
/**
|
|
* Create DOM structure around passed select element
|
|
* @return
|
|
*/
|
|
generateInput() {
|
|
const containerOuter = this.getTemplate('containerOuter');
|
|
const containerInner = this.getTemplate('containerInner');
|
|
const list = this.getTemplate('list');
|
|
const input = this.getTemplate('input');
|
|
|
|
// Hide passed input
|
|
this.passedElement.classList.add(this.options.classNames.input, this.options.classNames.hiddenState);
|
|
this.passedElement.tabIndex = '-1';
|
|
this.passedElement.setAttribute('style', 'display:none;');
|
|
this.passedElement.setAttribute('aria-hidden', 'true');
|
|
|
|
// Wrap input in container preserving DOM ordering
|
|
wrap(this.passedElement, containerInner);
|
|
|
|
// Wrapper inner container with outer container
|
|
wrap(containerInner, containerOuter);
|
|
|
|
// If placeholder has been enabled and we have a value
|
|
if (this.options.placeholder && this.options.placeholderValue) {
|
|
input.placeholder = this.options.placeholderValue;
|
|
input.style.width = getWidthOfInput(input);
|
|
}
|
|
|
|
if(!this.options.addItems) {
|
|
input.disabled = true;
|
|
containerOuter.classList.add(this.options.classNames.disabledState);
|
|
}
|
|
|
|
containerOuter.appendChild(containerInner);
|
|
containerInner.appendChild(list);
|
|
containerInner.appendChild(input);
|
|
|
|
if(this.passedElement.type === 'select-multiple') {
|
|
this.highlightPosition = 0;
|
|
const dropdown = this.getTemplate('dropdown');
|
|
const passedGroups = Array.from(this.passedElement.getElementsByTagName('OPTGROUP'));
|
|
|
|
containerOuter.appendChild(dropdown);
|
|
|
|
this.dropdown = dropdown;
|
|
this.isSearching = false;
|
|
|
|
if(passedGroups.length) {
|
|
passedGroups.forEach((group, index) => {
|
|
const isFirst = index === 0 ? true : false;
|
|
this.addGroup(group, index, isFirst);
|
|
});
|
|
} else {
|
|
const passedOptions = Array.from(this.passedElement.options);
|
|
passedOptions.forEach((option) => {
|
|
this.addOption(option);
|
|
});
|
|
}
|
|
} else if(this.passedElement.type === 'text') {
|
|
// Add any preset values seperated by delimiter
|
|
this.presetItems.forEach((value) => {
|
|
this.addItem(value);
|
|
});
|
|
}
|
|
|
|
this.containerOuter = containerOuter;
|
|
this.containerInner = containerInner;
|
|
this.input = input;
|
|
this.list = list;
|
|
}
|
|
|
|
/**
|
|
* Render DOM with values
|
|
* @return
|
|
*/
|
|
render(callback = this.options.callbackOnRender) {
|
|
const classNames = this.options.classNames;
|
|
const activeItems = this.getItemsFilteredByActive();
|
|
|
|
// OPTIONS
|
|
if(this.passedElement.type === 'select-multiple') {
|
|
const activeOptions = this.getOptionsFilteredByActive();
|
|
const activeGroups = this.getGroupsFilteredByActive();
|
|
|
|
// Create a fragment to store our list items (so we don't have to update the DOM for each item)
|
|
const optionListFragment = document.createDocumentFragment();
|
|
|
|
// If we have grouped options
|
|
if(activeGroups.length >= 1 && this.isSearching !== true) {
|
|
activeGroups.forEach((group, i) => {
|
|
// Grab options that are children of this group
|
|
const groupOptions = activeOptions.filter((option) => {
|
|
return option.groupId === group.id;
|
|
});
|
|
|
|
if(groupOptions.length >= 1) {
|
|
const dropdownGroup = this.getTemplate('optgroup', group);
|
|
|
|
groupOptions.forEach((option, j) => {
|
|
const dropdownItem = this.getTemplate('option', option);
|
|
dropdownGroup.appendChild(dropdownItem);
|
|
});
|
|
|
|
optionListFragment.appendChild(dropdownGroup);
|
|
}
|
|
});
|
|
} else if(activeOptions.length >= 1) {
|
|
activeOptions.forEach((option, i) => {
|
|
const dropdownItem = this.getTemplate('option', option);
|
|
optionListFragment.appendChild(dropdownItem);
|
|
});
|
|
}
|
|
|
|
// Clear options
|
|
this.dropdown.innerHTML = '';
|
|
|
|
if(optionListFragment.children.length) {
|
|
this.dropdown.appendChild(optionListFragment);
|
|
this.highlightOption();
|
|
} else {
|
|
// If dropdown is empty, show a no content notice
|
|
const dropdownItem = this.getTemplate('notice', 'No options to select');
|
|
this.dropdown.appendChild(dropdownItem);
|
|
}
|
|
}
|
|
|
|
// ITEMS
|
|
if(activeItems) {
|
|
// Simplify store data to just values
|
|
const itemsFiltered = this.getItemsReducedToValues();
|
|
|
|
// Assign hidden input array of values
|
|
this.passedElement.value = itemsFiltered.join(this.options.delimiter);
|
|
|
|
// Clear list
|
|
this.list.innerHTML = '';
|
|
|
|
// Create a fragment to store our list items (so we don't have to update the DOM for each item)
|
|
const itemListFragment = document.createDocumentFragment();
|
|
|
|
// Add each list item to list
|
|
activeItems.forEach((item) => {
|
|
// Create new list element
|
|
const listItem = this.getTemplate('item', item);
|
|
|
|
// Append it to list
|
|
itemListFragment.appendChild(listItem);
|
|
});
|
|
|
|
this.list.appendChild(itemListFragment);
|
|
}
|
|
|
|
// Run callback if it is a function
|
|
if(callback){
|
|
if(isType('Function', callback)) {
|
|
callback(activeItems);
|
|
} else {
|
|
console.error('callbackOnRender: Callback is not a function');
|
|
}
|
|
}
|
|
}
|
|
|
|
getTemplate(template, ...args) {
|
|
if(!template) return;
|
|
const templates = this.options.templates;
|
|
return templates[template](...args);
|
|
}
|
|
|
|
/**
|
|
* Create HTML element based on type and arguments
|
|
* @param {String} template Template to create
|
|
* @param {...} args Data
|
|
* @return {HTMLElement}
|
|
*/
|
|
createTemplates() {
|
|
const classNames = this.options.classNames;
|
|
const templates = {
|
|
containerOuter: () => {
|
|
return strToEl(`<div class="${ classNames.containerOuter }"></div>`);
|
|
},
|
|
containerInner: () => {
|
|
return strToEl(`<div class="${ classNames.containerInner }"></div>`);
|
|
},
|
|
list: () => {
|
|
return strToEl(`<ul class="${ classNames.list } ${ classNames.listItems }"></ul>`);
|
|
},
|
|
input: () => {
|
|
return strToEl(`<input type="text" class="${ classNames.input } ${ classNames.inputCloned }">`);
|
|
},
|
|
dropdown: () => {
|
|
return strToEl(`<div class="${ classNames.list } ${ classNames.listDropdown }"></div>`);
|
|
},
|
|
notice: (label) => {
|
|
return strToEl(`<div class="${ classNames.item } ${ classNames.itemOption }">${ label }</div>`);
|
|
},
|
|
option: (data) => {
|
|
return strToEl(`
|
|
<div class="${ classNames.item } ${ classNames.itemOption } ${ data.disabled ? classNames.itemDisabled : classNames.itemSelectable }" data-option ${ data.disabled ? 'data-option-disabled' : 'data-option-selectable' } data-id="${ data.id }" data-value="${ data.value }">
|
|
${ data.label }
|
|
</div>
|
|
`);
|
|
},
|
|
optgroup: (data) => {
|
|
return strToEl(`
|
|
<div class="${ classNames.group } ${ data.disabled ? classNames.itemDisabled : '' }" data-group data-id="${ data.id }" data-value="${ data.value }">
|
|
<div class="${ classNames.groupHeading }">${ data.value }</div>
|
|
</div>
|
|
`);
|
|
},
|
|
item: (data) => {
|
|
return strToEl(`
|
|
<div class="${ classNames.item } ${ classNames.itemOption } ${ data.selected ? classNames.selectedState : classNames.itemSelectable }" data-item data-id="${ data.id }" data-value="${ data.value }">
|
|
${ data.label }
|
|
</div>
|
|
`);
|
|
},
|
|
};
|
|
|
|
this.options.templates = extend(this.options.templates, templates);
|
|
}
|
|
|
|
/**
|
|
* Trigger event listeners
|
|
* @return
|
|
*/
|
|
addEventListeners() {
|
|
document.addEventListener('keyup', this.onKeyUp);
|
|
document.addEventListener('keydown', this.onKeyDown);
|
|
document.addEventListener('click', this.onClick);
|
|
document.addEventListener('paste', this.onPaste);
|
|
document.addEventListener('mouseover', this.onMouseOver);
|
|
|
|
this.input.addEventListener('focus', this.onFocus);
|
|
this.input.addEventListener('blur', this.onBlur);
|
|
}
|
|
|
|
/**
|
|
* Destroy event listeners
|
|
* @return
|
|
*/
|
|
removeEventListeners() {
|
|
document.removeEventListener('keyup', this.onKeyUp);
|
|
document.removeEventListener('keydown', this.onKeyDown);
|
|
document.removeEventListener('click', this.onClick);
|
|
document.removeEventListener('paste', this.onPaste);
|
|
document.removeEventListener('mouseover', this.onMouseOver);
|
|
|
|
this.input.removeEventListener('focus', this.onFocus);
|
|
this.input.removeEventListener('blur', this.onBlur);
|
|
}
|
|
|
|
/**
|
|
* Initialise Choices
|
|
* @return
|
|
*/
|
|
init(callback = this.options.callbackOnInit) {
|
|
this.initialised = true;
|
|
|
|
// Create required elements
|
|
this.createTemplates();
|
|
|
|
// Generate input markup
|
|
this.generateInput();
|
|
|
|
// Subscribe to store
|
|
this.store.subscribe(this.render);
|
|
|
|
// Render any items
|
|
this.render();
|
|
|
|
// Trigger event listeners
|
|
this.addEventListeners();
|
|
|
|
// Run callback if it is a function
|
|
if(callback){
|
|
if(isType('Function', callback)) {
|
|
callback();
|
|
} else {
|
|
console.error('callbackOnInit: Callback is not a function');
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Destroy Choices and nullify values
|
|
* @return
|
|
*/
|
|
destroy() {
|
|
this.passedElement = null;
|
|
this.userOptions = null;
|
|
this.options = null;
|
|
this.initialised = null;
|
|
this.store = null;
|
|
}
|
|
};
|
|
|
|
window.Choices = module.exports = Choices; |