/** * EGroupware eTemplate2 - SearchMixin * * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License * @package api * @link https://www.egroupware.org * @author Nathan Gray */ import {css, html, LitElement, render, SlotMixin} from "@lion/core"; import {cleanSelectOptions, SelectOption} from "./FindSelectOptions"; import {Validator} from "@lion/form-core"; import {Et2Tag} from "./Tag/Et2Tag"; // Otherwise import gets stripped let keep_import : Et2Tag; // Export the Interface for TypeScript type Constructor = new (...args : any[]) => T; export declare class SearchMixinInterface { /** * Enable searching on options */ search : boolean; /** * Get [additional] options from the server when you search, instead of just searching existing options */ searchUrl : string; /** * Allow adding new options that are not in the search results */ allowFreeEntries : boolean; /** * Additional search options passed to the search functions * * @type {object} */ searchOptions : object; /** * Start the search process */ startSearch() : void /** * Search local options */ localSearch(search : string, options : object) : Promise /** * Search remote options. * If searchUrl is not set, it will return very quickly with no results */ remoteSearch(search : string, options : object) : Promise /** * Check a [local] item to see if it matches */ searchMatch(search : string, options : object, item : LitElement) : boolean } /** * Base class for things that do search type behaviour * Separated to keep things a little simpler. * * Currently I assume we're extending an Et2Select, so changes may need to be made for better abstraction */ export const Et2WithSearchMixin = >(superclass : T) => { class Et2WidgetWithSearch extends SlotMixin(superclass) { static get properties() { return { ...super.properties, search: {type: Boolean, reflect: true}, searchUrl: {type: String}, /** * Allow custom entries that are not in the options */ allowFreeEntries: {type: Boolean, reflect: true}, /** * Additional search parameters that are passed to the server * when we query searchUrl */ searchOptions: {type: Object}, /** * Allow editing tags by clicking on them. * allowFreeEntries must be true */ editModeEnabled: {type: Boolean} } } static get styles() { return [ // @ts-ignore ...(super.styles ? (Symbol.iterator in Object(super.styles) ? super.styles : [super.styles]) : []), css` /* Move the widget border .form-control-input { border: solid var(--sl-input-border-width) var(--sl-input-border-color); border-radius: var(--sl-input-border-radius-medium); } .form-control-input:hover { background-color: var(--sl-input-background-color-hover); border-color: var(--sl-input-border-color-hover); color: var(--sl-input-color-hover); } .select--standard .select__control { border-style: none; } /* Move focus highlight */ .form-control-input:focus-within { box-shadow: var(--sl-focus-ring); } .select--standard.select--focused:not(.select--disabled) .select__control { box-shadow: initial; } /* Show / hide SlSelect icons - dropdown arrow, etc but not loading spinner */ :host([allowFreeEntries]) ::slotted(sl-icon[slot="suffix"]) { display: none; } /* Make search textbox take full width */ ::slotted(.search_input), ::slotted(.search_input) input, .search_input, .search_input input { width: 100%; } .search_input input { flex: 1 1 auto; width: 100%; } /* Full width search textbox covers loading spinner, lift it up */ ::slotted(sl-spinner) { z-index: 2; } /* Don't show the current value while searching for single, we want the space This lets the current value shrink to nothing so the input can expand */ .select__label { flex: 1 15 auto; } /* Show edit textbox only when editing */ .search_input #edit { display: none; } .search_input.editing #search { display: none; } .search_input.editing #edit { display: initial; } :host([search]:not([multiple])) .select--open .select__prefix { flex: 2 1 auto; width: 100%; } :host([search]:not([multiple])) .select--open .select__label { margin: 0px; } :host([allowfreeentries]:not([multiple])) .select--standard.select--open:not(.select--disabled) .select__control .select__prefix { flex: 1 1 auto; } :host([allowfreeentries]:not([multiple])) .select--standard.select--open:not(.select--disabled) .select__control .select__label { display: none; } /* Search textbox general styling, starts hidden */ .select__prefix ::slotted(.search_input),.search_input { display: none; flex: 1 1 auto; margin-left: 0px; width: 100%; height: var(--sl-input-height-medium); position: absolute; background-color: white; z-index: 1; } /* Search UI active - show textbox & stuff */ ::slotted(.search_input.active),.search_input.active, .search_input.editing{ display: flex; } /* If multiple and no value, overlap search onto widget instead of below */ :host([multiple]) .search_input.active.novalue { top: 0px; } /* Hide options that do not match current search text */ ::slotted(.no-match) { display: none; } /* Different cursor for editable tags */ :host([allowfreeentries]):not([readonly]) .search_tag::part(base) { cursor: text; } /** Readonly **/ /* No border */ :host([readonly]) .form-control-input { border: none; } /* disable focus border */ :host([readonly]) .form-control-input:focus-within { box-shadow: none; } /* no menu */ :host([readonly]) sl-menu { display: none; } /* normal cursor */ :host([readonly]) .select__control { cursor: initial; } ` ] } // Borrowed from Lion ValidatorMixin, but we don't want the whole thing protected defaultValidators : Validator[]; protected validators : Validator[]; private _searchTimeout : number; protected static SEARCH_TIMEOUT = 500; protected static MIN_CHARS = 2; // Hold the original option data from earlier search results, since we discard on subsequent search private _selected_remote = []; /** * These characters will end a free tag * @type {string[]} */ static TAG_BREAK : string[] = ["Tab", "Enter", ","]; constructor(...args : any[]) { super(...args); this.search = false; this.searchUrl = ""; this.searchOptions = {app: "addressbook"}; this.allowFreeEntries = false; this.editModeEnabled = false; // Hiding the selected options from the dropdown means we can't un-select the tags // hidden by the max limit. Prefer no limit. this.maxTagsVisible = -1; this.validators = []; /** * Used by Subclassers to add default Validators. * A email input for instance, always needs the isEmail validator. * @example * ```js * this.defaultValidators.push(new IsDate()); * ``` * @type {Validator[]} */ this.defaultValidators = []; this.handleMenuSelect = this.handleMenuSelect.bind(this); this._handleChange = this._handleChange.bind(this); this._handleSearchBlur = this._handleSearchBlur.bind(this); this._handleClear = this._handleClear.bind(this); this._handleDoubleClick = this._handleDoubleClick.bind(this); this._handleSearchAbort = this._handleSearchAbort.bind(this); this._handleSearchChange = this._handleSearchChange.bind(this); this._handleSearchKeyDown = this._handleSearchKeyDown.bind(this); this._handleEditKeyDown = this._handleEditKeyDown.bind(this); } connectedCallback() { super.connectedCallback(); this.classList.toggle("search", this.searchEnabled); // Missing any of the required attributes? Don't change anything. // If readonly, skip it if(!this.searchEnabled && !this.editModeEnabled && !this.allowFreeEntries || this.readonly) { return; } this._addNodes(); this._bindListeners(); } disconnectedCallback() { super.disconnectedCallback(); this._unbindListeners(); } willUpdate(changedProperties) { super.willUpdate(changedProperties); // Turn on search if there's more than 20 options if(changedProperties.has("select_options") && this.select_options.length > 20) { this.search = true; } // If searchURL is set, turn on search if(changedProperties.has("searchUrl") && this.searchUrl) { this.search = true; // Decode URL, possibly again. If set in template, it can wind up double-encoded. this.searchUrl = this.egw().decodePath(this.searchUrl); } } update(changedProperties) { super.update(changedProperties); // One of the key properties has changed, need to add the needed nodes if(changedProperties.has("search") || changedProperties.has("editModeEnabled") || changedProperties.has("allowFreeEntries")) { // Missing any of the required attributes? Now we need to take it out. if(!this.searchEnabled && !this.editModeEnabled && !this.allowFreeEntries || this.readonly) { this.querySelector(".search_input")?.remove(); return; } // Normally this should be handled in render(), but we have to add our nodes in this._addNodes(); } } /** * Add the nodes we need to search - adjust parent shadowDOM * * @protected */ protected _addNodes() { const div = document.createElement("div"); div.classList.add("search_input"); render(this._searchInputTemplate(), div); if(!super.multiple) { div.slot = "prefix"; this.appendChild(div); return; } super.updateComplete.then(() => { let control = this.shadowRoot.querySelector(".form-control-input"); control.append(div); }); } protected _searchInputTemplate() { let edit = null; if(this.editModeEnabled) { edit = html``; } // I can't figure out how to get this full width via CSS return html` ${edit} `; } protected _noResultsTemplate() { return html`
${this.egw().lang("no suggestions")}
`; } /** * Do we have the needed properties set, so we can actually do searching * * @returns {boolean} */ public get searchEnabled() : boolean { return !this.readonly && (this.search || this.searchUrl.length > 0); } protected get _searchInputNode() : HTMLInputElement { return this._activeControls?.querySelector("#search"); } protected get _editInputNode() : HTMLInputElement { return this._activeControls?.querySelector("input#edit"); } protected get _activeControls() { return this.shadowRoot?.querySelector(".search_input") || this.querySelector(".search_input"); } /** * Only local options, excludes server options * * @protected */ protected get localItems() : NodeList { return this.querySelectorAll(this.optionTag + ":not(.remote)"); } protected get remoteItems() : NodeList { return this.querySelectorAll(this.optionTag + ".remote"); } get value() { return super.value; } set value(new_value : string | string[]) { super.value = new_value; if(!new_value || !this.allowFreeEntries && !this.searchUrl) { return; } // Overridden to add options if allowFreeEntries=true if(this.allowFreeEntries && typeof this.value == "string" && !this._menuItems.find(o => o.value == this.value && !o.classList.contains('remote'))) { this.createFreeEntry(this.value); } else if(this.allowFreeEntries && this.multiple) { this.value.forEach((e) => { if(!this._menuItems.find(o => o.value == e)) { this.createFreeEntry(e); } }); } } protected fix_bad_value() { if(!this.allowFreeEntries && !this.searchEnabled) { // Let regular select deal with it return false; } const valueArray = Array.isArray(this.value) ? this.value : (!this.value ? [] : this.value.toString().split(',')); // Check any already found options if(Object.values(this.menuItems).filter((option) => valueArray.find(val => val == option.value)).length === 0) { return false; } return true; // TODO? Should we check the server, or just be OK with it? Passing the "current" value in sel_options makes sure the value is there } protected _bindListeners() { this.addEventListener("sl-clear", this._handleClear) // Need our own change to catch the change event from search input this.addEventListener("change", this._handleChange); this.updateComplete.then(() => { // Search messes up event order. Since it throws its own bubbling change event, // selecting an option fires 2 change events - 1 before the widget is finished adjusting, losing the value // We catch all change events, then call this._oldChange only when value changes this.removeEventListener("change", this._oldChange); this._searchInputNode.removeEventListener("change", this._searchInputNode.handleChange); this._searchInputNode.addEventListener("change", this._handleSearchChange); }); } protected _unbindListeners() { this.removeEventListener("sl-select", this._handleSelect); this.removeEventListener("sl-clear", this._handleClear) this.removeEventListener("change", this._handleChange); this._searchInputNode?.removeEventListener("change", this._handleSearchChange); } handleMenuShow() { if(this.readonly) { return; } // Move search (& menu) if there's no value this._activeControls?.classList.toggle("novalue", this.multiple && this.value == '' || !this.multiple); this.dropdown?.setAttribute("distance", !this._activeControls || this._activeControls?.classList.contains("novalue") ? "" : // Make room for search below parseInt(getComputedStyle(this._activeControls).getPropertyValue("--sl-input-height-medium")) ); super.handleMenuShow(); if(this.searchEnabled || this.allowFreeEntries) { this._activeControls?.classList.add("active"); this._searchInputNode.focus(); this._searchInputNode.select(); } if(this.editModeEnabled && this.allowFreeEntries && !this.multiple) { this.startEdit(); this._editInputNode.select(); // Hide search explicitly since its so hard via CSS this._searchInputNode.style.display = "none"; } } focus() { this.dropdown?.show().then(() => { this._searchInputNode.focus(); }); } handleMenuHide() { if(this.readonly) { return; } super.handleMenuHide(); if(this.searchEnabled || this.allowFreeEntries) { this._activeControls?.classList.remove("active"); this.shadowRoot.querySelector('.select__label').style.display = ""; } } _triggerChange(event) { // Don't want searchbox events to trigger change event if(event.target == this._searchInputNode) { event.stopImmediatePropagation(); event.preventDefault(); return false; } return true; } _handleChange(event) { if(event.target == this._searchInputNode) { event.stopImmediatePropagation(); event.preventDefault(); return false; } return this._oldChange(event); } _handleDoubleClick(event : MouseEvent) { // No edit (shouldn't happen...) if(!this.editModeEnabled) { return; } // Find the tag const path = event.composedPath(); const tag = path.find((el) => el instanceof Et2Tag); this.startEdit(tag); } /** * An option was selected */ handleMenuSelect(event) { // Need to keep the remote option - only if selected if(event.detail.item.classList.contains("remote") && !this._selected_remote.find(o => o.value == event.detail.item.value)) { this._selected_remote.push({...event.detail.item.option}); } super.handleMenuSelect(event); this.updateComplete.then(() => { // If they just chose one from the list, re-focus the search if(this.multiple && this.searchEnabled) { this._searchInputNode.focus(); this._searchInputNode.select(); // If we were overlapping, reset if(this._activeControls.classList.contains("novalue")) { this.handleMenuShow(); } // Scroll the new tag into view if(event.detail && event.detail.item) { this.updateComplete.then(() => { this.shadowRoot.querySelector("et2-tag[value='" + event.detail.item.value + "']")?.scrollIntoView(); }); } } else if(!this.multiple && this.searchEnabled) { // Stop all the search stuff when they select an option // this shows all non-matching options again this._handleSearchAbort(event); } }); } /** * Value was cleared */ _handleClear(e) { this._selected_remote = []; if(!this.multiple && this.searchEnabled) { this._handleSearchAbort(e); // Restore label styling this.shadowRoot.querySelector("[part='display-label']").style.display = ""; // Start searching again this.updateComplete.then(() => this.handleMenuShow()) } } /** * Handle blur from search field * * Either the user changed fields, or selected an option. For selecting don't interfere, but for * changing fields we need to make sure the menu is hidden. * * @param event */ async _handleSearchBlur(event : FocusEvent) { if(event.relatedTarget && this !== (event.relatedTarget).parentElement) { await this.dropdown.hide(); if(event.relatedTarget) { event.relatedTarget.focus(); } } } /** * Handle keypresses inside the search input * @param {KeyboardEvent} event * @protected */ protected _handleSearchKeyDown(event : KeyboardEvent) { clearTimeout(this._searchTimeout); this._activeControls?.classList.add("active"); this.dropdown.show(); // Pass off some keys to select if(['ArrowDown', 'ArrowUp', 'Home', 'End'].includes(event.key)) { return this.handleKeyDown(event); } // Don't allow event to bubble or it will interact with select event.stopImmediatePropagation(); if(Et2WidgetWithSearch.TAG_BREAK.indexOf(event.key) !== -1 && this.allowFreeEntries && this.createFreeEntry(this._searchInputNode.value)) { event.preventDefault(); this._searchInputNode.value = ""; if(!this.multiple) { this.dropdown.hide(); } else { this._searchInputNode.focus(); } } else if(event.key == "Enter") { event.preventDefault(); this.startSearch(); return; } else if(event.key == "Escape") { this._handleSearchAbort(event); return; } // Start the search automatically if they have enough letters if(this._searchInputNode.value.length >= Et2WidgetWithSearch.MIN_CHARS) { this._searchTimeout = window.setTimeout(() => {this.startSearch()}, Et2WidgetWithSearch.SEARCH_TIMEOUT); } } protected _handleEditKeyDown(event : KeyboardEvent) { // Stop propagation, or parent key handler will add again event.stopImmediatePropagation(); if(Et2WidgetWithSearch.TAG_BREAK.indexOf(event.key) !== -1 && this.allowFreeEntries) { // Prevent default, since that would try to submit event.preventDefault(); this.stopEdit(); } // Abort edit, put original value back else if(event.key == "Escape") { this.stopEdit(true); } } /** * Start searching * * If we have local options, we'll search & display any matches. * If serverUrl is set, we'll ask the server for results as well. */ public async startSearch() { // Stop timeout timer clearTimeout(this._searchTimeout); // Show a spinner let spinner = document.createElement("sl-spinner"); spinner.slot = "suffix"; this.appendChild(spinner); // Hide clear button let clear_button = this._searchInputNode.shadowRoot.querySelector(".input__clear") if(clear_button) { clear_button.style.display = "none"; } // Clear previous results this._clearResults(); await this.updateComplete; // Start the searches return Promise.all([ this.localSearch(this._searchInputNode.value, this.searchOptions), this.remoteSearch(this._searchInputNode.value, this.searchOptions) ]).then(() => { // Show no results indicator if(this.menuItems.filter(e => !e.classList.contains("no-match")).length == 0) { let target = this._optionTargetNode || this; let temp = document.createElement("div"); render(this._noResultsTemplate(), temp); target.append(temp.children[0]); } // Remove spinner spinner.remove(); // Restore clear button if(clear_button) { clear_button.style.display = ""; } }).then(() => { // Not sure why this stays hidden if there's no results but it sticks and hides all results afterward this.dropdown.shadowRoot.querySelector(".dropdown__panel").removeAttribute("hidden"); }); } /** * Clear search term and any search results * * Local options are not removed, but remote options are */ public clearSearch() { // Stop timeout timer clearTimeout(this._searchTimeout); this._clearResults(); // Clear search term if(this._searchInputNode) { this._searchInputNode.value = ""; } } protected _clearResults() { let target = this._optionTargetNode || this; // Remove "no suggestions" target.querySelector(".no-results")?.remove(); // Remove remote options that aren't used let keepers = this._selected_remote.reduce((prev, current) => { return ":not([value='" + current.value + "'])"; }, ""); target.querySelectorAll(".remote" + keepers).forEach(o => o.remove()); target.childNodes.forEach((n) => { if(n.nodeType == Node.COMMENT_NODE) { n.remove(); } }) // Reset remaining options. It might be faster to re-create instead. this._menuItems.forEach((item) => { item.disabled = false; item.classList.remove("match"); item.classList.remove("no-match"); }); } /** * Filter the local options * * @param {string} search * @protected */ protected localSearch(search : string, options : object) : Promise { return new Promise((resolve) => { this.localItems.forEach((item) => { let match = this.searchMatch(search, item); item.classList.toggle("match", match); // set disabled so arrow keys step over. Might be a better way to handle that item.disabled = !match; item.classList.toggle("no-match", !match); }) resolve(); }); } /** * Ask for remote options and add them in unconditionally * @param {string} search * @protected */ protected remoteSearch(search : string, options : object) { if(!this.searchUrl) { return Promise.resolve(); } // Fire off the query let promise = this.remoteQuery(search, options); return promise; } /** * Actually query the server. * * This can be overridden to change request parameters or eg. send them as POST parameters. * * Default implementation here sends search string and options: * - as two parameters to the AJAX function * - and (additional) as GET parameters plus search string as "query" * * This is done to support as well the old taglist callbacks, as the regular select ones! * * @param {string} search * @param {object} options * @returns {any} * @protected */ protected remoteQuery(search : string, options : object) { return this.egw().request(this.egw().link(this.egw().ajaxUrl(this.egw().decodePath(this.searchUrl)), {query: search, ...options}), [search, options]).then((result) => { this.processRemoteResults(result); }); } /** * Add in remote results * @param results * @protected */ protected processRemoteResults(results) { let entries = cleanSelectOptions(results); if(entries.length == 0) { return Promise.resolve(); } // Add a "remote" class so we can tell these apart from any local results entries.forEach((entry) => entry.class = (entry.class || "") + " remote"); let target = this._optionTargetNode || this; if(target) { // Keep local options first, add in remote options // Include already selected remote entries, or they will be removed and we lose icon/class this.select_options.concat(this._selected_remote).filter(function(item) { let i = entries.findIndex(x => (x.value == item.value)); if(i <= -1) { entries.push(item); } return null; }); let options = html`${entries.map(this._optionTemplate.bind(this))}`; /** * Doing all this garbage to get the options to always show up. * If we just do `render(options, target)`, they only show up in the DOM the first time. If the * same option comes back in a subsequent search, it map() does not put it into the DOM. * If we render into a new target, the options get rendered, but we have to wait for them to be * rendered before we can do anything else with them. */ let temp_target = document.createElement("div"); render(options, temp_target); return Promise.all(([...temp_target.querySelectorAll(":scope > *")].map(item => item.render))) .then(() => { temp_target.querySelectorAll(":scope > *").forEach((item) => { // Avoid duplicate error if(!target.querySelector("[value='" + item.value + "']")) { target.appendChild(item); } }) this.handleMenuSlotChange(); }); } } /** * Check if one of our [local] items matches the search * * @param search * @param item * @returns {boolean} * @protected */ protected searchMatch(search, item) : boolean { if(!item || !item.value) { return false; } if(item.textContent?.toLowerCase().includes(search.toLowerCase())) { return true; } if(typeof item.value == "string") { return item.value.includes(search.toLowerCase()); } return item.value == search; } /** * Create an entry that is not in the options and add it to the value * * @param {string} text Used as both value and label */ public createFreeEntry(text : string) : boolean { if(!this.validateFreeEntry(text)) { return false; } // Make sure not to double-add if(!this.select_options.find(o => o.value == text) && !this.__select_options.find(o => o.value == text)) { this.__select_options.push({ value: text, label: text }); this.requestUpdate('select_options'); } // Make sure not to double-add if(this.multiple && this.value.indexOf(text) == -1) { this.value.push(text); } else if(!this.multiple && this.value !== text) { this.value = text; } // If we were overlapping edit inputbox with the value display, reset if(!this.readonly && this._activeControls?.classList.contains("novalue")) { this.handleMenuShow(); } return true; } /** * Check if a free entry value is acceptable. * We use validators directly using the proposed value * * @param text * @returns {boolean} */ public validateFreeEntry(text) : boolean { let validators = [...this.validators, ...this.defaultValidators]; let result = validators.filter(v => v.execute(text, v.param, {node: this}), ); return validators.length > 0 && result.length == 0 || validators.length == 0; } /** * Start editing an existing (free) tag, or the current value if multiple=false * * @param {Et2Tag} tag */ public startEdit(tag? : Et2Tag) { const tag_value = tag ? tag.value : this.value; // hide the menu //this.dropdown.hide() // Turn on edit UI this._activeControls.classList.add("editing", "active"); // Pre-set value to tag value this._editInputNode.value = tag_value this._editInputNode.focus(); // Remove from value & DOM. If they finish the edit, the new one will be added. if(this.multiple) { this.value = this.value.filter(v => v !== tag_value); this.querySelector("[value='" + tag_value + "']").remove(); } this.select_options = this.select_options.filter(v => v.value !== tag_value); this.querySelector("[value='" + tag_value + "']")?.remove(); if(tag) { tag.remove(); } // If they abort the edit, they'll want the original back. this._editInputNode.dataset.initial = tag_value; } protected stopEdit(abort = false) { // type to select will focus matching entries, but we don't want to stop the edit yet if(typeof abort == "object" && abort.type == "blur") { if(abort.relatedTarget?.localName == "sl-menu-item") { return; } // Edit lost focus, accept changes abort = false; } let value = abort ? this._editInputNode.dataset.initial : this._editInputNode.value; this.createFreeEntry(value); delete this._editInputNode.dataset.initial; this._activeControls.classList.remove("editing", "active"); if(!this.multiple) { this.dropdown.hide(); } } protected _handleSearchAbort(e) { this._activeControls.classList.remove("active"); this.clearSearch(); this.syncItemsFromValue(); } /** * et2-searchbox (SlInput) sends out an event on change. * We don't care, and if we let it bubble it'll get in the way. * @param e * @protected */ protected _handleSearchChange(e) { e.stopImmediatePropagation(); e.preventDefault(); return false; } } return Et2WidgetWithSearch as unknown as Constructor & T; }