Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

Fix: integer and decimal widgets remain visible when form language changes #937

Merged
merged 4 commits into from
Dec 21, 2022
Merged

Fix: integer and decimal widgets remain visible when form language changes #937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8d3575e
Fix: integer and decimal widgets remain visible when form language ch…
eyelidlessness Dec 19, 2022
898ad11
Fix: use form language for number inputs (fall back to browser)
eyelidlessness Dec 20, 2022
b95e5ce
Test language decision logic
eyelidlessness Dec 21, 2022
dfa5d2b
Simplify formatting decimal inputs in supported browsers
eyelidlessness Dec 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/js/form.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ function Form(formEl, data, options) {

this.nonRepeats = {};
this.all = {};
this.options = typeof options !== 'object' ? {} : options;
this.options = options ?? {};

this.view = {
$: $form,
Expand Down
2 changes: 1 addition & 1 deletion src/sass/core/_main.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ $media-margin: 10px;

/** hide stuff **/

.or [lang]:not(.active),
.or [lang]:not(.active, .question),
.or-option-translations,
.or-appearance-page-break,
.or-constraint-msg,
Expand Down
4 changes: 3 additions & 1 deletion src/widget/number-input/decimal-input.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ export default class DecimalInput extends NumberInput {
}

get decimalCharacters() {
const decimal = this.formatter
const locales = Intl.getCanonicalLocales(this.languages);
const formatter = Intl.NumberFormat(locales);
const decimal = formatter
.formatToParts(0.1)
.find(({ type }) => type === 'decimal').value;

Expand Down
69 changes: 47 additions & 22 deletions src/widget/number-input/number-input.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { t } from '../../js/fake-translator';
import events from '../../js/event';
import inputModule from '../../js/input';
import Widget from '../../js/widget';

Expand Down Expand Up @@ -41,10 +42,27 @@ export default class NumberInput extends Widget {
].every((className) => !question.classList.contains(className));
}

get formatter() {
const locales = Intl.getCanonicalLocales(navigator.languages);
get languages() {
const formLanguage = this.languageSelect?.value;

return Intl.NumberFormat(locales);
let validFormLanguage;

try {
Intl.getCanonicalLocales(formLanguage);

validFormLanguage = formLanguage;
} catch {
// If this fails, the form's selected language is likely not a valid
// code and will cause all other `Intl` usage to fail.
}

return [validFormLanguage, ...navigator.languages].filter(
(language) => language != null
);
}

get language() {
return this.languages[0] ?? navigator.language;
}

/** @type {Set<string>} */
Expand Down Expand Up @@ -86,28 +104,40 @@ export default class NumberInput extends Widget {
constructor(input, options) {
super(input, options);

const formElement = input.closest('form.or');

/** @type {HTMLSelectElement | null} */
this.languageSelect =
formElement.parentElement?.querySelector('#form-languages');

let { characterPattern } = this;

const question = inputModule.getWrapNode(input);
const message = document.createElement('div');

message.classList.add('invalid-value-msg', 'active');
question.setAttribute('lang', navigator.language);
question.classList.add('active');

question.setAttribute('lang', this.language);
question.append(message);

this.question = question;
this.message = message;

this.format();
this.reformatValue();
this.setValidity();

window.addEventListener('languagechange', () => {
characterPattern = this.validCharacter;
question.setAttribute('lang', navigator.language);
this.format();
const languageChanged = () => {
characterPattern = this.characterPattern;
question.setAttribute('lang', this.language);
this.reformatValue();
this.setValidity();
});
};

formElement.addEventListener(
events.ChangeLanguage().type,
languageChanged
);
window.addEventListener('languagechange', languageChanged);

input.addEventListener('keydown', (event) => {
const { ctrlKey, isComposing, key, metaKey } = event;
Expand All @@ -130,20 +160,15 @@ export default class NumberInput extends Widget {
});
}

format() {
const { formatter, element, pattern } = this;
reformatValue() {
const { element, pattern } = this;
const { valueAsNumber } = element;

element.setAttribute('pattern', pattern.source);
element.pattern = pattern.source;
element.value = '';

if (valueAsNumber !== '') {
const formatted = formatter.format(valueAsNumber);

element.value = formatted;

if (element.value !== formatted) {
element.value = valueAsNumber;
}
if (!Number.isNaN(valueAsNumber)) {
element.value = valueAsNumber;
}
}

Expand Down
96 changes: 96 additions & 0 deletions test/forms/numbers-missing-after-language-switch.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
<?xml version="1.0"?>
<h:html xmlns="http://www.w3.org/2002/xforms"
xmlns:ev="http://www.w3.org/2001/xml-events"
xmlns:h="http://www.w3.org/1999/xhtml"
xmlns:jr="http://openrosa.org/javarosa"
xmlns:odk="http://www.opendatakit.org/xforms"
xmlns:orx="http://openrosa.org/xforms"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<h:head>
<h:title>numbers-missing-after-language-switch</h:title>
<model odk:xforms-version="1.0.0">
<itext>
<translation lang="language1">
<text id="/data/int_q:label">
<value>.</value>
</text>
<text id="/data/dec_q:label">
<value>.</value>
</text>
<text id="/data/txt_q:label">
<value>.</value>
</text>
</translation>
<translation lang="Finnish">
<text id="/data/int_q:label">
<value>kokonaislukusyöttö</value>
</text>
<text id="/data/dec_q:label">
<value>desimaalisyöttö</value>
</text>
<text id="/data/txt_q:label">
<value>tekstinsyöttö</value>
</text>
</translation>
<translation lang="French">
<text id="/data/int_q:label">
<value>entrée entière</value>
</text>
<text id="/data/dec_q:label">
<value>entrée décimale</value>
</text>
<text id="/data/txt_q:label">
<value>entrée texte</value>
</text>
</translation>
<translation lang="English">
<text id="/data/int_q:label">
<value>integer input</value>
</text>
<text id="/data/dec_q:label">
<value>decimal input</value>
</text>
<text id="/data/txt_q:label">
<value>text input</value>
</text>
</translation>
<translation lang=".">
<text id="/data/int_q:label">
<value>.</value>
</text>
<text id="/data/dec_q:label">
<value>.</value>
</text>
<text id="/data/txt_q:label">
<value>.</value>
</text>
</translation>
</itext>
<instance>
<data id="numbers-missing-after-language-switch">
<int_q/>
<dec_q/>
<txt_q/>
<meta>
<instanceID/>
</meta>
</data>
</instance>
<bind nodeset="/data/int_q" type="int"/>
<bind nodeset="/data/dec_q" type="decimal"/>
<bind nodeset="/data/txt_q" type="string"/>
<bind jr:preload="uid" nodeset="/data/meta/instanceID" readonly="true()" type="string"/>
</model>
</h:head>
<h:body>
<input ref="/data/int_q">
<label ref="jr:itext('/data/int_q:label')"/>
</input>
<input ref="/data/dec_q">
<label ref="jr:itext('/data/dec_q:label')"/>
</input>
<input ref="/data/txt_q">
<label ref="jr:itext('/data/txt_q:label')"/>
</input>
</h:body>
</h:html>
Loading