xmpp.chapril.org-conversejs/src/converse-autocomplete.js

420 lines
15 KiB
JavaScript
Raw Normal View History

// Converse.js
// https://conversejs.org
//
2019-02-18 19:17:06 +01:00
// Copyright (c) 2013-2019, the Converse.js developers
// Licensed under the Mozilla Public License (MPLv2)
/**
* @module converse-autocomplete
* @description
* Converse.js plugin which started as a fork of Lea Verou's Awesomplete
* https://leaverou.github.io/awesomplete/
*/
2018-10-23 03:41:38 +02:00
import converse from "@converse/headless/converse-core";
2018-10-23 03:41:38 +02:00
const { _, Backbone } = converse.env,
u = converse.env.utils;
2018-10-23 03:41:38 +02:00
converse.plugins.add("converse-autocomplete", {
2018-10-23 03:41:38 +02:00
initialize () {
const { _converse } = this;
2018-10-23 03:41:38 +02:00
_converse.FILTER_CONTAINS = function (text, input) {
return RegExp(helpers.regExpEscape(input.trim()), "i").test(text);
};
2018-08-14 12:49:43 +02:00
2018-10-23 03:41:38 +02:00
_converse.FILTER_STARTSWITH = function (text, input) {
return RegExp("^" + helpers.regExpEscape(input.trim()), "i").test(text);
};
2018-08-14 12:49:43 +02:00
2018-10-23 03:41:38 +02:00
const SORT_BYLENGTH = function (a, b) {
if (a.length !== b.length) {
return a.length - b.length;
}
return a < b? -1 : 1;
};
const ITEM = (text, input) => {
input = input.trim();
const element = document.createElement("li");
element.setAttribute("aria-selected", "false");
const regex = new RegExp("("+input+")", "ig");
const parts = input ? text.split(regex) : [text];
parts.forEach((txt) => {
if (input && txt.match(regex)) {
const match = document.createElement("mark");
match.textContent = txt;
element.appendChild(match);
} else {
element.appendChild(document.createTextNode(txt));
}
});
return element;
};
2018-08-14 12:49:43 +02:00
class Suggestion extends String {
constructor (data) {
super();
const o = Array.isArray(data)
? { label: data[0], value: data[1] }
: typeof data === "object" && "label" in data && "value" in data ? data : { label: data, value: data };
this.label = o.label || o.value;
this.value = o.value;
}
get lenth () {
return this.label.length;
}
toString () {
return "" + this.label;
}
valueOf () {
return this.toString();
}
}
2018-10-23 03:41:38 +02:00
class AutoComplete {
2018-10-23 03:41:38 +02:00
constructor (el, config={}) {
this.is_opened = false;
2018-08-14 12:49:43 +02:00
2018-10-23 03:41:38 +02:00
if (u.hasClass('.suggestion-box', el)) {
this.container = el;
} else {
this.container = el.querySelector('.suggestion-box');
}
2018-10-23 03:41:38 +02:00
this.input = this.container.querySelector('.suggestion-box__input');
this.input.setAttribute("aria-autocomplete", "list");
this.ul = this.container.querySelector('.suggestion-box__results');
this.status = this.container.querySelector('.suggestion-box__additions');
_.assignIn(this, {
'match_current_word': false, // Match only the current word, otherwise all input is matched
'ac_triggers': [], // Array of keys (`ev.key`) values that will trigger auto-complete
'include_triggers': [], // Array of trigger keys which should be included in the returned value
2018-10-23 03:41:38 +02:00
'min_chars': 2,
'max_items': 10,
'auto_evaluate': true, // Should evaluation happen automatically without any particular key as trigger?
'auto_first': false, // Should the first element be automatically selected?
2018-10-23 03:41:38 +02:00
'data': _.identity,
'filter': _converse.FILTER_CONTAINS,
'sort': config.sort === false ? false : SORT_BYLENGTH,
'item': ITEM
}, config);
this.index = -1;
this.bindEvents()
if (this.input.hasAttribute("list")) {
this.list = "#" + this.input.getAttribute("list");
this.input.removeAttribute("list");
} else {
this.list = this.input.getAttribute("data-list") || config.list || [];
}
}
2018-08-14 12:49:43 +02:00
2018-10-23 03:41:38 +02:00
bindEvents () {
// Bind events
const input = {
"blur": () => this.close({'reason': 'blur'})
}
if (this.auto_evaluate) {
input["input"] = () => this.evaluate();
}
2018-10-23 03:41:38 +02:00
this._events = {
'input': input,
'form': {
"submit": () => this.close({'reason': 'submit'})
},
'ul': {
"mousedown": (ev) => this.onMouseDown(ev),
"mouseover": (ev) => this.onMouseOver(ev)
}
2018-10-23 03:41:38 +02:00
};
helpers.bind(this.input, this._events.input);
helpers.bind(this.input.form, this._events.form);
helpers.bind(this.ul, this._events.ul);
}
2018-10-23 03:41:38 +02:00
set list (list) {
if (Array.isArray(list) || typeof list === "function") {
this._list = list;
} else if (typeof list === "string" && _.includes(list, ",")) {
this._list = list.split(/\s*,\s*/);
} else { // Element or CSS selector
list = helpers.getElement(list);
if (list && list.children) {
const items = [];
Array.prototype.slice.apply(list.children).forEach(function (el) {
2018-10-23 03:41:38 +02:00
if (!el.disabled) {
const text = el.textContent.trim(),
value = el.value || text,
label = el.label || text;
if (value !== "") {
items.push({ label: label, value: value });
}
}
});
this._list = items;
}
2018-08-14 12:49:43 +02:00
}
2018-10-23 03:41:38 +02:00
if (document.activeElement === this.input) {
this.evaluate();
2018-08-14 12:49:43 +02:00
}
2018-10-23 03:41:38 +02:00
}
2018-10-23 03:41:38 +02:00
get selected () {
return this.index > -1;
}
2018-10-23 03:41:38 +02:00
get opened () {
return this.is_opened;
}
close (o) {
if (!this.opened) {
return;
}
2018-10-23 03:41:38 +02:00
this.ul.setAttribute("hidden", "");
this.is_opened = false;
this.index = -1;
this.trigger("suggestion-box-close", o || {});
}
2018-10-23 03:41:38 +02:00
insertValue (suggestion) {
let value;
if (this.match_current_word) {
u.replaceCurrentWord(this.input, suggestion.value);
} else {
this.input.value = suggestion.value;
2018-08-14 12:49:43 +02:00
}
2018-10-23 03:41:38 +02:00
}
2018-10-23 03:41:38 +02:00
open () {
this.ul.removeAttribute("hidden");
this.is_opened = true;
2018-10-23 03:41:38 +02:00
if (this.auto_first && this.index === -1) {
this.goto(0);
2018-08-14 12:49:43 +02:00
}
2018-10-23 03:41:38 +02:00
this.trigger("suggestion-box-open");
}
2018-10-23 03:41:38 +02:00
destroy () {
//remove events from the input and its form
helpers.unbind(this.input, this._events.input);
helpers.unbind(this.input.form, this._events.form);
this.input.removeAttribute("aria-autocomplete");
}
2018-10-23 03:41:38 +02:00
next () {
const count = this.ul.children.length;
this.goto(this.index < count - 1 ? this.index + 1 : (count ? 0 : -1) );
}
previous () {
const count = this.ul.children.length,
pos = this.index - 1;
this.goto(this.selected && pos !== -1 ? pos : count - 1);
}
2018-10-23 03:41:38 +02:00
goto (i) {
// Should not be used directly, highlights specific item without any checks!
const list = this.ul.children;
if (this.selected) {
list[this.index].setAttribute("aria-selected", "false");
2018-08-14 12:49:43 +02:00
}
2018-10-23 03:41:38 +02:00
this.index = i;
if (i > -1 && list.length > 0) {
list[i].setAttribute("aria-selected", "true");
list[i].focus();
this.status.textContent = list[i].textContent;
// scroll to highlighted element in case parent's height is fixed
this.ul.scrollTop = list[i].offsetTop - this.ul.clientHeight + list[i].clientHeight;
this.trigger("suggestion-box-highlight", {'text': this.suggestions[this.index]});
}
}
select (selected) {
2018-10-23 03:41:38 +02:00
if (selected) {
this.index = u.siblingIndex(selected);
} else {
selected = this.ul.children[this.index];
}
if (selected) {
const suggestion = this.suggestions[this.index];
this.insertValue(suggestion);
this.close({'reason': 'select'});
this.auto_completing = false;
this.trigger("suggestion-box-selectcomplete", {'text': suggestion});
2018-08-14 12:49:43 +02:00
}
2018-10-23 03:41:38 +02:00
}
2018-10-23 03:41:38 +02:00
onMouseOver (ev) {
const li = u.ancestor(ev.target, 'li');
if (li) {
this.goto(Array.prototype.slice.call(this.ul.children).indexOf(li))
2018-08-14 12:49:43 +02:00
}
2018-10-23 03:41:38 +02:00
}
2018-10-23 03:41:38 +02:00
onMouseDown (ev) {
if (ev.button !== 0) {
return; // Only select on left click
}
2018-10-23 03:41:38 +02:00
const li = u.ancestor(ev.target, 'li');
if (li) {
ev.preventDefault();
this.select(li, ev.target);
}
}
onKeyDown (ev) {
2018-10-23 03:41:38 +02:00
if (this.opened) {
if (_.includes([_converse.keycodes.ENTER, _converse.keycodes.TAB], ev.keyCode) && this.selected) {
ev.preventDefault();
ev.stopPropagation();
this.select();
return true;
} else if (ev.keyCode === _converse.keycodes.ESCAPE) {
this.close({'reason': 'esc'});
return true;
} else if (_.includes([_converse.keycodes.UP_ARROW, _converse.keycodes.DOWN_ARROW], ev.keyCode)) {
ev.preventDefault();
2018-10-23 03:41:38 +02:00
ev.stopPropagation();
this[ev.keyCode === _converse.keycodes.UP_ARROW ? "previous" : "next"]();
return true;
}
}
2018-10-23 03:41:38 +02:00
if (_.includes([
_converse.keycodes.SHIFT,
_converse.keycodes.META,
_converse.keycodes.META_RIGHT,
_converse.keycodes.ESCAPE,
_converse.keycodes.ALT]
, ev.keyCode)) {
return;
}
if (this.ac_triggers.includes(ev.key)) {
if (ev.key === "Tab") {
ev.preventDefault();
}
2018-10-23 03:41:38 +02:00
this.auto_completing = true;
} else if (ev.key === "Backspace") {
const word = u.getCurrentWord(ev.target, ev.target.selectionEnd-1);
if (this.ac_triggers.includes(word[0])) {
this.auto_completing = true;
}
2018-08-14 12:49:43 +02:00
}
2018-10-23 03:41:38 +02:00
}
2018-10-23 03:41:38 +02:00
evaluate (ev) {
const selecting = this.selected && ev && (
2018-10-23 03:41:38 +02:00
ev.keyCode === _converse.keycodes.UP_ARROW ||
ev.keyCode === _converse.keycodes.DOWN_ARROW
);
if (!this.auto_evaluate && !this.auto_completing || selecting) {
2018-10-23 03:41:38 +02:00
return;
}
2018-08-14 14:05:33 +02:00
2018-10-23 03:41:38 +02:00
const list = typeof this._list === "function" ? this._list() : this._list;
if (list.length === 0) {
return;
}
2018-10-23 03:41:38 +02:00
let value = this.match_current_word ? u.getCurrentWord(this.input) : this.input.value;
const contains_trigger = this.ac_triggers.includes(value[0]);
if (contains_trigger) {
this.auto_completing = true;
if (!this.include_triggers.includes(ev.key)) {
value = value.slice('1');
}
2018-10-23 03:41:38 +02:00
}
if ((contains_trigger || value.length) && value.length >= this.min_chars) {
2018-10-23 03:41:38 +02:00
this.index = -1;
// Populate list with options that match
this.ul.innerHTML = "";
2018-10-23 03:41:38 +02:00
this.suggestions = list
.map(item => new Suggestion(this.data(item, value)))
.filter(item => this.filter(item, value));
2018-10-23 03:41:38 +02:00
if (this.sort !== false) {
this.suggestions = this.suggestions.sort(this.sort);
}
this.suggestions = this.suggestions.slice(0, this.max_items);
this.suggestions.forEach(text => this.ul.appendChild(this.item(text, value)));
2018-10-23 03:41:38 +02:00
if (this.ul.children.length === 0) {
this.close({'reason': 'nomatches'});
2018-10-23 03:41:38 +02:00
} else {
this.open();
}
2018-10-23 03:41:38 +02:00
} else {
this.close({'reason': 'nomatches'});
if (!contains_trigger) {
this.auto_completing = false;
}
}
2018-08-14 12:49:43 +02:00
}
2018-10-23 03:41:38 +02:00
}
2018-10-23 03:41:38 +02:00
// Make it an event emitter
2019-04-29 09:07:15 +02:00
Object.assign(AutoComplete.prototype, Backbone.Events);
2018-10-23 03:41:38 +02:00
const helpers = {
2018-10-23 03:41:38 +02:00
getElement (expr, el) {
return typeof expr === "string"? (el || document).querySelector(expr) : expr || null;
},
2018-10-23 03:41:38 +02:00
bind (element, o) {
if (element) {
for (var event in o) {
if (!Object.prototype.hasOwnProperty.call(o, event)) {
continue;
}
2018-10-23 03:41:38 +02:00
const callback = o[event];
event.split(/\s+/).forEach(event => element.addEventListener(event, callback));
}
2018-10-23 03:41:38 +02:00
}
},
2018-10-23 03:41:38 +02:00
unbind (element, o) {
if (element) {
for (var event in o) {
if (!Object.prototype.hasOwnProperty.call(o, event)) {
continue;
}
2018-10-23 03:41:38 +02:00
const callback = o[event];
event.split(/\s+/).forEach(event => element.removeEventListener(event, callback));
}
2018-08-14 12:49:43 +02:00
}
2018-10-23 03:41:38 +02:00
},
2018-10-23 03:41:38 +02:00
regExpEscape (s) {
return s.replace(/[-\\^$*+?.()|[\]{}]/g, "\\$&");
}
}
2018-10-23 03:41:38 +02:00
_converse.AutoComplete = AutoComplete;
}
});