-
Notifications
You must be signed in to change notification settings - Fork 1
/
SimpleSearchableSelect.js
577 lines (498 loc) · 19.1 KB
/
SimpleSearchableSelect.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
/**!
* SSS (aka SimpleSearchableSelect aka SmartSelectSystem)
*
* @version v1.2.0
* @author Chalda Pnuzig <chalda@chalda.it>
* @copyright Chalda Pnuzig 2023
* {@link https://github.com/chalda-pnuzig/SimpleSearchableSelect|GitHub}
* @license ISC
*/
/**
* A JavaScript class that enhances standard HTML <select> elements
* by providing a simple and searchable selection experience.
* The SimpleSearchableSelect class offers additional features, including autocompletion
* and dynamic data loading, to improve the user experience when interacting with select elements.
*
* @example
* // Usage:
* const targetSelect = document.getElementById('your-select-element');
* const options = {
* inputIntervalTimeout: 300,
* multiple: true,
* // ...other options
* };
* const sssInstance = new SSS(targetSelect, options);
*/
export class SSS {
/**
* @type {HTMLInputElement}
*/
$input = document.createElement('input');
/**
* @type {HTMLDataListElement}
*/
$dataList = document.createElement('datalist');
/**
* @type {HTMLSelectElement}
*/
$target;
/**
* @type {HTMLLabelElement}
*/
$label;
/**
* @name PromiseCallback
* @type function
* @param string
* @returns {Promise<Object.<string, string>>}
*
* it should return a Promise resolving to an object with 'value' and 'text' properties.
*/
/**
* @typedef {'beforebegin'|'afterbegin'|'beforeend'|'afterend'} DOMInsertion
*/
/**
* @typedef {function} SelectedStyleFn
* @param {string} referenceValue - The text associated with the selected option.
* @returns {string} - The customized text for the selected option.
*/
/**
* Configuration options for the SSS (Smart Select System) instance.
*
* @typedef {Object} SSSOptions
* @property {number} [inputIntervalTimeout=200] - Timeout in milliseconds for debouncing input events.
* @property {string} [idPrefix='SSS_'] - Prefix for generating unique element IDs.
* @property {DOMInsertion} [insertPosition='beforebegin'] - DOM insertion position for the input element.
* @property {number} [swipeOffset=50] - Threshold for swipe gestures.
* @property {number} [swipeAnimationSpeed=200] - Speed of swipe animation in milliseconds.
* @property {PromiseCallback|false} [promiseData=false] - Asynchronous data fetching function or false if not used.
* @property {false|SelectedStyleFn} [selectedStyle=false] - If a function is provided, it will be invoked with the reference value of the selected option. If set to `false`, selected options will be disabled.
* @property {boolean} [multiple=undefined] - Indicates whether multiple selections are allowed. Defaults to the value of the select element.
* @property {boolean} [required=undefined] - Indicates whether the input is required. Defaults to the value of the select element.
* @property {string} [placeholder=undefined] - Indicates the placeholder to show. Defaults to the value is derived from the option in the select element with an empty string ('') as its value
**/
options = {
inputIntervalTimeout : 200,
idPrefix : 'SSS_',
insertPosition : 'beforebegin',
swipeOffset : 50,
swipeAnimationSpeed : 200,
promiseData : false,
selectedStyle : false,
multiple : undefined, // Note: multiple and required are intentionally left undefined here
required : undefined, // to indicate they will use the values from the input element,
placeholder : undefined, // and placeholder is taken from the option in the select with an empty string ('') if present.
};
/**
* @type {Object.<string, string>}
* @private
*/
#values = {};
/**
* @type {Object.<string, string>}
* @private
*/
#refs = {};
/**
* @type {Object.<string, HTMLInputElement>}
* @private
*/
#clones = {};
/**
* @type {Object.<string, HTMLOptionElement>}
* @private
*/
#validValues = {};
/**
* @type {Object.<string, HTMLOptionElement>}
* @private
*/
#datalistOptions = {};
/**
* Initializes a new instance of the SSS class, associating it with a target element and providing optional configuration options.
* If the target element already has an SSS instance, returns the existing instance.
*
* @param {HTMLSelectElement} target - The target select element to associate with the SSS instance.
* @param {SSSOptions} options - Optional configuration options for the SSS instance.
* @returns {SSS} - The SSS instance associated with the target element.
*/
constructor(target, options = {}) {
if (!target) throw new Error(`SSS: Target select not found!`)
if (target.hasOwnProperty('SSS')) return target.SSS;
this.$target = target;
this.$target["SSS"] = this;
this.options.multiple = target.multiple;
this.options.required = target.required;
this.options = {
...this.options,
...options
};
this.#init();
return this;
}
/**
* Adds a value to the SSS instance for multiple selections, creating a visual clone.
*
* @param {string} value - The value to add.
* @param {boolean} [fireChange=true] - If true, triggers a 'change' event on the target element.
* @returns {void}
*/
#addMultipleValue(value, fireChange = true) {
// If a clone for the value already exists, focus on it and reset the input value
if (typeof this.#clones[value] !== 'undefined') {
this.#clones[value].focus();
this.$input.value = '';
return;
}
// If the value is falsy, exit early
if (!value) return;
// Set the value reference
this.#values[value] = this.#refs[value];
// Create a clone of the input element
const clone = this.$input.cloneNode(true);
let touchStartX = 0;
let touchEndX = 0;
// Event listener for touchstart to capture starting touch position
clone.addEventListener('touchstart', e => touchStartX = e.changedTouches[0].screenX);
// Styling and class for the clone
clone.classList.add('SSS_clone');
clone.style.setProperty('--SSS-x', '0');
clone.style.setProperty('--SSS-s', `${this.options.swipeAnimationSpeed}ms`);
// Set height for the clone if not already set
clone.style.height ||= window.getComputedStyle(this.$input).height;
// Custom function to delete the clone
clone.SSSDelete = () => {
// Animation and removal logic
clone.style.setProperty('--SSS-x', '0');
clone.style.height = clone.style.padding = clone.style.border = clone.style.fontSize = clone.style.opacity = '0';
clone.style.transition = 'all var(--SSS-s)';
setTimeout(() => {
clone.remove();
this.#validValues[this.#refs[value]].selected = false;
delete this.#values[value];
delete this.#clones[value];
// Update input's 'required' attribute if needed
if (this.options.required) {
this.$input.required = Object.keys(this.#clones).length === 0;
}
// Restores the option to an enabled state by setting the 'disabled' property to false.
this.#datalistOptions[value].disabled = false;
// resets the option text to its original value.
this.#datalistOptions[value].text = this.#datalistOptions[value].dataset.original;
// Trigger 'change' event if specified
if (fireChange) this.$target.dispatchEvent(new Event('change'));
}, this.options.swipeAnimationSpeed);
}
// Styling for the clone's transform property
clone.style.transform += ' translateX(var(--SSS-x))';
// Event listeners for touchend and touchmove to handle swipe deletion
clone.addEventListener('touchend', e => {
touchEndX = e.changedTouches[0].screenX;
if (touchStartX - touchEndX >= this.options.swipeOffset) {
if (touchEndX < touchStartX) {
clone.SSSDelete();
}
} else {
clone.style.setProperty('--SSS-x', '0');
}
});
clone.addEventListener('touchmove', e => {
touchEndX = e.changedTouches[0].screenX;
const swipe = touchEndX < touchStartX ? -Math.min(touchStartX - touchEndX, this.options.swipeOffset) : 0;
clone.style.setProperty('--SSS-x', `${swipe}px`);
});
// Store the clone in the #clones object
this.#clones[value] = clone;
// Set properties for the clone
clone.readOnly = true;
// Event listener for keydown to handle backspace/delete key press
clone.addEventListener('keydown', (e) => {
if (['Backspace', 'Delete'].includes(e.key)) {
clone.SSSDelete();
}
});
// Insert the clone before the input element in the DOM
this.$input.insertAdjacentElement('beforebegin', clone);
// Reset the input value and remove 'required' attribute
this.$input.value = '';
this.$input.required = false;
if (typeof this.options.selectedStyle === 'function') {
// Apply custom styling to the option text using the selectedStyle function.
this.#datalistOptions[value].text = this.options.selectedStyle(this.#refs[value]) + '';
} else {
// Disable the option if selectedStyle is not a function.
this.#datalistOptions[value].disabled = true;
}
if (this.options.showPicker) {
try {
this.$input.showPicker();
} catch (e) {
}
}
// Update selected status for valid values
const cloneKeys = Object.keys(this.#clones);
Object.values(this.#validValues).forEach(o => o.selected = cloneKeys.includes(o.value));
// Trigger 'change' event if specified
if (fireChange) this.$target.dispatchEvent(new Event('change'));
}
/**
* Sets the value of the SSS instance, updating the associated input and triggering a 'change' event if specified.
* If the SSS instance is configured for multiple selections, it sets multiple values.
*
* @param {(string | string[])} value - The value(s) to set.
* @param {boolean} [fireChange=true] - If true, triggers a 'change' event on the target element.
* @returns {void}
*/
setValue(value, fireChange = true) {
const values = (this.options.multiple ? (Array.isArray(value) ? value : [value]) : [value]);
values.forEach(v => {
this.$input.value = this.#refs[v] || '';
if (this.options.multiple) {
this.#addMultipleValue(v, false);
} else {
this.#values[v] = this.#refs[v];
this.$target.value = v;
}
});
if (fireChange) this.$target.dispatchEvent(new Event('change'));
}
/**
* Clears the value(s) associated with the SSS instance, either for a single or multiple selection.
* If the SSS instance is configured for multiple selections, it clears the specified values.
* If the SSS instance is configured for a single selection, it clears the value.
*
* @param {(string | string[] | false)} value - The value(s) to clear. If false, clears all values.
* @returns {void}
*/
clearValue(value = false) {
if (this.options.multiple) {
if (value === false) value = Object.keys(this.#values);
const valuesToClear = Array.isArray(value) ? value : [value];
valuesToClear.forEach(v => {
if (this.#clones[v]) this.#clones[v]["SSSDelete"]();
});
} else {
this.$input.value = '';
this.$target.value = '';
}
}
/**
* Destroys the SSS instance, restoring the target element to its original state.
* If the SSS instance is not attached to the target, the function exits early.
* @returns {void}
*/
destroy() {
// Check if the SSS property is not present on the target
if (!this.$target["SSS"]) return;
// Restore the visibility of the target element
this.$target.hidden = false;
// Remove the reference to this instance from the target object
delete this.$target["SSS"];
// Remove associated DOM elements
this.$dataList.remove();
this.$input.remove();
// Restore attributes on the target element
this.$target.required = this.$target.dataset.sssRequired === '1';
this.$target.multiple = this.$target.dataset.sssMultiple === '1';
delete this.$target.dataset.sssRequired;
delete this.$target.dataset.sssMultiple;
// Remove cloned elements if the 'multiple' option is enabled
if (this.options.multiple) Object.values(this.#clones).forEach(el => el.remove());
// Restore the 'for' attribute of the label, if present
if (this.$label) {
this.$label.setAttribute('for', this.$label.dataset.sssOriginal)
delete this.$label.dataset.sssOriginal;
}
}
/**
* Resets the SSS instance, clearing the current value(s) and updating the options based on the target's options.
* If the target is a select element with options, it populates the internal data list with valid values.
*
* @returns {void}
*/
resetValue() {
// Clear current values
this.clearValue();
// Array to store selected options
let selected = [];
// Iterate over each option in the target element
this.$target.querySelectorAll('option').forEach(o => {
let text = o.textContent;
let value = o.value;
// Check if the option is selected and has a value
if (o.selected && o.value) selected.push(text);
// Process each option
if (value) {
// Create a new Option element and add it to the internal data list
let newOption = new Option(text);
this.$dataList.append(newOption);
newOption.dataset.original = text;
this.#datalistOptions[value] = newOption;
this.#validValues[text] = o;
this.#refs[value] = text;
} else {
// Set the input placeholder if the option has no value
this.$input.placeholder = text;
}
});
// Check if a custom placeholder is specified in the options
if (this.options.placeholder) {
this.$input.placeholder = this.options.placeholder;
}
// If there are selected options, set the values accordingly
if (selected.length) {
if (this.options.multiple) {
// If multiple selections are allowed, set each selected value
[...this.$target.selectedOptions].forEach(o => {
this.setValue(o.value, false);
});
} else {
// If single selection, set the value of the first selected option
this.$input.value = selected[0];
}
}
}
/**
* Initializes the SSS instance, setting up the necessary elements and event listeners.
*
* @private
* @returns {void}
*/
#init() {
// Copy attributes from the target element to the input element
this.$target.getAttributeNames().forEach(attr => {
if (attr.match(/^(name|id)$/i)) return;
this.$input.setAttribute(attr, this.$target.getAttribute(attr));
});
this.$input.setAttribute('autocomplete', 'off');
// Hide the target element and store its original required and multiple attributes
this.$target.hidden = true;
this.$target.dataset.sssRequired = this.$target.required ? '1' : '0';
this.$target.dataset.sssMultiple = this.$target.multiple ? '1' : '0';
this.$target.required = this.options.required;
this.$target.multiple = this.options.multiple;
// Generate a unique idPrefix based on the existing ids
let counter = 1;
while (document.getElementById(this.options.idPrefix + counter + '_list')) {
counter++;
}
this.options.idPrefix += counter;
// Update label attributes if it exists
if (this.$target.id) {
this.$label = document.querySelector(`label[for="${this.$target.id}"]`);
if (this.$label) {
this.$label.dataset.sssOriginal = this.$target.id;
this.$label.setAttribute('for', this.options.idPrefix + '_input');
}
}
// Set ids and attributes for the input and datalist elements
this.$dataList.id = this.options.idPrefix + '_list';
this.$input.id = this.options.idPrefix + '_input';
this.$input.required = this.options.required;
this.$input.multiple = this.options.multiple;
this.$input.setAttribute('list', this.options.idPrefix + '_list');
this.$input.classList.add('SSS_input');
// Insert input element and append datalist element to the body
this.$target.insertAdjacentElement(this.options.insertPosition, this.$input);
document.body.append(this.$dataList);
// Initialize values based on the existing options in the target element
this.resetValue();
// Event listeners for input handling
let start = false;
this.$input.addEventListener('input', () => {
// Clear any existing timeout to debounce input
if (start) clearTimeout(start)
// Get the current input value
let inputValue = this.$input.value;
// Controlla se il valore è uno di quelli generati
let sel = Object.values(this.#datalistOptions).filter(t => t.text === inputValue);
if (sel.length === 1) {
inputValue = sel[0].dataset.original
}
if (this.options.promiseData) {
// Handle logic when promiseData is present
start = setTimeout(() => {
if (this.#validValues[inputValue]) {
// If the value is valid, set it
this.setValue(this.#validValues[inputValue].value);
} else {
// Fetch data from promiseData
this.options.promiseData(inputValue).then((data) => {
Object.keys(data).forEach(key => {
let value = data[key];
if (typeof this.#validValues[value] === 'undefined') {
// Create and append new option elements
let option = new Option(value, key);
this.#validValues[value] = option;
this.$target.append(option);
this.#refs[key] = value;
let dataListOption = new Option(value);
dataListOption.dataset.original = value;
this.#datalistOptions[key] = dataListOption;
this.$dataList.append(dataListOption);
}
});
});
}
}, this.options.inputIntervalTimeout);
} else {
// Handle logic when promiseData is not present
let regex = new RegExp('^' + inputValue.replace(/[.*+?^${}()|[\]\\]/g, '\\$&') + '$', 'i')
let match = Object.keys(this.#validValues).find(entry => entry.match(regex));
if (match) {
// If there is a match, set the value
start = setTimeout(() => {
this.setValue(this.#validValues[match].value);
}, this.options.inputIntervalTimeout);
}
}
});
// Handle blur event
this.$input.addEventListener('blur', () => {
// Get the current input value
let inputValue = this.$input.value;
// Check if the input value is present and not in the validValues
if (inputValue && !Object.keys(this.#validValues).includes(inputValue)) {
// If not in validValues, clear the input value
this.setValue('');
}
});
// Handle focus event
if (this.options.showPickerOnFocus) {
this.$input.addEventListener('focus', () => {
// Show the picker
try {
this.$input.showPicker();
} catch (e) {
}
});
}
// Handle keydown events (Backspace, Delete, Tab, Enter)
this.$input.addEventListener('keydown', (e) => {
switch (e.key) {
case 'Backspace':
case 'Delete':
// Clear the input value on Backspace or Delete key press
this.setValue('');
break;
case 'Tab':
case 'Enter':
// Handle Tab or Enter key press
const inputValue = this.$input.value;
const regex = new RegExp('' + inputValue.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'), 'i')
const matchingKey = Object.keys(this.#validValues).find(key => key.match(regex));
// If there is a match, set the corresponding value
if (matchingKey) this.setValue(this.#validValues[matchingKey].value);
break;
}
});
}
/**
* Retrieves the values associated with the SSS instance.
*
* @returns {Object<string, string>} - An object containing the values.
*/
getValues() {
return this.#values;
}
}