Robin-van-der-Linde/MapComplete
1
0
Fork 0
forked from MapComplete/MapComplete
Code Pull requests Activity

Better validated text fields with translations and human-friendly texts: first draft

Browse source
This commit is contained in:
pietervdvn 2022-02-11 04:28:11 +01:00
parent 695a0867c7
commit 9ab4fbd6f5
7 changed files with 581 additions and 528 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
AllTranslationAssets.ts
View file

@ -1,6 +0,0 @@
import CompiledTranslations from "./assets/generated/CompiledTranslations";
export default class AllTranslationAssets {
public static t = CompiledTranslations.t;
}

37
Models/ThemeConfig/TagRenderingConfig.ts
View file

@ -19,15 +19,15 @@ import List from "../../UI/Base/List";
*/
export default class TagRenderingConfig {
public readonly id: string;
public readonly group: string;
public readonly render?: Translation;
public readonly question?: Translation;
public readonly condition?: TagsFilter;
public readonly id: string;
public readonly group: string;
public readonly render?: Translation;
public readonly question?: Translation;
public readonly condition?: TagsFilter;
public readonly configuration_warnings: string[] = []
public readonly configuration_warnings: string[] = []
public readonly freeform?: {
public readonly freeform?: {
readonly key: string,
readonly type: string,
readonly placeholder: Translation,
@ -93,10 +93,22 @@ export default class TagRenderingConfig {
if (json.freeform.addExtraTags !== undefined && json.freeform.addExtraTags.map === undefined) {
throw `Freeform.addExtraTags should be a list of strings - not a single string (at ${context})`
}
const type = json.freeform.type ?? "string"
let placeholder = Translations.T(json.freeform.placeholder)
if (placeholder === undefined) {
const typeDescription = Translations.t.validation[type]?.description
placeholder = Translations.T(json.freeform.key+" ("+type+")")
if(typeDescription !== undefined){
console.log(typeDescription)
placeholder = placeholder.Fuse(typeDescription, type)
}
}
this.freeform = {
key: json.freeform.key,
type: json.freeform.type ?? "string",
placeholder: Translations.T(json.freeform.placeholder ?? (json.freeform.key + "(" + (json.freeform.type ?? "string") + ")")),
type,
placeholder,
addExtraTags: json.freeform.addExtraTags?.map((tg, i) =>
TagUtils.Tag(tg, `${context}.extratag[${i}]`)) ?? [],
inline: json.freeform.inline ?? false,
@ -169,7 +181,7 @@ export default class TagRenderingConfig {
hideInAnswer = TagUtils.Tag(mapping.hideInAnswer, `${context}.mapping[${i}].hideInAnswer`);
}
let icon = undefined;
if(mapping.icon !== ""){
if (mapping.icon !== "") {
icon = mapping.icon
}
const mp = {
@ -339,7 +351,7 @@ export default class TagRenderingConfig {
* @param tags
* @constructor
*/
public GetRenderValues(tags: any): {then: Translation, icon?: string}[] {
public GetRenderValues(tags: any): { then: Translation, icon?: string }[] {
if (!this.multiAnswer) {
return [this.GetRenderValueWithImage(tags)]
}
@ -348,7 +360,7 @@ export default class TagRenderingConfig {
// If it is undefined, it is "used" already, or at least we don't have to check for it anymore
let freeformKeyUsed = this.freeform?.key === undefined;
// We run over all the mappings first, to check if the mapping matches
const applicableMappings: {then: Translation, img?: string}[] = Utils.NoNull((this.mappings ?? [])?.map(mapping => {
const applicableMappings: { then: Translation, img?: string }[] = Utils.NoNull((this.mappings ?? [])?.map(mapping => {
if (mapping.if === undefined) {
return mapping;
}
@ -375,6 +387,7 @@ export default class TagRenderingConfig {
public GetRenderValue(tags: any, defltValue: any = undefined): Translation {
return this.GetRenderValueWithImage(tags, defltValue).then
}
/**
* Gets the correct rendering value (or undefined if not known)
* Not compatible with multiAnswer - use GetRenderValueS instead in that case

8
UI/Input/ValidatedTextField.ts
View file

@ -23,6 +23,7 @@ import Table from "../Base/Table";
import Combine from "../Base/Combine";
import Title from "../Base/Title";
import InputElementMap from "./InputElementMap";
import Translations from "../i18n/Translations";
interface TextFieldDef {
name: string,
@ -84,7 +85,7 @@ class WikidataTextField implements TextFieldDef {
]).AsMarkdown()
public isValid(str) {
public isValid(str) : boolean{
if (str === undefined) {
return false;
@ -490,6 +491,7 @@ export default class ValidatedTextField {
* {string (typename) --> TextFieldDef}
*/
public static AllTypes: Map<string, TextFieldDef> = ValidatedTextField.allTypesDict();
private static Tranlations: string | BaseUIElement;
public static InputForType(type: string, options?: {
placeholder?: string | BaseUIElement,
@ -508,7 +510,9 @@ export default class ValidatedTextField {
inputStyle?: string
}): InputElement<string> {
options = options ?? {};
options.placeholder = options.placeholder ?? type;
if(options.placeholder === undefined) {
options.placeholder = Translations.t.validation[type]?.description ?? type
}
const tp: TextFieldDef = ValidatedTextField.AllTypes.get(type)
const isValidTp = tp.isValid;
let isValid;

5
UI/i18n/Translations.ts
View file

@ -1,11 +1,12 @@
import {FixedUiElement} from "../Base/FixedUiElement";
import AllTranslationAssets from "../../AllTranslationAssets";
import {Translation} from "./Translation";
import BaseUIElement from "../BaseUIElement";
import * as known_languages from "../../assets/generated/used_languages.json"
import CompiledTranslations from "../../assets/generated/CompiledTranslations";
export default class Translations {
static t = AllTranslationAssets.t;
static t = CompiledTranslations.t;
private static knownLanguages = new Set(known_languages.languages)
constructor() {
throw "Translations is static. If you want to intitialize a new translation, use the singular form"

1021
langs/en.json
View file

File diff suppressed because it is too large Load diff

5
test/TestAll.ts
View file

@ -17,6 +17,8 @@ import ReplaceGeometrySpec from "./ReplaceGeometry.spec";
import LegacyThemeLoaderSpec from "./LegacyThemeLoader.spec";
import T from "./TestHelper";
import CreateNoteImportLayerSpec from "./CreateNoteImportLayer.spec";
import ValidatedTextFieldTranslations from "./ValidatedTextFieldTranslations.spec";
import ValidatedTextFieldTranslationsSpec from "./ValidatedTextFieldTranslations.spec";
async function main() {
@ -38,7 +40,8 @@ async function main() {
new ActorsSpec(),
new ReplaceGeometrySpec(),
new LegacyThemeLoaderSpec(),
new CreateNoteImportLayerSpec()
new CreateNoteImportLayerSpec(),
new ValidatedTextFieldTranslationsSpec()
]
Utils.externalDownloadFunction = async (url) => {

27
test/ValidatedTextFieldTranslations.spec.ts Normal file
View file

@ -0,0 +1,27 @@
import T from "./TestHelper";
import ValidatedTextField from "../UI/Input/ValidatedTextField";
import Translations from "../UI/i18n/Translations";
export default class ValidatedTextFieldTranslationsSpec extends T {
constructor() {
super([
["Test all", () => {
const ts = Translations.t.validation;
console.log("Hello world!")
const allErrors = Array.from(ValidatedTextField.AllTypes.keys()).map(key => {
const errors = []
const t = ts[key]
if (t === undefined) {
errors.push("No tranlations at all for " + key)
}
return errors;
})
const errs = [].concat(...allErrors)
if (errs.length > 0) {
errs.forEach(e => console.log(e))
// throw errs.join("\n")
}
}]
]);
}
}