Fix selectbox values were not set.

Paying more attention to the WebComponent life cycle here, rather than what our widgets do - connectedCallback(), requestUpdate(), updated() are more important than loadFromXML(), etc. which are only used when loading from the .xet the first time.
This commit is contained in:
nathan 2022-02-18 12:02:27 -07:00
parent ebfdc1f718
commit 9079f97d7e
3 changed files with 90 additions and 92 deletions

View File

@ -460,6 +460,7 @@ export class Et2DateDuration extends Et2InputWidget(LitElement)
{ {
input.min = 0; input.min = 0;
input.name = this.display_format[this.display_format.length - i]; input.name = this.display_format[this.display_format.length - i];
// @ts-ignore - it doesn't like that it may have been an array
input.value = <string>(value[this.display_format.length - i]); input.value = <string>(value[this.display_format.length - i]);
switch(this.display_format[this.display_format.length - i]) switch(this.display_format[this.display_format.length - i])
{ {
@ -510,6 +511,7 @@ export class Et2DateDuration extends Et2InputWidget(LitElement)
m: this.short_labels ? this.egw().lang("m") : this.egw().lang("Minutes"), m: this.short_labels ? this.egw().lang("m") : this.egw().lang("Minutes"),
s: this.short_labels ? this.egw().lang("s") : this.egw().lang("Seconds") s: this.short_labels ? this.egw().lang("s") : this.egw().lang("Seconds")
}; };
// It would be nice to use an et2-select here, but something goes weird with the styling
return html` return html`
<select> <select>
${[...this.display_format].map((format : string) => ${[...this.display_format].map((format : string) =>

View File

@ -11,7 +11,7 @@
import {LionSelect} from "@lion/select"; import {LionSelect} from "@lion/select";
import {Et2InputWidget} from "../Et2InputWidget/Et2InputWidget"; import {Et2InputWidget} from "../Et2InputWidget/Et2InputWidget";
import {et2_readAttrWithDefault} from "../et2_core_xml"; import {et2_readAttrWithDefault} from "../et2_core_xml";
import {css, html, render, repeat, TemplateResult} from "@lion/core"; import {css, html, PropertyValues, render, repeat, TemplateResult} from "@lion/core";
import {cssImage} from "../Et2Widget/Et2Widget"; import {cssImage} from "../Et2Widget/Et2Widget";
import {StaticOptions} from "./StaticOptions"; import {StaticOptions} from "./StaticOptions";
@ -37,8 +37,6 @@ export interface SelectOption
*/ */
export class Et2WidgetWithSelect extends Et2InputWidget(LionSelect) export class Et2WidgetWithSelect extends Et2InputWidget(LionSelect)
{ {
protected _options : SelectOption[] = [];
static get properties() static get properties()
{ {
return { return {
@ -61,41 +59,33 @@ export class Et2WidgetWithSelect extends Et2InputWidget(LionSelect)
constructor() constructor()
{ {
super(); super();
this.select_options = <StaticOptions[]>[];
} }
/** /** @param {import('@lion/core').PropertyValues } changedProperties */
* Set the ID of the widget updated(changedProperties : PropertyValues)
*
* Overridden from parent to update select options
*
* @param {string} value
*/
set id(value)
{ {
let oldValue = this.id; super.updated(changedProperties);
super.id = value;
if(value !== oldValue) // If the ID changed (or was just set) find the select options
if(changedProperties.has("id"))
{ {
this.set_select_options(find_select_options(this)); this.set_select_options(find_select_options(this));
} }
} }
/**
* Get the ID of the widget
* Overridden from parent because we overrode setter
*
* @returns {string}
*/
get id()
{
return this._widget_id;
}
getValue() getValue()
{ {
return this.readOnly ? null : this.value; return this.readOnly ? null : this.modalValue;
} }
set_value(val)
{
let oldValue = this.modalValue;
this.modalValue = val
this.requestUpdate("value", oldValue);
}
/** /**
* Set the select options * Set the select options
@ -111,19 +101,24 @@ export class Et2WidgetWithSelect extends Et2InputWidget(LionSelect)
{ {
fixed_options.push({value: key, label: new_options[key]}); fixed_options.push({value: key, label: new_options[key]});
} }
this._options = fixed_options; this.select_options = fixed_options;
} }
else else
{ {
this._options = new_options; this.select_options = new_options;
} }
} }
get_select_options() get_select_options()
{ {
return this._options; return this.select_options;
} }
/**
* Render the "empty label", used when the selectbox does not currently have a value
*
* @returns {}
*/
_emptyLabelTemplate() : TemplateResult _emptyLabelTemplate() : TemplateResult
{ {
return html`${this.empty_label}`; return html`${this.empty_label}`;
@ -134,11 +129,16 @@ export class Et2WidgetWithSelect extends Et2InputWidget(LionSelect)
return html``; return html``;
} }
/**
* Load extra stuff from the template node. In particular, we're looking for any <option/> tags added.
*
* @param {Element} _node
*/
loadFromXML(_node : Element) loadFromXML(_node : Element)
{ {
// Read the option-tags // Read the option-tags
let options = _node.querySelectorAll("option"); let options = _node.querySelectorAll("option");
let new_options = this._options; let new_options = [];
for(let i = 0; i < options.length; i++) for(let i = 0; i < options.length; i++)
{ {
new_options.push({ new_options.push({
@ -152,34 +152,12 @@ export class Et2WidgetWithSelect extends Et2InputWidget(LionSelect)
}); });
} }
if(this.id)
{
new_options = find_select_options(this, {}, new_options);
}
this.set_select_options(new_options); this.set_select_options(new_options);
} }
transformAttributes(_attrs)
{
super.transformAttributes(_attrs);
// If select_options are already known, skip the rest
if(this._options && this._options.length > 0 ||
_attrs.select_options && Object.keys(_attrs.select_options).length > 0 ||
// Allow children to skip select_options - check to make sure default got set to something (should be {})
typeof _attrs.select_options == 'undefined' || _attrs.select_options === null
)
{
// do not return inside nextmatch, as get_rows data might have changed select_options
// for performance reasons we only do it for first row, which should have id "0[...]"
if(this.getParent() && this.getParent().getType() != 'rowWidget' || !_attrs.id || _attrs.id[0] != '0')
{
return;
}
}
let sel_options = find_select_options(this, _attrs['select_options'], _attrs);
if(sel_options.length > 0)
{
this.set_select_options(sel_options);
}
}
} }
export class Et2Select extends Et2WidgetWithSelect export class Et2Select extends Et2WidgetWithSelect
@ -233,31 +211,31 @@ export class Et2Select extends Et2WidgetWithSelect
connectedCallback() connectedCallback()
{ {
super.connectedCallback(); super.connectedCallback();
//MOVE options that were set as children inside SELECT:
// Add in actual options as children to select, if not already there
//MOVE options inside SELECT:
this.querySelector('select').append(...this.querySelectorAll('option')); this.querySelector('select').append(...this.querySelectorAll('option'));
if(this._inputNode.children.length == 0)
{
render(html`${this._emptyLabelTemplate()}
${repeat(this.get_select_options(), (option : SelectOption) => option.value, this._optionTemplate)}`,
this._inputNode
);
}
} }
set_select_options(new_options : SelectOption[] | { [p : string] : string }) /** @param {import('@lion/core').PropertyValues } changedProperties */
updated(changedProperties : PropertyValues)
{ {
super.set_select_options(new_options); super.updated(changedProperties);
if(changedProperties.has('select_options'))
// Add in actual options as children to select
if(this._inputNode)
{ {
render(html`${this._emptyLabelTemplate()} // Add in actual options as children to select
${repeat(this.get_select_options(), (option : SelectOption) => option.value, this._optionTemplate)}`, if(this._inputNode)
this._inputNode {
); // We use this.get_select_options() instead of this.select_options so children can override
// This is how sub-types get their options in
render(html`${this._emptyLabelTemplate()}
${repeat(this.get_select_options(), (option : SelectOption) => option.value, this._optionTemplate.bind(this))}`,
this._inputNode
);
}
}
if(changedProperties.has('select_options') || changedProperties.has("value"))
{
// Re-set value, the option for it may have just shown up
this._inputNode.value = this.modalValue || "";
} }
} }
@ -268,13 +246,15 @@ export class Et2Select extends Et2WidgetWithSelect
return html``; return html``;
} }
return html` return html`
<option value="">${this.empty_label}</option>`; <option value="" ?selected=${!this.modalValue}>${this.empty_label}</option>`;
} }
_optionTemplate(option : SelectOption) : TemplateResult _optionTemplate(option : SelectOption) : TemplateResult
{ {
return html` return html`
<option value="${option.value}" title="${option.title}">${option.label}</option>`; <option value="${option.value}" title="${option.title}" ?selected=${option.value == this.modalValue}>
${option.label}
</option>`;
} }
} }
@ -286,16 +266,21 @@ const so = new StaticOptions();
/** /**
* Find the select options for a widget, out of the many places they could be. * Find the select options for a widget, out of the many places they could be.
*
* This will give valid, correct array of SelectOptions. It will check:
* - sel_options ArrayMgr, taking into account namespaces and checking the root
* - content ArrayMgr, looking for "options-<id>"
* - passed options, used by specific select types
*
* @param {Et2Widget} widget to check for. Should be some sort of select widget. * @param {Et2Widget} widget to check for. Should be some sort of select widget.
* @param {object} attr_options Select options in attributes array * @param {object} attr_options Select options in attributes array
* @param {object} attrs Widget attributes * @param {SelectOption[]} options Known options, passed in if you've already got some. Cached type options, for example.
* @return {SelectOption[]} Select options, or empty array * @return {SelectOption[]} Select options, or empty array
*/ */
export function find_select_options(widget, attr_options?, attrs = {}) : SelectOption[] export function find_select_options(widget, attr_options?, options : SelectOption[] = []) : SelectOption[]
{ {
let name_parts = widget.id.replace(/&#x5B;/g, '[').replace(/]|&#x5D;/g, '').split('['); let name_parts = widget.id.replace(/&#x5B;/g, '[').replace(/]|&#x5D;/g, '').split('[');
let type_options : SelectOption[] = [];
let content_options : SelectOption[] = []; let content_options : SelectOption[] = [];
// Try to find the options inside the "sel-options" // Try to find the options inside the "sel-options"
@ -420,8 +405,8 @@ export function find_select_options(widget, attr_options?, attrs = {}) : SelectO
content_options = []; content_options = [];
} }
// Include type options, preferring any content options // Include passed options, preferring any content options
if(type_options.length || Object.keys(type_options).length > 0) if(options.length || Object.keys(options).length > 0)
{ {
for(let i in content_options) for(let i in content_options)
{ {
@ -429,21 +414,21 @@ export function find_select_options(widget, attr_options?, attrs = {}) : SelectO
let added = false; let added = false;
// Override any existing // Override any existing
for(let j in type_options) for(let j in options)
{ {
if('' + type_options[j].value === '' + value) if('' + options[j].value === '' + value)
{ {
added = true; added = true;
type_options[j] = content_options[i]; options[j] = content_options[i];
break; break;
} }
} }
if(!added) if(!added)
{ {
type_options.splice(parseInt(i), 0, content_options[i]); options.splice(parseInt(i), 0, content_options[i]);
} }
} }
content_options = type_options; content_options = options;
} }
// Clean up // Clean up
@ -452,7 +437,18 @@ export function find_select_options(widget, attr_options?, attrs = {}) : SelectO
let fixed_options = []; let fixed_options = [];
for(let key in <object>content_options) for(let key in <object>content_options)
{ {
fixed_options.push({value: key, label: content_options[key]}); let option = {value: key, label: content_options[key]}
// This could be an option group - not sure we have any
if(typeof option.label !== "string")
{
// @ts-ignore Yes, option.label.label is not supposed to exist but that's what we're checking
if(typeof option.label.label !== "undefined")
{
// @ts-ignore Yes, option.label.label is not supposed to exist but that's what we're checking
option.label = option.label.label;
}
}
fixed_options.push(option);
} }
content_options = fixed_options; content_options = fixed_options;
} }
@ -488,7 +484,7 @@ export class Et2SelectBitwise extends Et2Select
expanded_value.push(right); expanded_value.push(right);
} }
} }
this._value = expanded_value; this.modalValue = expanded_value;
this.requestUpdate("value", oldValue); this.requestUpdate("value", oldValue);
} }

View File

@ -69,10 +69,10 @@ describe("Select widget", () =>
{ {
/** SETUP **/ /** SETUP **/
// Create an element to test with, and wait until it's ready // Create an element to test with, and wait until it's ready
let node = '<et2-select id="select"></et2-select>';
container.setArrayMgr("sel_options", new et2_arrayMgr({ container.setArrayMgr("sel_options", new et2_arrayMgr({
select: options select: options
})); }));
let node = '<et2-select id="select"></et2-select>';
container.loadFromXML(parser.parseFromString(node, "text/xml")); container.loadFromXML(parser.parseFromString(node, "text/xml"));
// wait for asychronous changes to the DOM // wait for asychronous changes to the DOM
@ -106,7 +106,7 @@ describe("Select widget", () =>
let option_keys = Object.values(element.querySelector("select").children).map(o => o.value); let option_keys = Object.values(element.querySelector("select").children).map(o => o.value);
assert.include(option_keys, "option", "Static option missing"); assert.include(option_keys, "option", "Static option missing");
assert.includeMembers(option_keys, ["1", "2", "option"], "Option mis-match"); assert.includeMembers(option_keys, ["1", "2", "option"], "Option mis-match");
assert.equal(options.length, 3); assert.equal(option_keys.length, 3);
}); });
}); });