Unit displays architecture refactor proposal (February 2023)
Author: @Sayaka Ono
What are Unit displays?
Please see the introduction in https://lite-farm.atlassian.net/l/cp/rCoihsHd.
The frontend has a component named “Unit” which handles unit displays (/packages/webapp/src/components/Form/Unit/index.jsx).
User’s farm unit system preference
Users can set Unit system(metric/imperial) in the /farm page.
How does the Unit component look on the app?
simple usage | system generated(pre-populated) | system generated(pre-populated) Unit is fixed |
disabled | “hide label” inputs do not have a unit inside | automatic conversion |
Ways users will interact with value-unit-pairs with examples
When | When the value is(was) pre-populated by the system | When a value is NOT pre-populated by the system or was user created |
|---|---|---|
creating | the https://lite-farm.atlassian.net/wiki/spaces/LITEFARM/pages/658309153/Unit+displays#Default-display-guidance should determine the value / unit combination
In this case, if the total area is equal to or less than 10,890 sqft, it is displayed in ft2. | the user set unit preference should be used What is the “user set unit preference”? Is it a record-to-record unit(a record has not been created on a creation view) or user’s farm unit system preference (metric/imperial)? |
read-only | the https://lite-farm.atlassian.net/wiki/spaces/LITEFARM/pages/658309153/Unit+displays#Default-display-guidance should be used | the user set unit preference should be used |
editing | the https://lite-farm.atlassian.net/wiki/spaces/LITEFARM/pages/658309153/Unit+displays#Default-display-guidance should be used | the user set unit preference should be used |
automatic conversion - we will go with easier solution.
We do not need to see automatic conversion at all for now? (how about the total area?)
Instances of unit displays
(This is not 100 percent accurate)
| Path | Number of unique <Unit /> (59) & Views | Type | Operation | automatic conversion | Note |
|---|---|---|---|---|---|---|
1 |
file: | 4
| user input | create | NO | Currently, raw data(what the user has inputted) is stored in the DB.
|
2 |
file: | 3 | - | read | - |
|
3 |
file: | 3 |
| create | NO |
The location size does not need a unit? |
4 |
file: | 1 | user input | edit | NO |
|
5 |
file:
| 1 | - | read | - |
|
6 |
file: | 2 | user input | create | NO |
|
7 |
file: | 5 (4)
These should be combined | user input | create | NO |
|
8 |
condition:
file: | 1 | user input | create | NO |
|
9 |
condition:
file: | 1 | user input | create | NO |
|
10 |
condition:
file: | 1 | user input | create | NO |
|
11 |
the component is used for #2
file: | 5 | user input | create | NO | Estimated seed 20lb (not “stored as” unit) was saved in the DB |
12 |
file: | 2 | user input | create/edit? | NO | the first unit should be $/kg or $/mt? “Estimated annual revenue” does not change by changing units. |
13 |
file: | 2 | user input | create edit | - | the style for the quantity input is different from others
|
14 |
file: | 2 | pre-populated | create | NO |
|
15 |
file: | 2 | pre-populated | create read edit | NO |
|
16 |
file: | 1 | pre-populated | create | NO |
|
17 |
file: | 4 | pre-populated / user input | create read edit | NO |
|
18 |
file: | 1 | - | read | - | 0.87cm??? After adding sensors with “150cm” and “200cm”, they were shown as “1.5m” and “2cm”. |
19 |
file: | 1 | user input | create | NO |
|
20 |
file: | 2 | pre-populated | create | - |
|
21 |
file: | 6 volume depth | user input | create | YES |
|
22 |
file: | 1 | pre-populated (reading the data in DB) | edit | NO |
|
23 |
file: | 1 soil amendment | user input | create | NO |
|
24 |
file: | 1 | user input | create | NO |
|
25 |
file: |