feat: Translate observation categories & details #458
Conversation
gmaclennan
force-pushed
the
feat/preset-translations
branch
from
e878c14
to
5829170
Compare
|
Does this also need to be ported to Desktop? We didn't talk about that extra work today, not sure if it's needed? |
It does, eventually. I do not think it is an immediate priority for @arky to also have this on Desktop. However it does also fix the display of select fields. As part of this PR I am abstracting the code to do this into re-usable components, which could be shared between Mobile and Desktop. |
gmaclennan
force-pushed
the
feat/preset-translations
branch
from
e3d55c0
to
25fffb4
Compare
Uses the translations.json file included in a mapeo config folder to translate preset names, field labels and placeholders, and select field options.
gmaclennan
force-pushed
the
feat/preset-translations
branch
from
25fffb4
to
dbc4be3
Compare
| @@ -0,0 +1,154 @@ | |||
| // @flow | |||
There was a problem hiding this comment.
This seems useful! Can we abstract this out as part of this PR, perhaps to @mapeo/react-components? It would be great to re-use this in Md (and get the formatted preset names, too) for the Report. Come to think of it, the Md Report and the Mm Share screen ought to probably share a lot of code... :)
There was a problem hiding this comment.
I started this here. digidem/mapeo-components#1
In the desktop app I copy/pasted the relevant two components (FormattedFieldProp & FormattedValue) to get the Report PDF branch ready to launch. It would be an extra piece of work (1-2 weeks) to refactor these components into a shared library.
| * meaningful translated values for null and boolean, but these types are not | ||
| * used widely in presets yet | ||
| */ | ||
| export function convertSelectOptionsToLabeled( |
There was a problem hiding this comment.
This also seems like it will be important to re-use this same rendering logic in other UIs, but it is not a react component. If the only argument is a SelectOptions object, I wonder how we can make it more tightly coupled, so it isn't in a 'utils' file?
There was a problem hiding this comment.
Yeah I have been wondering about that. This is used by:
- Select One data editing component
- Select Multiple data editing component
- Select one and multiple data view component
On desktop the editing component will likely be different (due to different UI patterns on Desktop) but will also need this function. As such I think it needs to be a helper function shared by these components. I think we can drop support for this in a later version of Mapeo Presets, or perhaps do this transform on the server. This is necessary because we originally supported options to be an array of strings, but later supported labels and values. Once we have a preset editor, these simplicity of just adding an array of strings is no longer so important.
| // Look up label from field options. This is not necessary for presets | ||
| // created with mapeo-settings-builder@^3.1.0, which will have these options | ||
| // in the translation file, but is needed for older versions of presets | ||
| const options = convertSelectOptionsToLabeled(field.options); |
There was a problem hiding this comment.
is there ever a time someone would use field.options in a Mapeo React component in the presentation/view layer without having it already be parsed by the 'convertSelectOptionsToLabeled' function? (not counting mapfilter hooks or custom functions that require the original field value)
There was a problem hiding this comment.
I don't think so, so perhaps we can transform options on the server or at the client api level, and treat Array<string> select options as a deprecated option that we change before the front-end receives it.
gmaclennan
changed the title
This PR adds functionality to Mapeo Mobile to display translated fields for presets. It depends on translations being built with
mapeo-settings-builderv3.1.0 or later (presets built with earlier versions should still work, they will just not be translated).mapeo-settings-builder@^3.1.0includes scripts to extract messages from preset and field definitions for translation, and also a build script to include translated messages into the config package.This PR should also fix the display of select fields, so that the label rather than the value is shown.
TODO:
This PR is built on #448
Download a QA version of Mapeo for this PR: https://app.bitrise.io/artifact/48898947/p/6fe9bad13146a7fda75afc887d5a191a
Closes #455